Docs: cross-reference links between concepts and reference (#2648)

* cross-reference links between concepts and reference

* Empty commit for CLA hangup
This commit is contained in:
Alex Fornuto 2021-09-30 13:04:15 -05:00 committed by GitHub
parent 18174d8552
commit e0a930d766
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 6 deletions

View file

@ -21,6 +21,8 @@ Namespaces enable:
Each of these sub-concepts are related and build on each other to form a unified security model. Each of these sub-concepts are related and build on each other to form a unified security model.
See [Reference: Namespace] for more information.
### Self-Service Capabilities ### Self-Service Capabilities
One of the benefits of an identity-aware access proxy is that, once in place, developers and owners of enterprise applications have an incentive to configure their services to be accessible via the proxy. One of the benefits of an identity-aware access proxy is that, once in place, developers and owners of enterprise applications have an incentive to configure their services to be accessible via the proxy.
@ -102,6 +104,8 @@ A service account identity can either be based on a user entry in your IdP Direc
Routes define the connection pathway and configuration from the internet to your internal service. As a very basic level, a route sends traffic from `external-address.company.com` to `internalService-address.localdomain`, restricted by the policies associated with it, and encrypted by your TLS certificates. But more advanced configurations allow identity header pass-through, path and prefix rewrites, request and response header modification, load balancer services, and other full featured ingress capabilities. Routes define the connection pathway and configuration from the internet to your internal service. As a very basic level, a route sends traffic from `external-address.company.com` to `internalService-address.localdomain`, restricted by the policies associated with it, and encrypted by your TLS certificates. But more advanced configurations allow identity header pass-through, path and prefix rewrites, request and response header modification, load balancer services, and other full featured ingress capabilities.
For more information, see [Reference: Routes]
### Protected Endpoints ### Protected Endpoints
This term refers to the system or service the route provides or restricts access to. This term refers to the system or service the route provides or restricts access to.
@ -146,3 +150,5 @@ With Pomerium:
- Pomerium provides detailed audit logs for all activity in your environment. Quickly detect anomalies to mitigate bad actors and revoke access with a click of a button. Simplify life-cycle management and access reviews. - Pomerium provides detailed audit logs for all activity in your environment. Quickly detect anomalies to mitigate bad actors and revoke access with a click of a button. Simplify life-cycle management and access reviews.
[Reference: Policies]: /enterprise/reference/manage.md#policies-2 [Reference: Policies]: /enterprise/reference/manage.md#policies-2
[Reference: Namespace]: /enterprise/reference/configure.md#namespaces
[Reference: Routes]: /enterprise/reference/manage.md#routes

View file

@ -36,7 +36,7 @@ settings:
settings: settings:
- name: "Routes" - name: "Routes"
doc: | doc: |
A Route defines how to access a service running behind Pomerium. This includes authentication (both for Pomerium and passed through to the service), rewrites, header management, load balancing, etc. A [Route](/enterprise/concepts.md#routes) defines how to access a service running behind Pomerium. This includes authentication (both for Pomerium and passed through to the service), rewrites, header management, load balancing, etc.
settings: settings:
- name: "General" - name: "General"
doc: | doc: |
@ -90,7 +90,7 @@ settings:
- name: "Policies" - name: "Policies"
keys: ["Policy"] keys: ["Policy"]
doc: | doc: |
A Policy defines what permissions a set of users or groups has. Policies are applied to Namespaces or Routes to associate the set of permissions with a service or set of service, completing the authentication model. A [Policy](/enterprise/concepts.md#policies) defines what permissions a set of users or groups has. Policies are applied to Namespaces or Routes to associate the set of permissions with a service or set of service, completing the authentication model.
Policies can be constructed three ways: Policies can be constructed three ways:
@ -226,7 +226,7 @@ settings:
keys: ["set_response_headers"] keys: ["set_response_headers"]
- name: "Service Accounts" - name: "Service Accounts"
doc: | doc: |
Service accounts offer a protected and standardized method of authenticating machine-to-machine communication between services protected by Pomerium. [Service accounts](/enterprise/concepts.md#service-accounts) offer a protected and standardized method of authenticating machine-to-machine communication between services protected by Pomerium.
::: tip ::: tip
Before you begin, confirm you are in the correct Namespace. A service account can only be used in the Namespace it was created in, including its children Namespaces. Before you begin, confirm you are in the correct Namespace. A service account can only be used in the Namespace it was created in, including its children Namespaces.

View file

@ -245,7 +245,7 @@ Set Response Headers allows you to set static values for the given response head
## Service Accounts ## Service Accounts
Service accounts offer a protected and standardized method of authenticating machine-to-machine communication between services protected by Pomerium. [Service accounts](/enterprise/concepts.md#service-accounts) offer a protected and standardized method of authenticating machine-to-machine communication between services protected by Pomerium.
::: tip ::: tip
Before you begin, confirm you are in the correct Namespace. A service account can only be used in the Namespace it was created in, including its children Namespaces. Before you begin, confirm you are in the correct Namespace. A service account can only be used in the Namespace it was created in, including its children Namespaces.

View file

@ -11,7 +11,7 @@ meta:
## Routes ## Routes
A Route defines how to access a service running behind Pomerium. This includes authentication (both for Pomerium and passed through to the service), rewrites, header management, load balancing, etc. A [Route](/enterprise/concepts.md#routes) defines how to access a service running behind Pomerium. This includes authentication (both for Pomerium and passed through to the service), rewrites, header management, load balancing, etc.
### General ### General
@ -281,7 +281,7 @@ Some policy types support additional [configuration](/reference/readme.md#load-b
## Policies ## Policies
A Policy defines what permissions a set of users or groups has. Policies are applied to Namespaces or Routes to associate the set of permissions with a service or set of service, completing the authentication model. A [Policy](/enterprise/concepts.md#policies) defines what permissions a set of users or groups has. Policies are applied to Namespaces or Routes to associate the set of permissions with a service or set of service, completing the authentication model.
Policies can be constructed three ways: Policies can be constructed three ways: