Skip to content

Commit 1d26b1b

Browse files
authored
Adds new Zero IA (#1439)
* moves cluster status * changes to sidebar * fixes breaking links * removes releases, adds versioning partial to changelogs * moves k8s, adds redirects * removes production-deployment page * moves clients, adds redirects * creates upstream services guides directory * removes Client from sidebar labels * updates text * Revert "creates upstream services guides directory" This reverts commit f61e4bd. * creates guides subsections * removes securing tcp guide, adds to capabilities examples * removes js-sdk guide, redirects to capabilities page * removes local oidc, redirects to idp oidc guide * updates sidebar to move guide locations * removes idp and integrations sidebar slices * splits up certificates concepts page & creates new mTLS guide * adds integrations to capabilities section * adds zero install page * runs yarn format * fixes breaking links * fixes cspell errors * runs prettier
1 parent a3fdaea commit 1d26b1b

File tree

160 files changed

+715
-1315
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+715
-1315
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ repos:
66
additional_dependencies:
77
- 'prettier@2.7.1'
88
files: ^content\/.*$
9-
exclude: content/docs/deploy/k8s/reference.md
9+
exclude: content/docs/k8s/reference.md
1010
- repo: https://github.com/streetsidesoftware/cspell-cli
1111
rev: v6.2.0
1212
hooks:
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Versioning
2+
3+
Pomerium uses [Semantic Versioning](https://semver.org/). In practice, this means for a given version number **vMAJOR**.**MINOR**.**PATCH** (for example, `v0.1.0`):
4+
5+
- **MAJOR** indicates an incompatible API change
6+
- **MINOR** indicates a new, backwards-compatible functionality
7+
- **PATCH** indicates a backwards-compatible bug fix
8+
9+
As Pomerium is still pre-`v1.0.0`, you should expect breaking changes between releases.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
**Before you upgrade:** Set your Core and Enterprise instances to the same **MINOR** version number. For example, if your Core instance is on **v0.22.1**, Enterprise should be set to **v0.22.0**. See [Versioning](/docs/deploy/releases#versioning) for more information.
1+
**Before you upgrade:** Set your Core and Enterprise instances to the same **MINOR** version number. For example, if your Core instance is on **v0.22.1**, Enterprise should be set to **v0.22.0**.

content/docs/capabilities/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ By configuring your applications to route requests to Pomerium’s Proxy service
5656

5757
:::enterprise
5858

59-
[Enterprise customers](https://www.pomerium.com/enterprise-sales/) can enforce context-aware access with Pomerium’s [external data sources](/docs/integrations) feature (directory sync).
59+
[Enterprise customers](https://www.pomerium.com/enterprise-sales/) can enforce context-aware access with Pomerium’s [external data sources](/docs/capabilities/integrations) feature (directory sync).
6060

6161
:::
6262

content/docs/capabilities/authorization.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ In this example, Pomerium will grant a user access if their email address ends i
108108

109109
:::enterprise
110110

111-
The Enterprise Console provides a policy builder GUI so you can build policies and reapply them to multiple routes and namespaces. See our [**Enterprise**](/docs/deploy/enterprise) page to learn more.
111+
The Enterprise Console provides a policy builder GUI so you can build policies and reapply them to multiple routes and namespaces. See our [**Enterprise**](/docs/enterprise) page to learn more.
112112

113113
:::
114114

@@ -274,7 +274,7 @@ This example pulls session data from the Databroker service using `type.googleap
274274

275275
::::enterprise
276276

277-
In the [**Enterprise Console**](/docs/deploy/enterprise), you can write policies in Rego with the PPL builder:
277+
In the [**Enterprise Console**](/docs/enterprise), you can write policies in Rego with the PPL builder:
278278

279279
![Apply Rego in Console editor](./img/authorization/ppl-rego-policy.png)
280280

@@ -311,7 +311,7 @@ For routes with policies that allow public, unauthenticated access, Pomerium _wi
311311

312312
:::enterprise
313313

314-
[Device identity](/docs/capabilities/device-identity) is an Enterprise feature. Check out our [Enterprise](/docs/deploy/enterprise) page to learn more.
314+
[Device identity](/docs/capabilities/device-identity) is an Enterprise feature. Check out our [Enterprise](/docs/enterprise) page to learn more.
315315

316316
:::
317317

content/docs/capabilities/branding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Add custom colors, logos, and error messages.
77

88
:::enterprise
99

10-
This article describes a use case available to [Pomerium Enterprise](/docs/deploy/enterprise/install) customers.
10+
This article describes a use case available to [Pomerium Enterprise](/docs/enterprise/install) customers.
1111

1212
:::
1313

content/docs/capabilities/device-identity.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Device identity is the unique ID associated with a device. In the context of zer
3232

3333
## Device identity with Pomerium
3434

35-
Pomerium versions [0.16.0](/docs/deploy/core/upgrading#policy-for-device-identity) and up support the use of device identity as a criteria in authorization policies. Pomerium uses the [Web Authentication](https://www.w3.org/TR/webauthn-2/#registration-extension) (WebAuthn) API to bring authentication and authorization based on device identity into your security framework. With Pomerium’s device identity support, users can register devices and administrators can limit access to devices they trust.
35+
Pomerium versions [0.16.0](/docs/core/upgrading#policy-for-device-identity) and up support the use of device identity as a criteria in authorization policies. Pomerium uses the [Web Authentication](https://www.w3.org/TR/webauthn-2/#registration-extension) (WebAuthn) API to bring authentication and authorization based on device identity into your security framework. With Pomerium’s device identity support, users can register devices and administrators can limit access to devices they trust.
3636

3737
## Device identity features
3838

@@ -102,7 +102,7 @@ Give the link to the user.
102102

103103
If a Pomerium route [requires device authentication](/docs/capabilities/ppl#device-matcher), the user must register a [trusted execution environment](/docs/concepts/device-identity#authenticated-device-types) (**TEE**) device before accessing the route. Registration differs depending on the device.
104104

105-
The steps below cover enrollment of a device by a user. This is available for both Pomerium Core and [Pomerium Enterprise](/docs/deploy/enterprise/install) installations. However, Enterprise users may also receive registration links [generated by their administrators](/docs/capabilities/device-identity), which will mark the newly enrolled device as approved in the Enterprise Console.
105+
The steps below cover enrollment of a device by a user. This is available for both Pomerium Core and [Pomerium Enterprise](/docs/enterprise/install) installations. However, Enterprise users may also receive registration links [generated by their administrators](/docs/capabilities/device-identity), which will mark the newly enrolled device as approved in the Enterprise Console.
106106

107107
1. Users are prompted to register a new device when accessing a route that requires device authentication:
108108

content/docs/capabilities/enterprise-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The Pomerium Enterprise Console supports programmatic interaction through a gRPC
1717

1818
This doc assumes:
1919

20-
- You've installed [Pomerium Core](/docs/deploy/core) and [Pomerium Enterprise](/docs/deploy/enterprise/install)
20+
- You've installed [Pomerium Core](/docs/core) and [Pomerium Enterprise](/docs/enterprise/install)
2121
- The connection to the Enterprise Console service is encrypted
2222

2323
## Configure a new route

content/docs/capabilities/getting-users-identity.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,6 @@ A single-page javascript application can verify the JWT using the [JavaScript SD
118118

119119
<ReactApp />
120120

121-
See the [JavaScript SDK guide](/docs/guides/js-sdk) for more information.
122-
123121
### Manual verification
124122

125123
Though you will likely verify signed headers programmatically in your application's middleware with a third-party JWT library, if you are new to JWT it may be helpful to show what manual verification looks like.

content/docs/capabilities/high-availability.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Pomerium's individual components can be divided into two categories; the data pl
4040

4141
:::tip
4242

43-
Our [Kubernetes](/docs/deploy/k8s/quickstart) supports [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
43+
Our [Kubernetes](/docs/k8s/quickstart) supports [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
4444

4545
:::
4646

@@ -92,7 +92,7 @@ In any production deployment, running multiple replicas of each Pomerium service
9292

9393
You should deploy Layer 4 load balancing between end users and Pomerium Proxy services to provide high availability and horizontal scaling. Do not use L7 load balancers, since the Proxy service handles redirects, sticky sessions, etc.
9494

95-
Note that deployments on Kubernetes can utilize The [Pomerium Ingress Controller](/docs/deploy/k8s/ingress) to simplify configuration.
95+
Note that deployments on Kubernetes can utilize The [Pomerium Ingress Controller](/docs/k8s/ingress) to simplify configuration.
9696

9797
### Authenticate
9898

0 commit comments

Comments
 (0)