ingress-nginx-helm/mkdocs.yml
Thibault Jamet 1cd17cd12c
Implement a validation webhook
In case some ingress have a syntax error in the snippet configuration,
the freshly generated configuration will not be reloaded to prevent tearing down existing rules.
Although, once inserted, this configuration is preventing from any other valid configuration to be inserted as it remains in the ingresses of the cluster.
To solve this problem, implement an optional validation webhook that simulates the addition of the ingress to be added together with the rest of ingresses.
In case the generated configuration is not validated by nginx, deny the insertion of the ingress.

In case certificates are mounted using kubernetes secrets, when those
changes, keys are automatically updated in the container volume, and the
controller reloads it using the filewatcher.

Related changes:

- Update vendors
- Extract useful functions to check configuration with an additional ingress
- Update documentation for validating webhook
- Add validating webhook examples
- Add a metric for each syntax check success and errors
- Add more certificate generation examples
2019-04-18 19:07:04 +02:00

88 lines
3.8 KiB
YAML

site_name: NGINX Ingress Controller
strict: true
repo_name: "kubernetes/ingress-nginx"
repo_url: "https://github.com/kubernetes/ingress-nginx"
markdown_extensions:
- admonition
- codehilite
- pymdownx.inlinehilite
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.superfences
- toc:
permalink: true
theme:
name: material
feature:
tabs: true
logo:
icon: "public" # globe icon
palette:
primary: "teal"
accent: "green"
include_sidebar: true
plugins:
- search
extra_css: [extra.css]
google_analytics: ["UA-118407822-1", "kubernetes.github.io"]
nav:
- Welcome:
- Welcome: "index.md"
- How it works: "how-it-works.md"
- Troubleshooting: "troubleshooting.md"
- kubectl plugin: "kubectl-plugin.md"
- Development: "development.md"
- Deployment:
- Installation Guide: "deploy/index.md"
- Bare-metal considerations: "deploy/baremetal.md"
- Role Based Access Control (RBAC): "deploy/rbac.md"
- Validating Webhook (admission controller): "deploy/validating-webhook.md"
- Upgrade: "deploy/upgrade.md"
- User guide:
- NGINX Configuration:
- Introduction: "user-guide/nginx-configuration/index.md"
- Basic usage: "user-guide/basic-usage.md"
- 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"
- Exposing TCP and UDP services: "user-guide/exposing-tcp-udp-services.md"
- Regular expressions in paths: user-guide/ingress-path-matching.md
- 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"