forked from kubernetes/ingress-nginx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
94 lines (89 loc) · 4.01 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
site_name: NGINX Ingress Controller
strict: true
repo_name: "kubernetes/ingress-nginx"
repo_url: https://github.com/kubernetes/ingress-nginx
site_url: https://kubernetes.github.io/ingress-nginx
markdown_extensions:
- admonition
- codehilite
- pymdownx.inlinehilite
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.superfences
- meta
- toc:
# insert a blank space before the character
permalink: " ¶"
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"
- Exposing FCGI services: "user-guide/fcgi-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"
- Pod Security Policy (PSP): "examples/psp/README.md"