DevFW-CICD/ingress-nginx-helm
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3092 from aledbf/docs

Browse source 
Update mkdocs and travis-ci
This commit is contained in:
k8s-ci-robot 2018-09-13 16:03:14 -07:00 committed by GitHub
commit 74b1bca5df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 117 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
.travis.yml
View file

@ -44,36 +44,37 @@ jobs:
script: script:
- make cover - make cover
- stage: e2e - stage: e2e
if: (branch = master AND env(COMPONENT) != "docs") OR (type = pull_request AND commit_message !~ /(skip-e2e)/)
before_script: before_script:
- test/e2e/up.sh - test/e2e/up.sh
script: script:
- make e2e-test - make e2e-test
# split builds to avoid job timeouts # split builds to avoid job timeouts
- stage: publish amd64 - stage: publish amd64
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "ingress-controller"
script: script:
- .travis/publish.sh amd64 - .travis/publish.sh amd64
- stage: publish arm - stage: publish arm
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "ingress-controller"
script: script:
- make register-qemu - make register-qemu
- .travis/publish.sh arm - .travis/publish.sh arm
- stage: publish arm64 - stage: publish arm64
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "ingress-controller"
script: script:
- make register-qemu - make register-qemu
- .travis/publish.sh arm64 - .travis/publish.sh arm64
- stage: publish ppc64le - stage: publish ppc64le
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "ingress-controller"
script: script:
- make register-qemu - make register-qemu
- .travis/publish.sh ppc64le - .travis/publish.sh ppc64le
- stage: publish s390x - stage: publish s390x
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "ingress-controller"
script: script:
- make register-qemu - make register-qemu
- .travis/publish.sh s390x - .travis/publish.sh s390x
- stage: Publish docs - stage: Publish docs
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx if: type = api AND branch = master AND repo = kubernetes/ingress-nginx AND env(COMPONENT) = "docs"
script: script:
- .travis/publish-docs.sh - .travis/publish-docs.sh

3
.travis/publish.sh
View file

@ -38,9 +38,6 @@ case "$COMPONENT" in
"ingress-controller") "ingress-controller")
$DIR/ingress-controller.sh $DIR/ingress-controller.sh
;; ;;
"nginx")
$DIR/nginx.sh
;;
*) *)
echo "Invalid option in environment variable COMPONENT" echo "Invalid option in environment variable COMPONENT"
exit 1 exit 1

6
docs/.pages
View file

@ -1,6 +0,0 @@
arrange:
- index.md
- deploy
- user-guide
- examples
- ...

1
docs/deploy/.pages
View file

@ -1 +0,0 @@
title: Deployment

3
docs/user-guide/.pages
View file

@ -1,3 +0,0 @@
arrange:
- nginx-configuration
- ...

83
docs/user-guide/cli-arguments.md
View file

@ -2,48 +2,47 @@
The following command line arguments are accepted by the Ingress controller executable. The following command line arguments are accepted by the Ingress controller executable.
They are set in the container spec of the `nginx-ingress-controller` Deployment manifest (see `deploy/with-rbac.yaml` or `deploy/without-rbac.yaml`). They are set in the container spec of the `nginx-ingress-controller` Deployment manifest
| Argument | Description | | Argument | Description |
|----------|-------------| |----------|-------------|
| --alsologtostderr | log to standard error as well as files | | `--alsologtostderr` | log to standard error as well as files |
| --annotations-prefix string | Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io") | | `--annotations-prefix string` | Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io") |
| --apiserver-host string | Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted. | | `--apiserver-host string` | Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted. |
| --configmap string | Name of the ConfigMap containing custom global configurations for the controller. | | `--configmap string` | Name of the ConfigMap containing custom global configurations for the controller. |
| --default-backend-service string | Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service. | | `--default-backend-service string` | Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service. |
| --default-server-port int | Port to use for exposing the default server (catch-all). (default 8181) | | `--default-server-port int` | Port to use for exposing the default server (catch-all). (default 8181) |
| --default-ssl-certificate string | Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name". | | `--default-ssl-certificate string` | Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name". |
| --election-id string | Election id to use for Ingress status updates. (default "ingress-controller-leader") | | `--election-id string` | Election id to use for Ingress status updates. (default "ingress-controller-leader") |
| --enable-dynamic-configuration | Dynamically refresh backends on topology changes instead of reloading NGINX. Feature backed by OpenResty Lua libraries. (enabled by default) | | `--enable-dynamic-certificates` | Dynamically serves certificates instead of reloading NGINX when certificates are created, updated, or deleted. Currently does not support OCSP stapling, so --enable-ssl-chain-completion must be turned off. Assuming the certificate is generated with a 2048 bit RSA key/cert pair, this feature can store roughly 5000 certificates. This is an experiemental feature that currently is not ready for production use. Feature backed by OpenResty Lua libraries. (disabled by default) |
| --enable-dynamic-certificates | Dynamically serves certificates instead of reloading NGINX when certificates are created, updated, or deleted. Currently does not support OCSP stapling, so --enable-ssl-chain-completion must be turned off. Assuming the certificate is generated with a 2048 bit RSA key/cert pair, this feature can store roughly 5000 certificates. This is an experiemental feature that currently is not ready for production use. Feature backed by OpenResty Lua libraries. (disabled by default) | | `--enable-dynamic-configuration` | Dynamically refresh backends on topology changes instead of reloading NGINX. Feature backed by OpenResty Lua libraries. (default true) |
| --enable-ssl-chain-completion | Autocomplete SSL certificate chains with missing intermediate CA certificates. A valid certificate chain is required to enable OCSP stapling. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default true) | | `--enable-ssl-chain-completion` | Autocomplete SSL certificate chains with missing intermediate CA certificates. A valid certificate chain is required to enable OCSP stapling. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default true) |
| --enable-ssl-passthrough | Enable SSL Passthrough. | | `--enable-ssl-passthrough` | Enable SSL Passthrough. |
| --force-namespace-isolation | Force namespace isolation. Prevents Ingress objects from referencing Secrets and ConfigMaps located in a different namespace than their own. May be used together with watch-namespace. | | `--force-namespace-isolation` | Force namespace isolation. Prevents Ingress objects from referencing Secrets and ConfigMaps located in a different namespace than their own. May be used together with watch-namespace. |
| --health-check-path string | URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz") | | `--health-check-path string` | URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz") |
| --healthz-port int | Port to use for the healthz endpoint. (default 10254) | | `--healthz-port int` | Port to use for the healthz endpoint. (default 10254) |
| --http-port int | Port to use for servicing HTTP traffic. (default 80) | | `--http-port int` | Port to use for servicing HTTP traffic. (default 80) |
| --https-port int | Port to use for servicing HTTPS traffic. (default 443) | | `--https-port int` | Port to use for servicing HTTPS traffic. (default 443) |
| --ingress-class string | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the annotation "kubernetes.io/ingress.class". All ingress classes are satisfied if this parameter is left empty. | | `--ingress-class string` | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the annotation "kubernetes.io/ingress.class". All ingress classes are satisfied if this parameter is left empty. |
| --kubeconfig string | Path to a kubeconfig file containing authorization and API server information. | | `--kubeconfig string` | Path to a kubeconfig file containing authorization and API server information. |
| --log_backtrace_at traceLocation | when logging hits line file:N, emit a stack trace (default :0) | | `--log_backtrace_at traceLocation` | when logging hits line file:N, emit a stack trace (default :0) |
| --log_dir string | If non-empty, write log files in this directory | | `--log_dir string` | If non-empty, write log files in this directory |
| --logtostderr | log to standard error instead of files (default true) | | `--logtostderr` | log to standard error instead of files (default true) |
| --profiling | Enable profiling via web interface host:port/debug/pprof/ (default true) | | `--profiling` | Enable profiling via web interface host:port/debug/pprof/ (default true) |
| --publish-service string | Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it satisfies. | | `--publish-service string` | Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it satisfies. |
| --publish-status-address string | Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter. | | `--publish-status-address string` | Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter. |
| --report-node-internal-ip-address | Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter. | | `--report-node-internal-ip-address` | Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter. |
| --sort-backends | Sort servers inside NGINX upstreams. | | `--sort-backends` | Sort servers inside NGINX upstreams. |
| --ssl-passthrough-proxy-port int | Port to use internally for SSL Passthrough. (default 442) | | `--ssl-passthrough-proxy-port int` | Port to use internally for SSL Passthrough. (default 442) |
| --status-port int | Port to use for exposing NGINX status pages. (default 18080) | | `--status-port int` | Port to use for exposing NGINX status pages. (default 18080) |
| --stderrthreshold severity | logs at or above this threshold go to stderr (default 2) | | `--stderrthreshold severity` | logs at or above this threshold go to stderr (default 2) |
| --sync-period duration | Period at which the controller forces the repopulation of its local object stores. (default is 0) | | `--sync-period duration` | Period at which the controller forces the repopulation of its local object stores. Disabled by default. |
| --sync-rate-limit float32 | Define the sync frequency upper limit (default 0.3) | | `--sync-rate-limit float32` | Define the sync frequency upper limit (default 0.3) |
| --tcp-services-configmap string | Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic. | | `--tcp-services-configmap string` | Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic. |
| --udp-services-configmap string | Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number. | `--udp-services-configmap string` | Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number. |
| --update-status | Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true) | | `--update-status` | Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true) |
| --update-status-on-shutdown | Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true) | | `--update-status-on-shutdown` | Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true) |
| --v Level | log level for V logs | | `-v`, `--v Level` | log level for V logs |
| --version | Show release information about the NGINX Ingress controller and exit. | | `--version` | Show release information about the NGINX Ingress controller and exit. |
| --vmodule moduleSpec | comma-separated list of pattern=N settings for file-filtered logging | | `--vmodule moduleSpec` | comma-separated list of pattern=N settings for file-filtered logging |
| --watch-namespace string | Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty. | | `--watch-namespace string` | Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty. |

0
docs/user-guide/convert_arguments_to_doc.py Normal file → Executable file
View file

1
docs/user-guide/nginx-configuration/.pages
View file

@ -1 +0,0 @@
title: NGINX Configuration

2
docs/user-guide/nginx-configuration/configmap.md
View file

@ -3,7 +3,7 @@
ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable. ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable.
The ConfigMap API resource stores configuration data as key-value pairs. The data provides the configurations for system The ConfigMap API resource stores configuration data as key-value pairs. The data provides the configurations for system
components for the nginx-controller. Before you can begin using a config-map it must be [deployed](../../deploy/README.md/#deploying-the-config-map). components for the nginx-controller.
In order to overwrite nginx-controller configuration values as seen in [config.go](https://github.com/kubernetes/ingress-nginx/blob/master/internal/ingress/controller/config/config.go), In order to overwrite nginx-controller configuration values as seen in [config.go](https://github.com/kubernetes/ingress-nginx/blob/master/internal/ingress/controller/config/config.go),
you can add key-value pairs to the data section of the config-map. For Example: you can add key-value pairs to the data section of the config-map. For Example:

73
mkdocs.yml
View file

@ -1,7 +1,7 @@
site_name: NGINX Ingress Controller site_name: NGINX Ingress Controller
strict: true strict: true
repo_name: 'kubernetes/ingress-nginx' repo_name: "kubernetes/ingress-nginx"
repo_url: 'https://github.com/kubernetes/ingress-nginx' repo_url: "https://github.com/kubernetes/ingress-nginx"
markdown_extensions: markdown_extensions:
- admonition - admonition
- codehilite - codehilite
@ -15,13 +15,70 @@ theme:
feature: feature:
tabs: true tabs: true
logo: logo:
icon: 'public' # globe icon icon: "public" # globe icon
palette: palette:
primary: 'teal' primary: "teal"
accent: 'green' accent: "green"
include_sidebar: true
plugins: plugins:
- search - search
- awesome-pages:
collapse_single_pages: true
extra_css: [extra.css] extra_css: [extra.css]
google_analytics: ['UA-118407822-1', 'kubernetes.github.io']
google_analytics: ["UA-118407822-1", "kubernetes.github.io"]
pages:
- Welcome:
- Welcome: "index.md"
- How it works: 'how-it-works.md'
- Troubleshooting: 'troubleshooting.md'
- Development: 'development.md'
- Deployment:
- Installation Guide: "deploy/index.md"
- Bare-metal considerations: "deploy/baremetal.md"
- Role Based Access Control (RBAC): "deploy/rbac.md"
- Upgrade: "deploy/upgrade.md"
- User guide:
- NGINX Configuration:
- Introduction: "user-guide/nginx-configuration/index.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"
- 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"
- Custom Upstream server checks: "examples/customization/custom-upstream-check/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"

7
requirements-docs.txt
View file

@ -1,5 +1,4 @@
mkdocs-material~=2.9.0 mkdocs-material~=3.0.4
mkdocs-awesome-pages-plugin~=1.2.0 mkdocs~=1.0.4
mkdocs~=0.17.0 pymdown-extensions~=5.0
pygments~=2.2.0 pygments~=2.2.0
pymdown-extensions~=4.10