2018-04-24 10:30:17 +00:00
|
|
|
site_name: NGINX Ingress Controller
|
2018-09-13 16:28:16 +00:00
|
|
|
repo_name: "kubernetes/ingress-nginx"
|
2019-11-08 14:44:47 +00:00
|
|
|
repo_url: https://github.com/kubernetes/ingress-nginx
|
|
|
|
|
site_url: https://kubernetes.github.io/ingress-nginx
|
|
|
|
|
|
2018-04-24 10:30:17 +00:00
|
|
|
markdown_extensions:
|
2020-09-01 23:49:17 +00:00
|
|
|
- attr_list
|
|
|
|
|
- pymdownx.emoji
|
2018-04-24 10:30:17 +00:00
|
|
|
- admonition
|
2018-10-12 01:09:01 +00:00
|
|
|
- codehilite
|
2018-04-24 10:30:17 +00:00
|
|
|
- pymdownx.inlinehilite
|
2018-09-27 01:09:46 +00:00
|
|
|
- pymdownx.tasklist:
|
|
|
|
|
custom_checkbox: true
|
2018-09-04 19:32:47 +00:00
|
|
|
- pymdownx.superfences
|
2019-11-08 14:44:47 +00:00
|
|
|
- meta
|
2019-11-08 19:22:52 +00:00
|
|
|
- toc:
|
|
|
|
|
# insert a blank space before the character
|
|
|
|
|
permalink: " ¶"
|
2018-04-24 10:30:17 +00:00
|
|
|
theme:
|
|
|
|
|
name: material
|
2020-04-15 17:06:22 +00:00
|
|
|
features:
|
|
|
|
|
- tabs
|
|
|
|
|
- instant
|
|
|
|
|
|
2018-04-24 10:30:17 +00:00
|
|
|
palette:
|
2018-09-13 16:28:16 +00:00
|
|
|
primary: "teal"
|
|
|
|
|
accent: "green"
|
2020-04-15 17:06:22 +00:00
|
|
|
|
2018-09-13 16:28:16 +00:00
|
|
|
include_sidebar: true
|
|
|
|
|
|
2018-04-24 10:30:17 +00:00
|
|
|
plugins:
|
|
|
|
|
- search
|
2020-04-15 17:06:22 +00:00
|
|
|
- awesome-pages
|
2018-09-13 16:28:16 +00:00
|
|
|
|
2018-04-26 23:48:41 +00:00
|
|
|
extra_css: [extra.css]
|
2018-09-13 16:28:16 +00:00
|
|
|
|
|
|
|
|
google_analytics: ["UA-118407822-1", "kubernetes.github.io"]
|
|
|
|
|
|
2018-09-13 23:43:48 +00:00
|
|
|
nav:
|
2018-09-13 16:28:16 +00:00
|
|
|
- Welcome:
|
2018-09-13 23:43:48 +00:00
|
|
|
- Welcome: "index.md"
|
|
|
|
|
- How it works: "how-it-works.md"
|
|
|
|
|
- Troubleshooting: "troubleshooting.md"
|
2019-04-09 21:46:03 +00:00
|
|
|
- kubectl plugin: "kubectl-plugin.md"
|
2018-09-13 23:43:48 +00:00
|
|
|
- Development: "development.md"
|
2018-09-13 16:28:16 +00:00
|
|
|
- Deployment:
|
|
|
|
|
- Installation Guide: "deploy/index.md"
|
|
|
|
|
- Bare-metal considerations: "deploy/baremetal.md"
|
|
|
|
|
- Role Based Access Control (RBAC): "deploy/rbac.md"
|
|
|
|
|
- Upgrade: "deploy/upgrade.md"
|
2020-07-10 12:13:19 +00:00
|
|
|
- Hardening guide: "deploy/hardening-guide.md"
|
2018-09-13 16:28:16 +00:00
|
|
|
- User guide:
|
|
|
|
|
- NGINX Configuration:
|
|
|
|
|
- Introduction: "user-guide/nginx-configuration/index.md"
|
2019-02-24 02:40:23 +00:00
|
|
|
- Basic usage: "user-guide/basic-usage.md"
|
2018-09-13 16:28:16 +00:00
|
|
|
- Annotations: "user-guide/nginx-configuration/annotations.md"
|
|
|
|
|
- ConfigMap: "user-guide/nginx-configuration/configmap.md"
|
|
|
|
|
- Custom NGINX template: "user-guide/nginx-configuration/custom-template.md"
|
|
|
|
|
- Log format: "user-guide/nginx-configuration/log-format.md"
|
|
|
|
|
- Command line arguments: "user-guide/cli-arguments.md"
|
|
|
|
|
- Custom errors: "user-guide/custom-errors.md"
|
|
|
|
|
- Default backend: "user-guide/default-backend.md"
|
2018-11-22 02:24:34 +00:00
|
|
|
- Exposing TCP and UDP services: "user-guide/exposing-tcp-udp-services.md"
|
2019-11-08 14:44:47 +00:00
|
|
|
- Exposing FCGI services: "user-guide/fcgi-services.md"
|
2018-10-12 01:09:01 +00:00
|
|
|
- Regular expressions in paths: user-guide/ingress-path-matching.md
|
2018-09-13 16:28:16 +00:00
|
|
|
- External Articles: "user-guide/external-articles.md"
|
|
|
|
|
- Miscellaneous: "user-guide/miscellaneous.md"
|
|
|
|
|
- Prometheus and Grafana installation: "user-guide/monitoring.md"
|
|
|
|
|
- Multiple Ingress controllers: "user-guide/multiple-ingress.md"
|
|
|
|
|
- TLS/HTTPS: "user-guide/tls.md"
|
|
|
|
|
- Third party addons:
|
|
|
|
|
- ModSecurity Web Application Firewall: "user-guide/third-party-addons/modsecurity.md"
|
|
|
|
|
- OpenTracing: "user-guide/third-party-addons/opentracing.md"
|
|
|
|
|
- Examples:
|
|
|
|
|
- Introduction: "examples/index.md"
|
|
|
|
|
- Prerequisites: "examples/PREREQUISITES.md"
|
|
|
|
|
- Sticky Sessions: "examples/affinity/cookie/README.md"
|
|
|
|
|
- Auth:
|
|
|
|
|
- Basic Authentication: "examples/auth/basic/README.md"
|
|
|
|
|
- Client Certificate Authentication: "examples/auth/client-certs/README.md"
|
|
|
|
|
- External Basic Authentication: "examples/auth/external-auth/README.md"
|
|
|
|
|
- External OAUTH Authentication: "examples/auth/oauth-external-auth/README.md"
|
|
|
|
|
- Customization:
|
|
|
|
|
- Configuration Snippets: "examples/customization/configuration-snippets/README.md"
|
|
|
|
|
- Custom Configuration: "examples/customization/custom-configuration/README.md"
|
|
|
|
|
- Custom Errors: "examples/customization/custom-errors/README.md"
|
|
|
|
|
- Custom Headers: "examples/customization/custom-headers/README.md"
|
|
|
|
|
- External authentication: "examples/customization/external-auth-headers/README.md"
|
|
|
|
|
- Custom DH parameters for perfect forward secrecy: "examples/customization/ssl-dh-param/README.md"
|
|
|
|
|
- Sysctl tuning: "examples/customization/sysctl/README.md"
|
|
|
|
|
- Docker registry: "examples/docker-registry/README.md"
|
|
|
|
|
- gRPC: "examples/grpc/README.md"
|
|
|
|
|
- Multi TLS certificate termination: "examples/multi-tls/README.md"
|
|
|
|
|
- Rewrite: "examples/rewrite/README.md"
|
|
|
|
|
- Static IPs: "examples/static-ip/README.md"
|
|
|
|
|
- TLS termination: "examples/tls-termination/README.md"
|
2019-07-29 12:05:36 +00:00
|
|
|
- Pod Security Policy (PSP): "examples/psp/README.md"
|
