docs: refactor sections, consolidate examples (#1164)

docs/.vuepress/config.js

@@ -42,8 +42,8 @@ module.exports = {
     lastUpdated: "Last Updated",
     nav: [
       { text: "Documentation", link: "/docs/" },
-      { text: "Configuration", link: "/configuration/" },
+      { text: "Reference", link: "/reference/" },
-      { text: "Recipes", link: "/recipes/" },
+      { text: "Guides", link: "/guides/" },
       { text: "Enterprise", link: "/enterprise/" },
       {
         text: "v0.9.x", // current tagged version
@@ -143,14 +143,25 @@ module.exports = {
           ],
         },
       ],
-      "/recipes/": [
+      "/guides/": [
         {
-          title: "Recipes",
+          title: "Guides",
           type: "group",
 
           collapsable: false,
           sidebarDepth: 1,
-          children: ["", "ad-guard", "cloud-run", "vs-code-server", "kubernetes", "argo", "mtls", "local-oidc", "tiddlywiki"],
+          children: [
+            "",
+            "ad-guard",
+            "argo",
+            "cloud-run",
+            "istio",
+            "kubernetes",
+            "local-oidc",
+            "mtls",
+            "tiddlywiki",
+            "vs-code-server",
+          ],
         },
       ],
       "/enterprise/": [
@@ -162,13 +173,13 @@ module.exports = {
           children: [""],
         },
       ],
-      "/configuration/": [
+      "/reference/": [
         {
-          title: "Configuration",
+          title: "",
           type: "group",
           collapsable: false,
           sidebarDepth: 1,
-          children: ["", "examples"],
+          children: [""],
         },
       ],
     },

docs/.vuepress/public/_redirects

@@ -2,6 +2,9 @@
 /docs/reference/reference.html		/configuration/
 /docs/configuration/				/configuration/
 
+/configuration/						/reference/
+
+
 /community/							/docs/community/
 /community/index.html				/docs/community/
 /community/contributing				/docs/community/contributing.html
@@ -13,7 +16,6 @@
 
 /docs/reference/examples.html		/configuration/examples.html
 
-/reference/				/docs/reference/reference.html
 /guide/					/docs/quick-start/
 /guide/kubernetes.html	/docs/quick-start/kubernetes.html
 /guide/kubernetes		/docs/quick-start/kubernetes.html
@@ -21,3 +23,13 @@
 /guide/synology.html	/docs/quick-start/synology.html
 /docs/examples.html		/recipes/
 /docs/examples			/recipes/
+
+/recipes/ 						/guides/
+/recipes/ad-guard.html 			/guides/ad-guard.html
+/recipes/argo.html 				/guides/argo.html
+/recipes/cloud-run.html			/guides/cloud-run.html
+/recipes/istio.html				/guides/istio.html
+/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

docs/configuration/examples.md

@@ -1,171 +0,0 @@
----
-title: Examples
-lang: en-US
-sidebarDepth: 2
-meta:
-  - name: keywords
-    content: pomerium community help bugs updates features
-description: >-
-  This document describes how you users can stay up to date with pomerium,
-  report issues, get help, and suggest new features.
----
-
-# Examples
-
-A collection of copy-and-paste-able configurations for various types of clouds, use-cases, and deployments. These files can also be found in the git repository in the `docs/configuration/examples/` directory.
-
-:::tip
-
-Remember to set your identity provider settings and to generate new secret keys!
-
-:::
-
-[[toc]]
-
-## Settings
-
-### Configuration File
-
-<<< @/docs/configuration/examples/config/config.example.yaml
-
-### Environmental Variables
-
-<<< @/docs/configuration/examples/config/config.example.env
-
-## Binary
-
-- Suitable for bare-metal and virtual-machines
-- No docker, docker-compose, or kubernetes required
-- Minimal configuration
-- Pomerium services are run in "all-in-one" mode
-- No load balancer required
-- Great for testing Pomerium
-- Routes default to hosted version of httpbin.org
-
-Customize for your identity provider and run `./bin/pomerium -config config.yaml`
-
-## Docker
-
-Uses the [latest pomerium build](https://hub.docker.com/r/pomerium/pomerium) from docker hub. Docker and docker-compose are great tools for standing up and testing multiple service, and containers without having to stand-up a full on cluster.
-
-### All-in-One
-
-- Minimal container-based configuration.
-- Docker and Docker-Compose based.
-- Runs a single container for all pomerium services
-- Routes default to on-premise [httpbin].
-
-Customize for your identity provider run `docker-compose up -f basic.docker-compose.yml`
-
-#### basic.docker-compose.yml
-
-<<< @/docs/configuration/examples/docker/basic.docker-compose.yml
-
-### Distinct Services
-
-- Docker and Docker-Compose based.
-- Uses pre-configured built-in nginx load balancer
-- Runs separate containers for each service
-- Routes default to on-premise [helloworld], and [httpbin].
-
-Customize for your identity provider run `docker-compose up -f nginx.docker-compose.yml`
-
-#### nginx.docker-compose.yml
-
-<<< @/docs/configuration/examples/docker/nginx.docker-compose.yml
-
-## Helm
-
-- HTTPS (TLS) between client, load balancer, and services
-- gRPC requests are routed behind the load balancer
-- Routes default to hosted version of httpbin.org
-- Includes installer script
-- Pomerium serves on HTTPS and your ingress controller may need an annotation to
-  connect properly
-
-### GKE
-
-- Uses Google Kubernetes Engine's built-in ingress to do [HTTPS load balancing]
-
-<<< @/docs/configuration/examples/helm/helm_gke.sh
-
-### Kubernetes
-
-- Uses Google Kubernetes Engine's built-in ingress to do [HTTPS load balancing]
-- HTTPS (TLS) between client, load balancer, and services
-- gRPC requests are routed behind the load balancer
-- Routes default to hosted version of httpbin.org
-- Includes installer script
-
-#### kubernetes_gke
-
-<<< @/docs/configuration/examples/kubernetes/kubernetes_gke.sh
-
-#### kubernetes-config.yaml
-
-<<< @/docs/configuration/examples/kubernetes/kubernetes-config.yaml
-
-#### pomerium-authenticate.yml
-
-<<< @/docs/configuration/examples/kubernetes/pomerium-authenticate.yml
-
-#### pomerium-authorize.yml
-
-<<< @/docs/configuration/examples/kubernetes/pomerium-authorize.yml
-
-#### pomerium-proxy.yml
-
-<<< @/docs/configuration/examples/kubernetes/pomerium-proxy.yml
-
-#### pomerium-cache.yml
-
-<<< @/docs/configuration/examples/kubernetes/pomerium-cache.yml
-
-
-#### ingress.yml
-
-<<< @/docs/configuration/examples/kubernetes/ingress.yml
-
-[helloworld]: https://hub.docker.com/r/tutum/hello-world
-[httpbin]: https://httpbin.org/
-[https load balancing]: https://cloud.google.com/kubernetes-engine/docs/concepts/ingress
-
-## Istio
-
-[istio]: https://github.com/istio/istio
-[certmanager]: https://github.com/jetstack/cert-manager
-[grafana]: https://github.com/grafana/grafana
-
-- Istio provides mutual TLS via sidecars and to make Istio play well with Pomerium we need to disable TLS on the Pomerium side.
-- We need to provide Istio with information on how to route requests via Pomerium to their destinations.
-- The following example shows how to make Grafana's [auth proxy](https://grafana.com/docs/grafana/latest/auth/auth-proxy) work with Pomerium inside of an Istio mesh.
-
-#### Gateway
-
-We are using the standard istio-ingressgateway that comes configured with Istio and attach a Gateway to it that deals with a subset of our ingress traffic based on the Host header (in this case `*.yourcompany.com`). This is the Gateway to which we will later attach VirtualServices for more granular routing decisions. Along with the Gateway, because we care about TLS, we are using Certmanager to provision a self-signed certificate (see Certmanager [docs](https://cert-manager.io/docs) for setup instructions).
-
-<<< @/docs/configuration/examples/kubernetes/istio/gateway.yml
-
-#### Virtual Services
-
-Here we are configuring two Virtual Services. One to route from the Gateway to the Authenticate service and one to route from the Gateway to the Pomerium Proxy, which will route the request to Grafana according to the configured Pomerium policy.
-
-<<< @/docs/configuration/examples/kubernetes/istio/virtual-services.yml
-
-#### Service Entry
-
-If you are enforcing mutual TLS in your service mesh you will need to add a ServiceEntry for your identity provider so that Istio knows not to expect a mutual TLS connection with, for example `https://yourcompany.okta.com`.
-
-<<< @/docs/configuration/examples/kubernetes/istio/service-entry.yml
-
-#### Pomerium Configuration
-
-For this example we're using the Pomerium Helm chart with the following `values.yaml` file. Things to note here are the `insecure` flag, where we are disabling TLS in Pomerium in favor of the Istio-provided TLS via sidecars. Also note the `extaEnv` arguments where we are asking Pomerium to extract the email property from the JWT and pass it on to Grafana in a header called `X-Pomerium-Claim-Email`. We need to do this because Grafana does not know how to read the Pomerium JWT but its auth-proxy authentication method can be configured to read user information from headers. The policy document contains a single route that will send all requests with a host header of `https://grafana.yourcompany.com` to the Grafana instance running in the monitoring namespace. We disable ingress because we are using the Istio ingressgateway for ingress traffic and don't need the Pomerium helm chart to create ingress objects for us.
-
-<<< @/docs/configuration/examples/kubernetes/istio/pomerium-helm-values.yml
-
-#### Grafana ini
-
-On the Grafana side we are using the Grafana Helm chart and what follows is the relevant section of the `values.yml` file. The most important thing here is that we need to tell Grafana from which request header to grab the username. In this case that's `X-Pomerium-Claim-Email` because we will be using the user's email (provided by your identity provider) as their username in Grafana. For all the configuration options check out the Grafana documentation about its auth-proxy authentication method.
-
-<<< @/docs/configuration/examples/kubernetes/istio/grafana.ini.yml

docs/docs/quick-start/binary.md

@@ -27,13 +27,13 @@ Pomerium supports setting [configuration variables] using both environmental var
 
 Create a config file (`config.yaml`). This file will be used to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
 
-<<< @/docs/configuration/examples/config/config.minimal.yaml
+<<< @/examples/config/config.minimal.yaml
 
 ### Environmental Variables
 
 As mentioned above, Pomerium supports mixing and matching configuration. For example, we can specify our secret values and domains certificates as [environmental configuration variables], and set the rest as part of the configuration file.
 
-<<< @/docs/configuration/examples/config/config.minimal.env
+<<< @/examples/config/config.minimal.env
 
 ## Run
 

docs/docs/quick-start/from-source.md

@@ -57,7 +57,7 @@ Pomerium supports setting [configuration variables] using both environmental var
 
 Create a config file (`config.yaml`). This file will be use to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
 
-<<< @/docs/configuration/examples/config/config.minimal.yaml
+<<< @/examples/config/config.minimal.yaml
 
 ## Run
 

docs/docs/quick-start/helm.md

@@ -27,9 +27,9 @@ In addition to sharing many of the same features as the Kubernetes quickstart gu
 
 Download and modify the following helm_gke.sh script and values file to match your [identity provider] and [TLS certificates] settings.
 
-<<<@/docs/configuration/examples/helm/helm_gke.sh
+<<<@/examples/helm/helm_gke.sh
 
-<<<@/docs/configuration/examples/kubernetes/values.yaml
+<<<@/examples/kubernetes/values.yaml
 
 ## Run
 

docs/docs/quick-start/kubernetes.md

@@ -31,7 +31,7 @@ cd $HOME/pomerium/docs/configuration/examples/kubernetes
 
 Edit [./kubernetes_gke.sh] making sure to change the identity provider secret value to match your [identity provider] and [TLS certificates] settings.
 
-<<<@/docs/configuration/examples/kubernetes/kubernetes_gke.sh
+<<<@/examples/kubernetes/kubernetes_gke.sh
 
 ## Run
 

docs/docs/quick-start/readme.md

@@ -22,7 +22,7 @@ In the following quick-start, we'll create a minimal but complete environment fo
 
 Create a [configuration file] (e.g `config.yaml`) for defining Pomerium's configuration settings, routes, and access-policies. Consider the following example:
 
-<<< @/docs/configuration/examples/config/config.minimal.yaml
+<<< @/examples/config/config.minimal.yaml
 
 Ensure the `docker-compose.yml` contains the correct path to your `config.yaml`.
 
@@ -36,7 +36,7 @@ Download the following `docker-compose.yml` file and modify it to:
 - mount your `config.yaml` [configuration file]
 - Set `autocert_use_staging` to `false` once you have finished testing
 
-<<< @/docs/configuration/examples/docker/autocert.docker-compose.yml
+<<< @/examples/docker/autocert.docker-compose.yml
 
 Please note that you should use a persistent volume to store certificate data, or you may exhaust your domain quota on Let's Encrypt.
 
@@ -48,7 +48,7 @@ Download the following `docker-compose.yml` file and modify it to:
 - mount your [TLS certificates]
 - mount your `config.yaml` [configuration file]
 
-<<< @/docs/configuration/examples/docker/basic.docker-compose.yml
+<<< @/examples/docker/basic.docker-compose.yml
 
 ## Run
 

docs/guides/istio.md

@@ -0,0 +1,39 @@
+## Istio
+
+[istio]: https://github.com/istio/istio
+[certmanager]: https://github.com/jetstack/cert-manager
+[grafana]: https://github.com/grafana/grafana
+
+- Istio provides mutual TLS via sidecars and to make Istio play well with Pomerium we need to disable TLS on the Pomerium side.
+- We need to provide Istio with information on how to route requests via Pomerium to their destinations.
+- The following example shows how to make Grafana's [auth proxy](https://grafana.com/docs/grafana/latest/auth/auth-proxy) work with Pomerium inside of an Istio mesh.
+
+#### Gateway
+
+We are using the standard istio-ingressgateway that comes configured with Istio and attach a Gateway to it that deals with a subset of our ingress traffic based on the Host header (in this case `*.yourcompany.com`). This is the Gateway to which we will later attach VirtualServices for more granular routing decisions. Along with the Gateway, because we care about TLS, we are using Certmanager to provision a self-signed certificate (see Certmanager [docs](https://cert-manager.io/docs) for setup instructions).
+
+<<< @/examples/kubernetes/istio/gateway.yml
+
+#### Virtual Services
+
+Here we are configuring two Virtual Services. One to route from the Gateway to the Authenticate service and one to route from the Gateway to the Pomerium Proxy, which will route the request to Grafana according to the configured Pomerium policy.
+
+<<< @/examples/kubernetes/istio/virtual-services.yml
+
+#### Service Entry
+
+If you are enforcing mutual TLS in your service mesh you will need to add a ServiceEntry for your identity provider so that Istio knows not to expect a mutual TLS connection with, for example `https://yourcompany.okta.com`.
+
+<<< @/examples/kubernetes/istio/service-entry.yml
+
+#### Pomerium Configuration
+
+For this example we're using the Pomerium Helm chart with the following `values.yaml` file. Things to note here are the `insecure` flag, where we are disabling TLS in Pomerium in favor of the Istio-provided TLS via sidecars. Also note the `extaEnv` arguments where we are asking Pomerium to extract the email property from the JWT and pass it on to Grafana in a header called `X-Pomerium-Claim-Email`. We need to do this because Grafana does not know how to read the Pomerium JWT but its auth-proxy authentication method can be configured to read user information from headers. The policy document contains a single route that will send all requests with a host header of `https://grafana.yourcompany.com` to the Grafana instance running in the monitoring namespace. We disable ingress because we are using the Istio ingressgateway for ingress traffic and don't need the Pomerium helm chart to create ingress objects for us.
+
+<<< @/examples/kubernetes/istio/pomerium-helm-values.yml
+
+#### Grafana ini
+
+On the Grafana side we are using the Grafana Helm chart and what follows is the relevant section of the `values.yml` file. The most important thing here is that we need to tell Grafana from which request header to grab the username. In this case that's `X-Pomerium-Claim-Email` because we will be using the user's email (provided by your identity provider) as their username in Grafana. For all the configuration options check out the Grafana documentation about its auth-proxy authentication method.
+
+<<< @/examples/kubernetes/istio/grafana.ini.yml

docs/guides/kubernetes-dashboard.md

@@ -155,7 +155,7 @@ Now that cert-manager is installed, we need to make one more configuration to be
 $ kubectl apply -f docs/recipes/yml/letsencrypt-prod.yaml
 ```
 
-<<< @/docs/recipes/yml/letsencrypt-prod.yaml
+<<< @/examples/yml/letsencrypt-prod.yaml
 
 And confirm your issuer is set up correctly.
 
@@ -301,13 +301,13 @@ Now we just need to tell external traffic how to route everything by deploying t
 $kubectl apply -f docs/recipes/yml/dashboard-forwardauth.ingress.yaml
 ```
 
-<<< @/docs/recipes/yml/dashboard-forwardauth.ingress.yaml
+<<< @/examples/yml/dashboard-forwardauth.ingress.yaml
 
 ```sh
 $kubectl apply -f docs/recipes/yml/dashboard-proxied.ingress.yaml
 ```
 
-<<< @/docs/recipes/yml/dashboard-proxied.ingress.yaml
+<<< @/examples/yml/dashboard-proxied.ingress.yaml
 
 And finally, check that the ingresses are up and running.
 

docs/guides/tiddlywiki.md

@@ -14,7 +14,7 @@ This guide covers using Pomerium to add authentication and authorization to an i
 
 ## What is TiddlyWiki on Node.js
 
-TiddlyWiki is a personal wiki and a non-linear notebook for organising and sharing complex information. It is available in two forms:
+TiddlyWiki is a personal wiki and a non-linear notebook for organizing and sharing complex information. It is available in two forms:
 
 - a single HTML page
 - [a Node.js application](https://www.npmjs.com/package/tiddlywiki)

docs/reference/readme.md

@@ -844,7 +844,7 @@ The connection string that server will use to connect to storage backend.
 
 Policy contains route specific settings, and access control details. If you are configuring via POLICY environment variable, just the contents of the policy needs to be passed. If you are configuring via file, the policy should be present under the policy key. For example,
 
-<<< @/docs/configuration/examples/config/policy.example.yaml
+<<< @/examples/config/policy.example.yaml
 
 Policy routes are checked in the order they appear in the policy, so more specific routes should appear before less specific routes. For example: