From 8b680794880bc97a8a922a3c7ea129c68fb993b5 Mon Sep 17 00:00:00 2001 From: bobby <1544881+desimone@users.noreply.github.com> Date: Sat, 1 Aug 2020 10:00:14 -0700 Subject: [PATCH] docs: rename docs/reference to docs/topics (#1182) * docs: rename docs/reference to docs/topics Signed-off-by: Bobby DeSimone --- docs/.vuepress/config.js | 19 +++++++++--------- docs/.vuepress/public/_redirects | 16 ++++++++++++--- .../{reference => topics}/certificates.md | 2 +- .../{reference => topics}/data-storage.md | 0 .../getting-users-identity.md | 0 .../img/auth-flow-diagram.svg | 0 .../img/certificate-domain-challenge.png | Bin .../img/certificate-wildcard-domain.png | Bin .../img/certificates-ssl-report.png | Bin .../certificates-valid-secure-certificate.png | Bin .../img/inspect-headers.png | Bin .../docs/{reference => topics}/img/jaeger.png | Bin .../img/pomerium-user-impersonation.mp4 | Bin .../img/security-headers.png | Bin .../img/verifying-headers-1.png | Bin .../img/verifying-headers-2.png | Bin .../{reference => topics}/impersonation.md | 0 .../production-deployment.md | 0 .../programmatic-access.md | 0 docs/docs/{reference => topics}/readme.md | 0 docs/guides/kubernetes-dashboard.md | 4 ++-- docs/guides/kubernetes.md | 7 +++++-- docs/guides/local-oidc.md | 2 +- docs/guides/readme.md | 9 +++++---- docs/reference/readme.md | 2 +- .../sh/generate_wildcard_cert.sh | 0 26 files changed, 38 insertions(+), 23 deletions(-) rename docs/docs/{reference => topics}/certificates.md (99%) rename docs/docs/{reference => topics}/data-storage.md (100%) rename docs/docs/{reference => topics}/getting-users-identity.md (100%) rename docs/docs/{reference => topics}/img/auth-flow-diagram.svg (100%) rename docs/docs/{reference => topics}/img/certificate-domain-challenge.png (100%) rename docs/docs/{reference => topics}/img/certificate-wildcard-domain.png (100%) rename docs/docs/{reference => topics}/img/certificates-ssl-report.png (100%) rename docs/docs/{reference => topics}/img/certificates-valid-secure-certificate.png (100%) rename docs/docs/{reference => topics}/img/inspect-headers.png (100%) rename docs/docs/{reference => topics}/img/jaeger.png (100%) rename docs/docs/{reference => topics}/img/pomerium-user-impersonation.mp4 (100%) rename docs/docs/{reference => topics}/img/security-headers.png (100%) rename docs/docs/{reference => topics}/img/verifying-headers-1.png (100%) rename docs/docs/{reference => topics}/img/verifying-headers-2.png (100%) rename docs/docs/{reference => topics}/impersonation.md (100%) rename docs/docs/{reference => topics}/production-deployment.md (100%) rename docs/docs/{reference => topics}/programmatic-access.md (100%) rename docs/docs/{reference => topics}/readme.md (100%) rename {docs/docs/reference => examples}/sh/generate_wildcard_cert.sh (100%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index df051415f..89a91b88a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -107,8 +107,8 @@ module.exports = { "identity-providers/", "identity-providers/azure", "identity-providers/cognito", - "identity-providers/gitlab", "identity-providers/github", + "identity-providers/gitlab", "identity-providers/google", "identity-providers/okta", "identity-providers/one-login", @@ -128,19 +128,19 @@ module.exports = { ], }, { - title: "Reference", + title: "Topics", collapsable: true, - path: "/docs/reference/", + path: "/docs/topics/", type: "group", collapsable: false, sidebarDepth: 1, children: [ - "reference/certificates", - "reference/data-storage", - "reference/impersonation", - "reference/programmatic-access", - "reference/getting-users-identity", - "reference/production-deployment", + "topics/certificates", + "topics/data-storage", + "topics/getting-users-identity", + "topics/impersonation", + "topics/production-deployment", + "topics/programmatic-access", ], }, ], @@ -158,6 +158,7 @@ module.exports = { "cloud-run", "istio", "kubernetes", + "kubernetes-dashboard", "local-oidc", "mtls", "tiddlywiki", diff --git a/docs/.vuepress/public/_redirects b/docs/.vuepress/public/_redirects index b37c63e60..ca88707e0 100644 --- a/docs/.vuepress/public/_redirects +++ b/docs/.vuepress/public/_redirects @@ -14,8 +14,6 @@ /community/security /docs/community/security.html /community/security.html /docs/community/security.html -/docs/reference/examples.html /configuration/examples.html - /guide/ /docs/quick-start/ /guide/kubernetes.html /docs/quick-start/kubernetes.html /guide/kubernetes /docs/quick-start/kubernetes.html @@ -32,4 +30,16 @@ /recipes/kubernetes.html /guides/kubernetes.html /recipes/local-oidc.html /guides/local-oidc.html /recipes/mtls.html /guides/mtls.html -/recipes/vs-code-server.html /guides/vs-code-server.html \ No newline at end of file +/recipes/vs-code-server.html /guides/vs-code-server.html + + +/docs/reference/ /docs/topics/ +/docs/reference/readme.html /docs/topics/readme.html +/docs/reference/certificates.html /docs/topics/certificates.html +/docs/reference/data-storage.html /docs/topics/data-storage.html +/docs/reference/getting-users-identity.html /docs/topics/getting-users-identity.html +/docs/reference/impersonation.html /docs/topics/impersonation.html +/docs/reference/production-deployment.html /docs/topics/production-deployment.html +/docs/reference/programmatic-access.html /docs/topics/programmatic-access.html + +/docs/reference/examples.html /configuration/examples.html diff --git a/docs/docs/reference/certificates.md b/docs/docs/topics/certificates.md similarity index 99% rename from docs/docs/reference/certificates.md rename to docs/docs/topics/certificates.md index 3b6970b6c..e28bcd9a0 100644 --- a/docs/docs/reference/certificates.md +++ b/docs/docs/topics/certificates.md @@ -64,7 +64,7 @@ mkcert "*.localhost.pomerium.io" Once you've setup your wildcard domain, we can use acme.sh to create a certificate-signing request with LetsEncrypt. -<<< @/docs/docs/reference/sh/generate_wildcard_cert.sh +<<< @/examples/sh/generate_wildcard_cert.sh LetsEncrypt will respond with the corresponding `TXT` record needed to verify our domain. diff --git a/docs/docs/reference/data-storage.md b/docs/docs/topics/data-storage.md similarity index 100% rename from docs/docs/reference/data-storage.md rename to docs/docs/topics/data-storage.md diff --git a/docs/docs/reference/getting-users-identity.md b/docs/docs/topics/getting-users-identity.md similarity index 100% rename from docs/docs/reference/getting-users-identity.md rename to docs/docs/topics/getting-users-identity.md diff --git a/docs/docs/reference/img/auth-flow-diagram.svg b/docs/docs/topics/img/auth-flow-diagram.svg similarity index 100% rename from docs/docs/reference/img/auth-flow-diagram.svg rename to docs/docs/topics/img/auth-flow-diagram.svg diff --git a/docs/docs/reference/img/certificate-domain-challenge.png b/docs/docs/topics/img/certificate-domain-challenge.png similarity index 100% rename from docs/docs/reference/img/certificate-domain-challenge.png rename to docs/docs/topics/img/certificate-domain-challenge.png diff --git a/docs/docs/reference/img/certificate-wildcard-domain.png b/docs/docs/topics/img/certificate-wildcard-domain.png similarity index 100% rename from docs/docs/reference/img/certificate-wildcard-domain.png rename to docs/docs/topics/img/certificate-wildcard-domain.png diff --git a/docs/docs/reference/img/certificates-ssl-report.png b/docs/docs/topics/img/certificates-ssl-report.png similarity index 100% rename from docs/docs/reference/img/certificates-ssl-report.png rename to docs/docs/topics/img/certificates-ssl-report.png diff --git a/docs/docs/reference/img/certificates-valid-secure-certificate.png b/docs/docs/topics/img/certificates-valid-secure-certificate.png similarity index 100% rename from docs/docs/reference/img/certificates-valid-secure-certificate.png rename to docs/docs/topics/img/certificates-valid-secure-certificate.png diff --git a/docs/docs/reference/img/inspect-headers.png b/docs/docs/topics/img/inspect-headers.png similarity index 100% rename from docs/docs/reference/img/inspect-headers.png rename to docs/docs/topics/img/inspect-headers.png diff --git a/docs/docs/reference/img/jaeger.png b/docs/docs/topics/img/jaeger.png similarity index 100% rename from docs/docs/reference/img/jaeger.png rename to docs/docs/topics/img/jaeger.png diff --git a/docs/docs/reference/img/pomerium-user-impersonation.mp4 b/docs/docs/topics/img/pomerium-user-impersonation.mp4 similarity index 100% rename from docs/docs/reference/img/pomerium-user-impersonation.mp4 rename to docs/docs/topics/img/pomerium-user-impersonation.mp4 diff --git a/docs/docs/reference/img/security-headers.png b/docs/docs/topics/img/security-headers.png similarity index 100% rename from docs/docs/reference/img/security-headers.png rename to docs/docs/topics/img/security-headers.png diff --git a/docs/docs/reference/img/verifying-headers-1.png b/docs/docs/topics/img/verifying-headers-1.png similarity index 100% rename from docs/docs/reference/img/verifying-headers-1.png rename to docs/docs/topics/img/verifying-headers-1.png diff --git a/docs/docs/reference/img/verifying-headers-2.png b/docs/docs/topics/img/verifying-headers-2.png similarity index 100% rename from docs/docs/reference/img/verifying-headers-2.png rename to docs/docs/topics/img/verifying-headers-2.png diff --git a/docs/docs/reference/impersonation.md b/docs/docs/topics/impersonation.md similarity index 100% rename from docs/docs/reference/impersonation.md rename to docs/docs/topics/impersonation.md diff --git a/docs/docs/reference/production-deployment.md b/docs/docs/topics/production-deployment.md similarity index 100% rename from docs/docs/reference/production-deployment.md rename to docs/docs/topics/production-deployment.md diff --git a/docs/docs/reference/programmatic-access.md b/docs/docs/topics/programmatic-access.md similarity index 100% rename from docs/docs/reference/programmatic-access.md rename to docs/docs/topics/programmatic-access.md diff --git a/docs/docs/reference/readme.md b/docs/docs/topics/readme.md similarity index 100% rename from docs/docs/reference/readme.md rename to docs/docs/topics/readme.md diff --git a/docs/guides/kubernetes-dashboard.md b/docs/guides/kubernetes-dashboard.md index 651ef74d1..ca4a218a7 100644 --- a/docs/guides/kubernetes-dashboard.md +++ b/docs/guides/kubernetes-dashboard.md @@ -350,7 +350,7 @@ Whichever option you choose to go with, πŸŽ‰πŸΎπŸŽŠ **congratulations** πŸŽ‰ [creating sample users]: https://github.com/kubernetes/dashboard/blob/master/docs/user/access-control/creating-sample-user.md [dashboard ui]: https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/#deploying-the-dashboard-ui [dns01 challenge provider]: https://docs.cert-manager.io/en/latest/tasks/issuers/setup-acme/dns01/index.html -[forward-auth]: ../docs/reference/reference.html#forward-auth +[forward-auth]: ../docs/topics/reference.html#forward-auth [helm install]: https://helm.sh/docs/using_helm/#installing-the-helm-client [helm]: https://helm.sh [homebrew]: https://brew.sh @@ -362,5 +362,5 @@ Whichever option you choose to go with, πŸŽ‰πŸΎπŸŽŠ **congratulations** πŸŽ‰ [nginx]: https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-subrequest-authentication/ [securing your helm installation]: https://helm.sh/docs/using_helm/#securing-your-helm-installation [snap]: https://github.com/snapcrafters/helm -[with pomerium]: ../docs/reference/reference.html#forward-auth +[with pomerium]: ../docs/topics/reference.html#forward-auth [your dashboard]: http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/#/login diff --git a/docs/guides/kubernetes.md b/docs/guides/kubernetes.md index 3bbd0bf27..c869b1eb7 100644 --- a/docs/guides/kubernetes.md +++ b/docs/guides/kubernetes.md @@ -1,5 +1,5 @@ --- -title: Kubernetes +title: Kubernetes API / Kubectl lang: en-US meta: - name: keywords @@ -35,7 +35,7 @@ kind create cluster --config=./kind-config.yaml ### Pomerium Service Account -Pomerium uses a single service account and user impersonatation headers to authenticate and authorize users in Kubernetes. To create the Pomerium service account use the following config: (`pomerium-k8s.yaml`) +Pomerium uses a single service account and user impersonation headers to authenticate and authorize users in Kubernetes. To create the Pomerium service account use the following config: (`pomerium-k8s.yaml`) ```yaml # pomerium-k8s.yaml @@ -265,3 +265,6 @@ kubectl --context=via-pomerium cluster-info ``` You should be prompted to login and see the resulting cluster info. + + +[kubernetes]: https://kubernetes.io diff --git a/docs/guides/local-oidc.md b/docs/guides/local-oidc.md index 642bcdcef..e38068163 100644 --- a/docs/guides/local-oidc.md +++ b/docs/guides/local-oidc.md @@ -1,5 +1,5 @@ --- -title: local oidc +title: Local OIDC Provider lang: en-US meta: - name: keywords diff --git a/docs/guides/readme.md b/docs/guides/readme.md index ee89ccaeb..b40331e6a 100644 --- a/docs/guides/readme.md +++ b/docs/guides/readme.md @@ -3,10 +3,11 @@ This section contains applications, and scenario specific guides for Pomerium. - The [ad-guard](./ad-guard.md) recipe demonstrates how pomerium can be used to augment web applications that only support simplistic authorization mechanisms like basic-auth with single-sign-on driven access policy. -- The [Cloud Run](./cloud-run.md) recipe demonstrates deploying pomerium to Google Cloud Run as well as using it to Authorize users to protected Cloud Run endpoints. -- The [kubernetes](./kubernetes.md) guide covers how to add authentication and authorization to kubernetes dashboard using helm, and letsencrypt certificates. This guide also shows how third party reverse-proxies like nginx/traefik can be used in conjunction with pomerium using forward-auth. -- The [visual studio code](./vs-code-server.md) guide demonstrates how pomerium can be used to add access control to third-party applications that don't ship with [fine-grained access control](https://github.com/cdr/code-server/issues/905). - The [argo](./argo.md) guide demonstrates how pomerium can be used to add access control to [Argo](https://argoproj.github.io/projects/argo). -- The [mTLS](./mtls.md) guide demonstrates how pomerium can be used to add mutual authentication using client certificates and a custom certificate authority. +- The [Cloud Run](./cloud-run.md) recipe demonstrates deploying pomerium to Google Cloud Run as well as using it to Authorize users to protected Cloud Run endpoints. +- The [Kubernetes Dashboard](./kubernetes-dashboard.md) guide covers how to secure Kubernetes dashboard using Pomerium. +- The [kubernetes](./kubernetes.md) guide covers how to add authentication and authorization to kubernetes dashboard using helm, and letsencrypt certificates. This guide also shows how third party reverse-proxies like nginx/traefik can be used in conjunction with pomerium using forward-auth. - The [local OIDC](./local-oidc.md) guide demonstrates how pomerium can be used with local OIDC server for dev/testing. +- The [mTLS](./mtls.md) guide demonstrates how pomerium can be used to add mutual authentication using client certificates and a custom certificate authority. - The [TiddlyWiki](./tiddlywiki.md) guide demonstrates how pomerium can be used to add authentication and authorization to web application using authenticated header. +- The [visual studio code](./vs-code-server.md) guide demonstrates how pomerium can be used to add access control to third-party applications that don't ship with [fine-grained access control](https://github.com/cdr/code-server/issues/905). \ No newline at end of file diff --git a/docs/reference/readme.md b/docs/reference/readme.md index ed7f0abb6..38c055ad0 100644 --- a/docs/reference/readme.md +++ b/docs/reference/readme.md @@ -1122,7 +1122,7 @@ Note: This setting will replace (not append) the system's trust store for a give - Type: [base64 encoded] `string` or relative file location - Optional -Pomerium supports client certificates which can be used to enforce [mutually authenticated and encrypted TLS connections](https://en.wikipedia.org/wiki/Mutual_authentication) (mTLS). For more details, see our [mTLS example repository](https://github.com/pomerium/examples/tree/master/mutual-tls) and the [certificate docs](../docs/reference/certificates.md). +Pomerium supports client certificates which can be used to enforce [mutually authenticated and encrypted TLS connections](https://en.wikipedia.org/wiki/Mutual_authentication) (mTLS). For more details, see our [mTLS example repository](https://github.com/pomerium/examples/tree/master/mutual-tls) and the [certificate docs](../docs/topics/certificates.md). ### Websocket Connections diff --git a/docs/docs/reference/sh/generate_wildcard_cert.sh b/examples/sh/generate_wildcard_cert.sh similarity index 100% rename from docs/docs/reference/sh/generate_wildcard_cert.sh rename to examples/sh/generate_wildcard_cert.sh