From a59b811e7d9279e1908db23471ea9db2e491950d Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Thu, 3 May 2018 13:41:12 +0300 Subject: [PATCH] Index all examples and fix their titles --- docs/examples/README.md | 32 ------------------ .../oauth-external-auth}/README.md | 0 .../dashboard-ingress.yaml | 0 .../oauth-external-auth}/images/dashboard.png | Bin .../images/github-auth.png | Bin .../images/oauth-login.png | Bin .../images/register-oauth-app-2.png | Bin .../images/register-oauth-app.png | Bin .../oauth-external-auth}/oauth2-proxy.yaml | 0 .../custom-vts-metrics-prometheus/README.md | 2 +- .../customization/ssl-dh-param/README.md | 2 +- docs/examples/index.md | 26 ++++++++++++++ 12 files changed, 28 insertions(+), 34 deletions(-) delete mode 100644 docs/examples/README.md rename docs/examples/{external-auth => auth/oauth-external-auth}/README.md (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/dashboard-ingress.yaml (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/images/dashboard.png (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/images/github-auth.png (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/images/oauth-login.png (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/images/register-oauth-app-2.png (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/images/register-oauth-app.png (100%) rename docs/examples/{external-auth => auth/oauth-external-auth}/oauth2-proxy.yaml (100%) create mode 100644 docs/examples/index.md diff --git a/docs/examples/README.md b/docs/examples/README.md deleted file mode 100644 index 06043ab01..000000000 --- a/docs/examples/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Ingress examples - -This directory contains a catalog of examples on how to run, configure and -scale Ingress. Please review the [prerequisites](PREREQUISITES.md) before -trying them. - -## Scaling - -Name | Description | Complexity Level ------| ----------- | ---------------- -[Static-ip](static-ip/README.md) | a single ingress gets a single static ip | Intermediate - -## Algorithms - -Name | Description | Complexity Level ------| ----------- | ---------------- -[Session stickyness](affinity/cookie/README.md) | route requests consistently to the same endpoint | Advanced - -## Auth - -Name | Description | Complexity Level ------| ----------- | ---------------- -[Basic auth](auth/basic/README.md) | password protect your website | nginx | Intermediate -[Client certificate authentication](auth/client-certs/README.md) | secure your website with client certificate authentication | nginx | Intermediate -[External auth plugin](external-auth/README.md) | defer to an external auth service | Intermediate - -## Customization - -Name | Description | Complexity Level ------| ----------- | ---------------- -[configuration-snippets](customization/configuration-snippets/README.md) | customize nginx location configuration using annotations | Advanced -[custom-headers](customization/custom-headers/README.md) | set custom headers before send traffic to backends | Advanced diff --git a/docs/examples/external-auth/README.md b/docs/examples/auth/oauth-external-auth/README.md similarity index 100% rename from docs/examples/external-auth/README.md rename to docs/examples/auth/oauth-external-auth/README.md diff --git a/docs/examples/external-auth/dashboard-ingress.yaml b/docs/examples/auth/oauth-external-auth/dashboard-ingress.yaml similarity index 100% rename from docs/examples/external-auth/dashboard-ingress.yaml rename to docs/examples/auth/oauth-external-auth/dashboard-ingress.yaml diff --git a/docs/examples/external-auth/images/dashboard.png b/docs/examples/auth/oauth-external-auth/images/dashboard.png similarity index 100% rename from docs/examples/external-auth/images/dashboard.png rename to docs/examples/auth/oauth-external-auth/images/dashboard.png diff --git a/docs/examples/external-auth/images/github-auth.png b/docs/examples/auth/oauth-external-auth/images/github-auth.png similarity index 100% rename from docs/examples/external-auth/images/github-auth.png rename to docs/examples/auth/oauth-external-auth/images/github-auth.png diff --git a/docs/examples/external-auth/images/oauth-login.png b/docs/examples/auth/oauth-external-auth/images/oauth-login.png similarity index 100% rename from docs/examples/external-auth/images/oauth-login.png rename to docs/examples/auth/oauth-external-auth/images/oauth-login.png diff --git a/docs/examples/external-auth/images/register-oauth-app-2.png b/docs/examples/auth/oauth-external-auth/images/register-oauth-app-2.png similarity index 100% rename from docs/examples/external-auth/images/register-oauth-app-2.png rename to docs/examples/auth/oauth-external-auth/images/register-oauth-app-2.png diff --git a/docs/examples/external-auth/images/register-oauth-app.png b/docs/examples/auth/oauth-external-auth/images/register-oauth-app.png similarity index 100% rename from docs/examples/external-auth/images/register-oauth-app.png rename to docs/examples/auth/oauth-external-auth/images/register-oauth-app.png diff --git a/docs/examples/external-auth/oauth2-proxy.yaml b/docs/examples/auth/oauth-external-auth/oauth2-proxy.yaml similarity index 100% rename from docs/examples/external-auth/oauth2-proxy.yaml rename to docs/examples/auth/oauth-external-auth/oauth2-proxy.yaml diff --git a/docs/examples/customization/custom-vts-metrics-prometheus/README.md b/docs/examples/customization/custom-vts-metrics-prometheus/README.md index fe5deb7dc..c85213905 100644 --- a/docs/examples/customization/custom-vts-metrics-prometheus/README.md +++ b/docs/examples/customization/custom-vts-metrics-prometheus/README.md @@ -1,4 +1,4 @@ -# Deploying the Nginx Ingress controller +# Custom VTS metrics with Prometheus This example aims to demonstrate the deployment of an nginx ingress controller and use a ConfigMap to enable [nginx vts module](https://github.com/vozlt/nginx-module-vts ) to export metrics in prometheus format. diff --git a/docs/examples/customization/ssl-dh-param/README.md b/docs/examples/customization/ssl-dh-param/README.md index 90801867a..f7305e77a 100644 --- a/docs/examples/customization/ssl-dh-param/README.md +++ b/docs/examples/customization/ssl-dh-param/README.md @@ -1,4 +1,4 @@ -# Deploying the Nginx Ingress controller +# Custom DH parameters for perfect forward secrecy This example aims to demonstrate the deployment of an nginx ingress controller and use a ConfigMap to configure custom Diffie-Hellman parameters file to help with diff --git a/docs/examples/index.md b/docs/examples/index.md new file mode 100644 index 000000000..feec494cd --- /dev/null +++ b/docs/examples/index.md @@ -0,0 +1,26 @@ +# Ingress examples + +This directory contains a catalog of examples on how to run, configure and scale Ingress. +Please review the [prerequisites](PREREQUISITES.md) before trying them. + +Category | Name | Description | Complexity Level +---------| ---- | ----------- | ---------------- +Apps | [Docker Registry](docker-registry/README.md) | TODO | TODO +Auth | [Basic authentication](auth/basic/README.md) | password protect your website | Intermediate +Auth | [Client certificate authentication](auth/client-certs/README.md) | secure your website with client certificate authentication | Intermediate +Auth | [External authentication plugin](auth/external-auth/README.md) | defer to an external authentication service | Intermediate +Auth | [OAuth external auth](auth/oauth-external-auth/README.md) | TODO | TODO +Customization | [Configuration snippets](customization/configuration-snippets/README.md) | customize nginx location configuration using annotations | Advanced +Customization | [Custom configuration](customization/custom-configuration/README.md) | TODO | TODO +Customization | [Custom DH parameters for perfect forward secrecy](customization/ssl-dh-param/README.md) | TODO | TODO +Customization | [Custom errors](customization/custom-errors/README.md) | TODO | TODO +Customization | [Custom headers](customization/custom-headers/README.md) | set custom headers before sending traffic to backends | Advanced +Customization | [Custom upstream check](customization/custom-upstream-check/README.md) | TODO | TODO +Customization | [Custom VTS metrics with Prometheus](customization/custom-vts-metrics-prometheus/README.md) | TODO | TODO +Customization | [External authentication with response header propagation](customization/external-auth-headers/README.md) | TODO | TODO +Customization | [Sysctl tuning](customization/sysctl/README.md) | TODO | TODO +Features | [Rewrite](rewrite/README.md) | TODO | TODO +Features | [Session stickiness](affinity/cookie/README.md) | route requests consistently to the same endpoint | Advanced +Scaling | [Static IP](static-ip/README.md) | a single ingress gets a single static IP | Intermediate +TLS | [Multi TLS certificate termination](multi-tls/README.md) | TODO | TODO +TLS | [TLS termination](tls-termination/README.md) | TODO | TODO