Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 8b8d856

Browse files
committedDec 31, 2024·
Refactor documentation and update client references for clarity
- Updated multiple documentation files to replace references to the old Pomerium CLI and Desktop client links with the new consolidated guide at /docs/deploy/clients. - Revised links in various sections to ensure accurate navigation for TCP and UDP connections, enhancing user guidance on non-HTTP protocols. - Removed outdated client documentation files and images, streamlining the resource structure for better accessibility. - Improved overall clarity and consistency in documentation formatting and terminology. These changes enhance the usability and coherence of the documentation, providing users with a more organized resource for managing Pomerium's capabilities.
1 parent 3773db9 commit 8b8d856

36 files changed

+469
-418
lines changed
 

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ repos:
44
hooks:
55
- id: prettier
66
additional_dependencies:
7-
- "prettier@3.4.2"
7+
- 'prettier@3.4.2'
88
files: ^content\/.*$
99
exclude: content/docs/deploy/k8s/reference.md
1010
- repo: https://github.com/streetsidesoftware/cspell-cli

‎content/docs/capabilities/kubernetes-access.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ rules:
8383
8484
2. A [route's policy](/docs/reference/routes/policy) is created for the API server and [configured](/docs/reference/routes/kubernetes-service-account-token) to use the service account token
8585
3. Kubernetes RoleBindings operate against IdP Users and Group subjects
86-
4. Users access the protected cluster through their standard tools, using [pomerium-cli](/docs/capabilities/non-http/client) as an auth provider in `~/.kube/config`
86+
4. Users access the protected cluster through their standard tools, using [pomerium-cli](/docs/deploy/clients) as an auth provider in `~/.kube/config`
8787
5. Pomerium authorizes requests and passes the user identity to the API server for fine grained RBAC
8888

8989
</TabItem>
@@ -215,7 +215,7 @@ Then, your user should be authorized:
215215

216216
## Kubeconfig Setup
217217

218-
Edit your kubeconfig to use [pomerium-cli](/docs/capabilities/non-http/client) as a [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins):
218+
Edit your kubeconfig to use [pomerium-cli](/docs/deploy/clients) as a [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins):
219219

220220
```yaml
221221
apiVersion: v1

‎content/docs/capabilities/non-http/client.mdx

-212
This file was deleted.

‎content/docs/capabilities/non-http/examples/_service-template.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2121

2222
## Basic Connection
2323

24-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
24+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
2525

2626
<Tabs>
2727
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/examples/git.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2323

2424
## Basic Connection
2525

26-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client. These examples use Git connections over SSH:
26+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client. These examples use Git connections over SSH:
2727

2828
<Tabs>
2929
<TabItem value="pomerium-cli" label="pomerium-cli">
Loading

‎content/docs/capabilities/non-http/examples/ms-sql.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2626

2727
## Basic Connection
2828

29-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
29+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
3030

3131
<Tabs>
3232
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/examples/mysql.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2323

2424
## Basic Connection
2525

26-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
26+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
2727

2828
<Tabs>
2929
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/examples/postgres.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ PostgreSQL is a popular relational database used in many modern applications. Th
1111

1212
## Basic Connection
1313

14-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
14+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
1515

1616
<Tabs>
1717
<TabItem label="pomerium-cli" value="pomerium-cli">

‎content/docs/capabilities/non-http/examples/rdp.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2424

2525
## Basic Connection
2626

27-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
27+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
2828

2929
<Tabs>
3030
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/examples/redis.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
2323

2424
## Basic Connection
2525

26-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
26+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
2727

2828
<Tabs>
2929
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/examples/ssh.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This example assumes you've already [created a TCP route](/docs/capabilities/non
3030

3131
## Basic Connection
3232

33-
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/capabilities/non-http/client) or the Pomerium Desktop client:
33+
1. Create a TCP tunnel, using either [`pomerium-cli`](/docs/deploy/clients) or the Pomerium Desktop client:
3434

3535
<Tabs>
3636
<TabItem value="pomerium-cli" label="pomerium-cli">

‎content/docs/capabilities/non-http/tcp.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import LongLivedConnections from '@site/content/docs/admonitions/_long-lived-con
2525

2626
# TCP over HTTP Support
2727

28-
In addition to managing HTTP based applications, Pomerium can be used to protect non-HTTP systems with the same consistent authorization policy. This is achieved by tunneling TCP over HTTP with the help of a client side command built into [`pomerium-cli`](/docs/capabilities/non-http/client).
28+
In addition to managing HTTP based applications, Pomerium can be used to protect non-HTTP systems with the same consistent authorization policy. This is achieved by tunneling TCP over HTTP with the help of a client side command built into [`pomerium-cli`](/docs/deploy/clients).
2929

3030
Operations and engineering teams frequently require access to lower level administrative and data protocols such as SSH, RDP, Postgres, MySQL, Redis, etc.
3131

@@ -66,7 +66,7 @@ When creating TCP routes, note the following:
6666

6767
## Connect to TCP Routes
6868

69-
While HTTP routes can be consumed with just a normal browser, `pomerium-cli` or Pomerium Desktop must serve as a proxy for TCP routes. See [Pomerium Desktop and CLI Clients](/docs/capabilities/non-http/client) for more information.
69+
While HTTP routes can be consumed with just a normal browser, `pomerium-cli` or Pomerium Desktop must serve as a proxy for TCP routes. See [Pomerium Desktop and CLI Clients](/docs/deploy/clients) for more information.
7070

7171
To connect, you normally need just the external hostname and port of your TCP route:
7272

‎content/docs/capabilities/non-http/udp.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import CLIClientCertificates from './_cli-client-certificates.mdx';
2020

2121
# UDP over HTTP Support
2222

23-
Starting in v0.29, Pomerium can be used to protect UDP systems with the same consistent authorization policy. This is achieved by tunneling UDP over HTTP with the help of a client side command built into [`pomerium-cli`](/docs/capabilities/non-http/client).
23+
Starting in v0.29, Pomerium can be used to protect UDP systems with the same consistent authorization policy. This is achieved by tunneling UDP over HTTP with the help of a client side command built into [`pomerium-cli`](/docs/deploy/clients).
2424

2525
Internally, Pomerium uses [`CONNECT-UDP`](https://datatracker.ietf.org/doc/html/rfc9298) to establish the UDP tunnel.
2626

‎content/docs/deploy/clients/clients.md

-16
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.