From aa19bb451f3f7dee46e66f8ffbd98f7143a0518e Mon Sep 17 00:00:00 2001 From: Dean Coakley Date: Fri, 20 Nov 2020 18:06:29 +0000 Subject: [PATCH] Release 1.9.1 --- CHANGELOG.md | 16 +++++++++ Makefile | 2 +- README.md | 4 +-- deployments/daemon-set/nginx-ingress.yaml | 2 +- .../daemon-set/nginx-plus-ingress.yaml | 2 +- deployments/deployment/nginx-ingress.yaml | 2 +- .../deployment/nginx-plus-ingress.yaml | 2 +- deployments/helm-chart/Chart.yaml | 8 ++--- deployments/helm-chart/README.md | 4 +-- deployments/helm-chart/values-icp.yaml | 2 +- deployments/helm-chart/values-plus.yaml | 2 +- deployments/helm-chart/values.yaml | 2 +- docs-web/app-protect/configuration.md | 4 +-- docs-web/app-protect/installation.md | 2 +- .../configuration/configuration-examples.md | 4 +-- .../configmap-resource.md | 22 ++++++------ .../global-configuration/custom-templates.md | 2 +- ...advanced-configuration-with-annotations.md | 36 +++++++++---------- .../ingress-resources/basic-configuration.md | 2 +- .../cross-namespace-configuration.md | 4 +-- .../ingress-resources/custom-annotations.md | 4 +-- docs-web/configuration/policy-resource.md | 2 +- .../configuration/transportserver-resource.md | 4 +-- ...server-and-virtualserverroute-resources.md | 6 ++-- .../building-ingress-controller-image.md | 6 ++-- .../installation/installation-with-helm.md | 4 +-- .../installation-with-manifests.md | 2 +- .../installation-with-operator.md | 2 +- docs-web/releases.md | 18 ++++++++++ docs-web/technical-specifications.md | 6 ++-- docs-web/third-party-modules/opentracing.md | 2 +- 31 files changed, 107 insertions(+), 73 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c2ebfeae9d..a50e7cb823 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog +### 1.9.1 + +CHANGES: +* Fix deployment of ingressclass resource via helm on some versions of Kubernetes. +* Update the base ubi images to 8.3. +* Renew CA cert for egress-mtls example. +* Add `controller.serviceAccount.imagePullSecretName` parameter to the helm chart. **Note**: `controller.serviceAccount.imagePullSecrets` is deprecated and will be removed in the future `1.10.0` release. + +HELM CHART: +* The version of the Helm chart is now 0.7.1. + +UPGRADE: +* For NGINX, use the 1.9.1 image from our DockerHub: `nginx/nginx-ingress:1.9.1`, `nginx/nginx-ingress:1.9.1-alpine` or `nginx/nginx-ingress:1.9.1-ubi` +* For NGINX Plus, please build your own image using the 1.9.1 source code. +* For Helm, use version 0.7.1 of the chart. + ### 1.9.0 OVERVIEW: diff --git a/Makefile b/Makefile index ebecfc3bd9..909bbdd1be 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ all: push -VERSION = 1.9.0 +VERSION = 1.9.1 TAG = $(VERSION) PREFIX = nginx/nginx-ingress diff --git a/README.md b/README.md index 08ef403b10..6605293314 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Read [this doc](docs/nginx-plus.md) to learn more about NGINX Ingress controller We publish Ingress controller releases on GitHub. See our [releases page](https://github.com/nginxinc/kubernetes-ingress/releases). -The latest stable release is [1.9.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v1.9.0). For production use, we recommend that you choose the latest stable release. As an alternative, you can choose the *edge* version built from the [latest commit](https://github.com/nginxinc/kubernetes-ingress/commits/master) from the master branch. The edge version is useful for experimenting with new features that are not yet published in a stable release. +The latest stable release is [1.9.1](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v1.9.1). For production use, we recommend that you choose the latest stable release. As an alternative, you can choose the *edge* version built from the [latest commit](https://github.com/nginxinc/kubernetes-ingress/commits/master) from the master branch. The edge version is useful for experimenting with new features that are not yet published in a stable release. To use the Ingress controller, you need to have access to: * An Ingress controller image. @@ -66,7 +66,7 @@ The table below summarizes the options regarding the images, manifests, helm cha | Version | Description | Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples | | ------- | ----------- | --------------- | -------------------- | ---------------------------------------| -------------------------- | -| Latest stable release | For production use | `nginx/nginx-ingress:1.9.0`, `nginx/nginx-ingress:1.9.0-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/deployments/helm-chart). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | +| Latest stable release | For production use | `nginx/nginx-ingress:1.9.1`, `nginx/nginx-ingress:1.9.1-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/deployments/helm-chart). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | | Edge | For testing and experimenting | `nginx/nginx-ingress:edge`, `nginx/nginx-ingress:edge-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs-web/installation/building-ingress-controller-image.md). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs-web/installation/building-ingress-controller-image.md). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs-web). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples). | ## Contacts diff --git a/deployments/daemon-set/nginx-ingress.yaml b/deployments/daemon-set/nginx-ingress.yaml index 1a5ba65e68..95cde58602 100644 --- a/deployments/daemon-set/nginx-ingress.yaml +++ b/deployments/daemon-set/nginx-ingress.yaml @@ -17,7 +17,7 @@ spec: spec: serviceAccountName: nginx-ingress containers: - - image: nginx/nginx-ingress:1.9.0 + - image: nginx/nginx-ingress:1.9.1 imagePullPolicy: IfNotPresent name: nginx-ingress ports: diff --git a/deployments/daemon-set/nginx-plus-ingress.yaml b/deployments/daemon-set/nginx-plus-ingress.yaml index f28c130a7d..735815a95c 100644 --- a/deployments/daemon-set/nginx-plus-ingress.yaml +++ b/deployments/daemon-set/nginx-plus-ingress.yaml @@ -17,7 +17,7 @@ spec: spec: serviceAccountName: nginx-ingress containers: - - image: nginx-plus-ingress:1.9.0 + - image: nginx-plus-ingress:1.9.1 imagePullPolicy: IfNotPresent name: nginx-plus-ingress ports: diff --git a/deployments/deployment/nginx-ingress.yaml b/deployments/deployment/nginx-ingress.yaml index 05279e3d4c..9573a0c715 100644 --- a/deployments/deployment/nginx-ingress.yaml +++ b/deployments/deployment/nginx-ingress.yaml @@ -18,7 +18,7 @@ spec: spec: serviceAccountName: nginx-ingress containers: - - image: nginx/nginx-ingress:1.9.0 + - image: nginx/nginx-ingress:1.9.1 imagePullPolicy: IfNotPresent name: nginx-ingress ports: diff --git a/deployments/deployment/nginx-plus-ingress.yaml b/deployments/deployment/nginx-plus-ingress.yaml index bb60f9a05d..5c6274647e 100644 --- a/deployments/deployment/nginx-plus-ingress.yaml +++ b/deployments/deployment/nginx-plus-ingress.yaml @@ -18,7 +18,7 @@ spec: spec: serviceAccountName: nginx-ingress containers: - - image: nginx-plus-ingress:1.9.0 + - image: nginx-plus-ingress:1.9.1 imagePullPolicy: IfNotPresent name: nginx-plus-ingress ports: diff --git a/deployments/helm-chart/Chart.yaml b/deployments/helm-chart/Chart.yaml index 05ce1aa6d9..b8e7203511 100644 --- a/deployments/helm-chart/Chart.yaml +++ b/deployments/helm-chart/Chart.yaml @@ -1,12 +1,12 @@ name: nginx-ingress -version: 0.7.0 -appVersion: 1.9.0 +version: 0.7.1 +appVersion: 1.9.1 apiVersion: v1 kubeVersion: ">= 1.14.0-0" description: NGINX Ingress Controller -icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v1.9.0/deployments/helm-chart/chart-icon.png +icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v1.9.1/deployments/helm-chart/chart-icon.png sources: - - https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/deployments/helm-chart + - https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/deployments/helm-chart keywords: - ingress - nginx diff --git a/deployments/helm-chart/README.md b/deployments/helm-chart/README.md index 7d0640ae18..f3b0e71f73 100644 --- a/deployments/helm-chart/README.md +++ b/deployments/helm-chart/README.md @@ -24,7 +24,7 @@ This step is required if you're installing the chart using its sources. Addition 2. Change your working directory to /deployments/helm-chart: ```console $ cd kubernetes-ingress/deployments/helm-chart - $ git checkout v1.9.0 + $ git checkout v1.9.1 ``` ## Adding the Helm Repository @@ -195,7 +195,7 @@ Parameter | Description | Default `controller.nginxDebug` | Enables debugging for NGINX. Uses the `nginx-debug` binary. Requires `error-log-level: debug` in the ConfigMap via `controller.config.entries`. | false `controller.logLevel` | The log level of the Ingress Controller. | 1 `controller.image.repository` | The image repository of the Ingress controller. | nginx/nginx-ingress -`controller.image.tag` | The tag of the Ingress controller image. | 1.9.0 +`controller.image.tag` | The tag of the Ingress controller image. | 1.9.1 `controller.image.pullPolicy` | The pull policy for the Ingress controller image. | IfNotPresent `controller.config.name` | The name of the ConfigMap used by the Ingress controller. | Autogenerated `controller.config.annotations` | The annotations of the Ingress controller configmap. | {} diff --git a/deployments/helm-chart/values-icp.yaml b/deployments/helm-chart/values-icp.yaml index daee4f5aa2..852ce468eb 100644 --- a/deployments/helm-chart/values-icp.yaml +++ b/deployments/helm-chart/values-icp.yaml @@ -3,7 +3,7 @@ controller: nginxplus: true image: repository: mycluster.icp:8500/kube-system/nginx-plus-ingress - tag: "1.9.0" + tag: "1.9.1" nodeSelector: beta.kubernetes.io/arch: "amd64" proxy: true diff --git a/deployments/helm-chart/values-plus.yaml b/deployments/helm-chart/values-plus.yaml index 5c89abd212..faed6c2206 100644 --- a/deployments/helm-chart/values-plus.yaml +++ b/deployments/helm-chart/values-plus.yaml @@ -2,4 +2,4 @@ controller: nginxplus: true image: repository: nginx-plus-ingress - tag: "1.9.0" + tag: "1.9.1" diff --git a/deployments/helm-chart/values.yaml b/deployments/helm-chart/values.yaml index 084f0dc9a7..8b15becbbb 100644 --- a/deployments/helm-chart/values.yaml +++ b/deployments/helm-chart/values.yaml @@ -36,7 +36,7 @@ controller: repository: nginx/nginx-ingress ## The tag of the Ingress controller image. - tag: "1.9.0" + tag: "1.9.1" ## The pull policy for the Ingress controller image. pullPolicy: IfNotPresent diff --git a/docs-web/app-protect/configuration.md b/docs-web/app-protect/configuration.md index 3d404356e9..951a6be4c0 100644 --- a/docs-web/app-protect/configuration.md +++ b/docs-web/app-protect/configuration.md @@ -1,12 +1,12 @@ # Configuration This document describes how to configure the NGINX App Protect module -> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/appprotect). +> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/appprotect). ## Global Configuration The NGINX Ingress Controller has a set of global configuration parameters that align with those available in the NGINX App Protect module. See [ConfigMap keys](/nginx-ingress-controller/configuration/global-configuration/configmap-resource/#modules) for the complete list. The App Protect parameters use the `app-protect*` prefix. -> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/appprotect). +> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/appprotect). ## Enable App Protect for an Ingress Resource diff --git a/docs-web/app-protect/installation.md b/docs-web/app-protect/installation.md index b03d1ddccd..59115bfb37 100644 --- a/docs-web/app-protect/installation.md +++ b/docs-web/app-protect/installation.md @@ -36,5 +36,5 @@ Take the steps below to set up and deploy the NGINX Ingress Controller and App P 3. Enable the App Protect module by adding the `enable-app-protect` [cli argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-enable-app-protect) to your Deployment or DaemonSet file. 4. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests/#deploy-the-ingress-controller). -For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect/configuration) and the [NGINX Ingress Controller with App Protect examples on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/appprotect). +For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect/configuration) and the [NGINX Ingress Controller with App Protect examples on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/appprotect). diff --git a/docs-web/configuration/configuration-examples.md b/docs-web/configuration/configuration-examples.md index 67b1cfb34d..4951ecb6ec 100644 --- a/docs-web/configuration/configuration-examples.md +++ b/docs-web/configuration/configuration-examples.md @@ -1,5 +1,5 @@ # Configuration Examples Our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress) includes a number of configuration examples: -* [*Examples*](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples) show how to use advanced NGINX features in Ingress resources with annotations. -* [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples-of-custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases. +* [*Examples*](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples) show how to use advanced NGINX features in Ingress resources with annotations. +* [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples-of-custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases. diff --git a/docs-web/configuration/global-configuration/configmap-resource.md b/docs-web/configuration/global-configuration/configmap-resource.md index 045be77b1e..d68e83f865 100644 --- a/docs-web/configuration/global-configuration/configmap-resource.md +++ b/docs-web/configuration/global-configuration/configmap-resource.md @@ -149,19 +149,19 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres * - ``resolver-addresses`` - Sets the value of the `resolver `_ addresses. Note: If you use a DNS name (ex., ``kube-dns.kube-system.svc.cluster.local``\ ) as a resolver address, NGINX Plus will resolve it using the system resolver during the start and on every configuration reload. As a consequence, If the name cannot be resolved or the DNS server doesn't respond, NGINX Plus will fail to start or reload. To avoid this, consider using only IP addresses as resolver addresses. Supported in NGINX Plus only. - N/A - - `Support for Type ExternalName Services `_. + - `Support for Type ExternalName Services `_. * - ``resolver-ipv6`` - Enables IPv6 resolution in the resolver. Supported in NGINX Plus only. - ``True`` - - `Support for Type ExternalName Services `_. + - `Support for Type ExternalName Services `_. * - ``resolver-valid`` - Sets the time NGINX caches the resolved DNS records. Supported in NGINX Plus only. - TTL value of a DNS record - - `Support for Type ExternalName Services `_. + - `Support for Type ExternalName Services `_. * - ``resolver-timeout`` - Sets the `resolver_timeout `_ for name resolution. Supported in NGINX Plus only. - ``30s`` - - `Support for Type ExternalName Services `_. + - `Support for Type ExternalName Services `_. * - ``keepalive-timeout`` - Sets the value of the `keepalive_timeout `_ directive. - ``65s`` @@ -204,7 +204,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres - * - ``log-format`` - Sets the custom `log format `_ for HTTP and HTTPS traffic. For convenience, it is possible to define the log format across multiple lines (each line separated by ``\n``). In that case, the Ingress Controller will replace every ``\n`` character with a space character. All ``'`` characters must be escaped. - - See the `template file `_ for the access log. + - See the `template file `_ for the access log. - * - ``log-format-escaping`` - Sets the characters escaping for the variables of the log format. Supported values: ``json`` (JSON escaping), ``default`` (the default escaping) ``none`` (disables escaping). @@ -212,7 +212,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres - * - ``stream-log-format`` - Sets the custom `log format `_ for TCP, UDP, and TLS Passthrough traffic. For convenience, it is possible to define the log format across multiple lines (each line separated by ``\n``). In that case, the Ingress Controller will replace every ``\n`` character with a space character. All ``'`` characters must be escaped. - - See the `template file `_. + - See the `template file `_. - * - ``stream-log-format-escaping`` - Sets the characters escaping for the variables of the stream log format. Supported values: ``json`` (JSON escaping), ``default`` (the default escaping) ``none`` (disables escaping). @@ -309,7 +309,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres * - ``proxy-protocol`` - Enables PROXY Protocol for incoming connections. - ``False`` - - `Proxy Protocol `_. + - `Proxy Protocol `_. ``` ### Backend Services (Upstreams) @@ -373,7 +373,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres * - ``stream-snippets`` - Sets a custom snippet in stream context. - N/A - - `Support for TCP/UDP Load Balancing `_. + - `Support for TCP/UDP Load Balancing `_. * - ``main-template`` - Sets the main NGINX configuration template. - By default the template is read from the file in the container. @@ -401,15 +401,15 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres * - ``opentracing`` - Enables `OpenTracing `_ globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Note: requires the Ingress Controller image with OpenTracing module and a tracer. See the `docs `_ for more information. - ``False`` - - `Support for OpenTracing `_. + - `Support for OpenTracing `_. * - ``opentracing-tracer`` - Sets the path to the vendor tracer binary plugin. - N/A - - `Support for OpenTracing `_. + - `Support for OpenTracing `_. * - ``opentracing-tracer-config`` - Sets the tracer configuration in JSON format. - N/A - - `Support for OpenTracing `_. + - `Support for OpenTracing `_. * - ``app-protect-cookie-seed`` - Sets the ``app_protect_cookie_seed`` `global directive `_. - Random automatically generated string diff --git a/docs-web/configuration/global-configuration/custom-templates.md b/docs-web/configuration/global-configuration/custom-templates.md index 7bca770178..ac17d9dc04 100644 --- a/docs-web/configuration/global-configuration/custom-templates.md +++ b/docs-web/configuration/global-configuration/custom-templates.md @@ -1,3 +1,3 @@ # Custom Templates -The Ingress Controller uses templates to generate NGINX configuration for Ingress resources, VirtualServer resources and the main NGINX configuration file. You can customize the templates and apply them via the ConfigMap. See the [corresponding example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/custom-templates). +The Ingress Controller uses templates to generate NGINX configuration for Ingress resources, VirtualServer resources and the main NGINX configuration file. You can customize the templates and apply them via the ConfigMap. See the [corresponding example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/custom-templates). diff --git a/docs-web/configuration/ingress-resources/advanced-configuration-with-annotations.md b/docs-web/configuration/ingress-resources/advanced-configuration-with-annotations.md index b0498fe27f..03313a4d4e 100644 --- a/docs-web/configuration/ingress-resources/advanced-configuration-with-annotations.md +++ b/docs-web/configuration/ingress-resources/advanced-configuration-with-annotations.md @@ -146,7 +146,7 @@ The table below summarizes the available annotations. - N/A - Configures URI rewriting. - N/A - - `Rewrites Support `_. + - `Rewrites Support `_. ``` ### Auth and SSL/TLS @@ -194,22 +194,22 @@ The table below summarizes the available annotations. - N/A - Specifies a Secret resource with keys for validating JSON Web Tokens (JWTs). - N/A - - `Support for JSON Web Tokens (JWTs) `_. + - `Support for JSON Web Tokens (JWTs) `_. * - ``nginx.com/jwt-realm`` - N/A - Specifies a realm. - N/A - - `Support for JSON Web Tokens (JWTs) `_. + - `Support for JSON Web Tokens (JWTs) `_. * - ``nginx.com/jwt-token`` - N/A - Specifies a variable that contains JSON Web Token. - By default, a JWT is expected in the ``Authorization`` header as a Bearer Token. - - `Support for JSON Web Tokens (JWTs) `_. + - `Support for JSON Web Tokens (JWTs) `_. * - ``nginx.com/jwt-login-url`` - N/A - Specifies a URL to which a client is redirected in case of an invalid or missing JWT. - N/A - - `Support for JSON Web Tokens (JWTs) `_. + - `Support for JSON Web Tokens (JWTs) `_. ``` ### Listeners @@ -255,17 +255,17 @@ The table below summarizes the available annotations. - N/A - Enables HTTPS or gRPC over SSL when connecting to the endpoints of services. - N/A - - `SSL Services Support `_. + - `SSL Services Support `_. * - ``nginx.org/grpc-services`` - N/A - Enables gRPC for services. Note: requires HTTP/2 (see ``http2`` ConfigMap key); only works for Ingresses with TLS termination enabled. - N/A - - `GRPC Services Support `_. + - `GRPC Services Support `_. * - ``nginx.org/websocket-services`` - N/A - Enables WebSocket for services. - N/A - - `WebSocket support `_. + - `WebSocket support `_. * - ``nginx.org/max-fails`` - ``max-fails`` - Sets the value of the `max_fails `_ parameter of the ``server`` directive. @@ -290,7 +290,7 @@ The table below summarizes the available annotations. - N/A - Configures session persistence. - N/A - - `Session Persistence `_. + - `Session Persistence `_. * - ``nginx.org/keepalive`` - ``keepalive`` - Sets the value of the `keepalive `_ directive. Note that ``proxy_set_header Connection "";`` is added to the generated configuration when the value > 0. @@ -300,20 +300,20 @@ The table below summarizes the available annotations. - N/A - Enables active health checks. - ``False`` - - `Support for Active Health Checks `_. + - `Support for Active Health Checks `_. * - ``nginx.com/health-checks-mandatory`` - N/A - Configures active health checks as mandatory. - ``False`` - - `Support for Active Health Checks `_. + - `Support for Active Health Checks `_. * - ``nginx.com/health-checks-mandatory-queue`` - N/A - When active health checks are mandatory, configures a queue for temporary storing incoming requests during the time when NGINX Plus is checking the health of the endpoints after a configuration reload. - ``0`` - - `Support for Active Health Checks `_. + - `Support for Active Health Checks `_. * - ``nginx.com/slow-start`` - N/A - - Sets the upstream server `slow-start period `_. By default, slow-start is activated after a server becomes `available `_ or `healthy `_. To enable slow-start for newly added servers, configure `mandatory active health checks `_. + - Sets the upstream server `slow-start period `_. By default, slow-start is activated after a server becomes `available `_ or `healthy `_. To enable slow-start for newly added servers, configure `mandatory active health checks `_. - ``"0s"`` - ``` @@ -358,25 +358,25 @@ The table below summarizes the available annotations. - N/A - The name of the App Protect Policy for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace of the Ingress Resource is used. If not specified but ``appprotect.f5.com/app-protect-enable`` is true, a default policy id applied. If the referenced policy resource does not exist, or policy is invalid, this annotation will be ignored, and the default policy will be applied. - N/A - - `Example for App Protect `_. + - `Example for App Protect `_. * - ``appprotect.f5.com/app-protect-enable`` - N/A - Enable App Protect for the Ingress Resource. - ``False`` - - `Example for App Protect `_. + - `Example for App Protect `_. * - ``appprotect.f5.com/app-protect-security-log-enable`` - N/A - Enable the `security log `_ for App Protect. - ``False`` - - `Example for App Protect `_. + - `Example for App Protect `_. * - ``appprotect.f5.com/app-protect-security-log`` - N/A - The App Protect log configuration for the Ingress Resource. Format is ``namespace/name``. If no namespace is specified, the same namespace as the Ingress Resource is used. If not specified the default is used which is: filter: ``illegal``, format: ``default`` - N/A - - `Example for App Protect `_. + - `Example for App Protect `_. * - ``appprotect.f5.com/app-protect-security-log-destination`` - N/A - The destination of the security log. For more information check the `DESTINATION argument `_. - ``syslog:server=localhost:514`` - - `Example for App Protect `_. + - `Example for App Protect `_. ``` diff --git a/docs-web/configuration/ingress-resources/basic-configuration.md b/docs-web/configuration/ingress-resources/basic-configuration.md index e252468249..fd4a6aefbb 100644 --- a/docs-web/configuration/ingress-resources/basic-configuration.md +++ b/docs-web/configuration/ingress-resources/basic-configuration.md @@ -36,7 +36,7 @@ Here is a breakdown of what this Ingress resource definition means: * The rule with the path `/coffee` instructs NGINX to distribute the requests with the `/coffee` URI among the pods of the *coffee* service, which is deployed with the name `coffee‑svc` in the cluster. * Both rules instruct NGINX to distribute the requests to `port 80` of the corresponding service (the `servicePort` field). -> For complete instructions on deploying the Ingress and Secret resources in the cluster, see the [complete-example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/complete-example) in our GitHub repo. +> For complete instructions on deploying the Ingress and Secret resources in the cluster, see the [complete-example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/complete-example) in our GitHub repo. > To learn more about the Ingress resource, see the [Ingress resource documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) in the Kubernetes docs. diff --git a/docs-web/configuration/ingress-resources/cross-namespace-configuration.md b/docs-web/configuration/ingress-resources/cross-namespace-configuration.md index 0b1dfa3453..3370680164 100644 --- a/docs-web/configuration/ingress-resources/cross-namespace-configuration.md +++ b/docs-web/configuration/ingress-resources/cross-namespace-configuration.md @@ -1,5 +1,5 @@ # Cross-namespace Configuration -You can spread the Ingress configuration for a common host across multiple Ingress resources using Mergeable Ingress resources. Such resources can belong to the *same* or *different* namespaces. This enables easier management when using a large number of paths. See the [Mergeable Ingress Resources](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/mergeable-ingress-types) example on our GitHub. +You can spread the Ingress configuration for a common host across multiple Ingress resources using Mergeable Ingress resources. Such resources can belong to the *same* or *different* namespaces. This enables easier management when using a large number of paths. See the [Mergeable Ingress Resources](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/mergeable-ingress-types) example on our GitHub. -As an alternative to Mergeable Ingress resources, you can use [VirtualServer and VirtualServerRoute resources](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) for cross-namespace configuration. See the [Cross-Namespace Configuration](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples-of-custom-resources/cross-namespace-configuration) example on our GitHub. +As an alternative to Mergeable Ingress resources, you can use [VirtualServer and VirtualServerRoute resources](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) for cross-namespace configuration. See the [Cross-Namespace Configuration](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples-of-custom-resources/cross-namespace-configuration) example on our GitHub. diff --git a/docs-web/configuration/ingress-resources/custom-annotations.md b/docs-web/configuration/ingress-resources/custom-annotations.md index 2f58d5e20e..e768a1a755 100644 --- a/docs-web/configuration/ingress-resources/custom-annotations.md +++ b/docs-web/configuration/ingress-resources/custom-annotations.md @@ -12,7 +12,7 @@ Custom annotations allow you to add an annotation for an NGINX feature that is n ## Usage -The Ingress Controller generates NGINX configuration for Ingress resources by executing a configuration template. See [NGINX template](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/internal/configs/version1/nginx.ingress.tmpl) or [NGINX Plus template](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/internal/configs/version1/nginx-plus.ingress.tmpl). +The Ingress Controller generates NGINX configuration for Ingress resources by executing a configuration template. See [NGINX template](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/internal/configs/version1/nginx.ingress.tmpl) or [NGINX Plus template](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/internal/configs/version1/nginx-plus.ingress.tmpl). To support custom annotations, the template has access to the information about the Ingress resource - its *name*, *namespace* and *annotations*. It is possible to check if a particular annotation present in the Ingress resource and conditionally insert NGINX configuration directives at multiple NGINX contexts - `http`, `server`, `location` or `upstream`. Additionally, you can get the value that is set to the annotation. @@ -132,4 +132,4 @@ deny all; ## Example -See the [custom annotations example](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/examples/custom-annotations). +See the [custom annotations example](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/examples/custom-annotations). diff --git a/docs-web/configuration/policy-resource.md b/docs-web/configuration/policy-resource.md index bbf3bed35c..178b0cfb36 100644 --- a/docs-web/configuration/policy-resource.md +++ b/docs-web/configuration/policy-resource.md @@ -4,7 +4,7 @@ The Policy resource allows you to configure features like access control and rat The resource is implemented as a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). -This document is the reference documentation for the Policy resource. An example of a Policy for access control is available in our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/examples-of-custom-resources/access-control). +This document is the reference documentation for the Policy resource. An example of a Policy for access control is available in our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/examples-of-custom-resources/access-control). > **Feature Status**: The Policy resource is available as a preview feature: it is suitable for experimenting and testing; however, it must be used with caution in production environments. Additionally, while the feature is in preview, we might introduce some backward-incompatible changes to the resource specification in the next releases. diff --git a/docs-web/configuration/transportserver-resource.md b/docs-web/configuration/transportserver-resource.md index 80c5154f51..879b563ad7 100644 --- a/docs-web/configuration/transportserver-resource.md +++ b/docs-web/configuration/transportserver-resource.md @@ -2,7 +2,7 @@ The TransportServer resource allows you to configure TCP, UDP, and TLS Passthrough load balancing. The resource is implemented as a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). -This document is the reference documentation for the TransportServer resource. To see additional examples of using the resource for specific use cases, go to the [examples-of-custom-resources](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/examples-of-custom-resources) folder in our GitHub repo. +This document is the reference documentation for the TransportServer resource. To see additional examples of using the resource for specific use cases, go to the [examples-of-custom-resources](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/examples-of-custom-resources) folder in our GitHub repo. > **Feature Status**: The TransportServer resource is available as a preview feature: it is suitable for experimenting and testing; however, it must be used with caution in production environments. Additionally, while the feature is in preview, we might introduce some backward-incompatible changes to the resource specification in the next releases. @@ -310,6 +310,6 @@ The [ConfigMap](/nginx-ingress-controller/configuration/global-configuration/con ## Limitations The TransportServer resource is a preview feature. Currently, it comes with the following limitations: -* When using TLS Passthrough, it is not possible to configure [Proxy Protocol](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/proxy-protocol) for port 443 both for regular HTTPS and TLS Passthrough traffic. +* When using TLS Passthrough, it is not possible to configure [Proxy Protocol](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/proxy-protocol) for port 443 both for regular HTTPS and TLS Passthrough traffic. * If multiple TCP (or UDP) TransportServers reference the same listener, only one of them will receive the traffic. Moreover, until there is only one TransportServer, NGINX will fail to reload. If this happens, the IC will report a warning event with the `AddedOrUpdatedWithError` reason for the resource, which caused the problem, and also report the error in the logs. * If multiple TLS Passthrough TransportServers have the same hostname, only one of them will receive the traffic. If this happens, the IC will report a warning in the logs like `host "app.example.com" is used by more than one TransportServers`. \ No newline at end of file diff --git a/docs-web/configuration/virtualserver-and-virtualserverroute-resources.md b/docs-web/configuration/virtualserver-and-virtualserverroute-resources.md index 51ef8e8a26..a1f6de1aaf 100644 --- a/docs-web/configuration/virtualserver-and-virtualserverroute-resources.md +++ b/docs-web/configuration/virtualserver-and-virtualserverroute-resources.md @@ -2,7 +2,7 @@ The VirtualServer and VirtualServerRoute resources are new load balancing configuration, introduced in release 1.5 as an alternative to the Ingress resource. The resources enable use cases not supported with the Ingress resource, such as traffic splitting and advanced content-based routing. The resources are implemented as [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). -This document is the reference documentation for the resources. To see additional examples of using the resources for specific use cases, go to the [examples-of-custom-resources](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.0/examples-of-custom-resources) folder in our GitHub repo. +This document is the reference documentation for the resources. To see additional examples of using the resources for specific use cases, go to the [examples-of-custom-resources](https://github.com/nginxinc/kubernetes-ingress/blob/v1.9.1/examples-of-custom-resources) folder in our GitHub repo. ## Contents @@ -420,7 +420,7 @@ tls: - ``string`` - Yes * - ``service`` - - The name of a `service `_. The service must belong to the same namespace as the resource. If the service doesn't exist, NGINX will assume the service has zero endpoints and return a ``502`` response for requests for this upstream. For NGINX Plus only, services of type `ExternalName `_ are also supported (check the `prerequisites `_\ ). + - The name of a `service `_. The service must belong to the same namespace as the resource. If the service doesn't exist, NGINX will assume the service has zero endpoints and return a ``502`` response for requests for this upstream. For NGINX Plus only, services of type `ExternalName `_ are also supported (check the `prerequisites `_\ ). - ``string`` - Yes * - ``subselector`` @@ -914,7 +914,7 @@ proxy: - `action.Proxy.ResponseHeaders <#action-proxy-responseheaders>`_ - No * - ``rewritePath`` - - The rewritten URI. If the route path is a regular expression (starts with ~), the rewritePath can include capture groups with ``$1-9``. For example `$1` for the first group, and so on. For more information, check the `rewrite `_ example. + - The rewritten URI. If the route path is a regular expression (starts with ~), the rewritePath can include capture groups with ``$1-9``. For example `$1` for the first group, and so on. For more information, check the `rewrite `_ example. - ``string`` - No ``` diff --git a/docs-web/installation/building-ingress-controller-image.md b/docs-web/installation/building-ingress-controller-image.md index 7f3f5e59b4..beecbc9105 100644 --- a/docs-web/installation/building-ingress-controller-image.md +++ b/docs-web/installation/building-ingress-controller-image.md @@ -23,7 +23,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c ``` $ git clone https://github.com/nginxinc/kubernetes-ingress/ $ cd kubernetes-ingress/deployments - $ git checkout v1.9.0 + $ git checkout v1.9.1 ``` 1. Build the image: @@ -33,7 +33,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c ``` `myregistry.example.com/nginx-ingress` defines the repo in your private registry where the image will be pushed. Substitute that value with the repo in your private registry. - As a result, the image **myregistry.example.com/nginx-ingress:1.9.0** is built and pushed to the registry. Note that the tag `1.9.0` comes from the `VERSION` variable, defined in the Makefile. + As a result, the image **myregistry.example.com/nginx-ingress:1.9.1** is built and pushed to the registry. Note that the tag `1.9.1` comes from the `VERSION` variable, defined in the Makefile. * For NGINX Plus, first, make sure that the certificate (`nginx-repo.crt`) and the key (`nginx-repo.key`) of your license are located in the root of the project: ``` @@ -46,7 +46,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c ``` `myregistry.example.com/nginx-plus-ingress` defines the repo in your private registry where the image will be pushed. Substitute that value with the repo in your private registry. - As a result, the image **myregistry.example.com/nginx-plus-ingress:1.9.0** is built and pushed to the registry. Note that the tag `1.9.0` comes from the `VERSION` variable, defined in the Makefile. + As a result, the image **myregistry.example.com/nginx-plus-ingress:1.9.1** is built and pushed to the registry. Note that the tag `1.9.1` comes from the `VERSION` variable, defined in the Makefile. Next you will find the details about available Makefile targets and variables. diff --git a/docs-web/installation/installation-with-helm.md b/docs-web/installation/installation-with-helm.md index e8ab5a063c..ce343bc9df 100644 --- a/docs-web/installation/installation-with-helm.md +++ b/docs-web/installation/installation-with-helm.md @@ -22,7 +22,7 @@ This step is required if you're installing the chart using its sources. Addition 2. Change your working directory to /deployments/helm-chart: ```console $ cd kubernetes-ingress/deployments/helm-chart - $ git checkout v1.9.0 + $ git checkout v1.9.1 ``` ## Adding the Helm Repository @@ -219,7 +219,7 @@ The following tables lists the configurable parameters of the NGINX Ingress cont - nginx/nginx-ingress * - ``controller.image.tag`` - The tag of the Ingress controller image. - - 1.9.0 + - 1.9.1 * - ``controller.image.pullPolicy`` - The pull policy for the Ingress controller image. - IfNotPresent diff --git a/docs-web/installation/installation-with-manifests.md b/docs-web/installation/installation-with-manifests.md index 2b34922bb9..fc378a423d 100644 --- a/docs-web/installation/installation-with-manifests.md +++ b/docs-web/installation/installation-with-manifests.md @@ -11,7 +11,7 @@ This document describes how to install the NGINX Ingress Controller in your Kube ``` $ git clone https://github.com/nginxinc/kubernetes-ingress/ $ cd kubernetes-ingress/deployments - $ git checkout v1.9.0 + $ git checkout v1.9.1 ``` ## 1. Configure RBAC diff --git a/docs-web/installation/installation-with-operator.md b/docs-web/installation/installation-with-operator.md index e9a7bbe398..bda8b781ae 100644 --- a/docs-web/installation/installation-with-operator.md +++ b/docs-web/installation/installation-with-operator.md @@ -23,7 +23,7 @@ spec: type: deployment image: repository: nginx/nginx-ingress - tag: 1.9.0 + tag: 1.9.1 pullPolicy: Always serviceType: NodePort nginxPlus: False diff --git a/docs-web/releases.md b/docs-web/releases.md index bbdc350e1a..72581840c1 100644 --- a/docs-web/releases.md +++ b/docs-web/releases.md @@ -1,5 +1,23 @@ # Releases +## NGINX Ingress Controller 1.9.1 + +23 November 2020 + +CHANGES: +* Fix deployment of ingressclass resource via helm on some versions of Kubernetes. +* Update the base ubi images to 8.3. +* Renew CA cert for egress-mtls example. +* Add `controller.serviceAccount.imagePullSecretName` parameter to the helm chart. **Note**: `controller.serviceAccount.imagePullSecrets` is deprecated and will be removed in the future `1.10.0` release. + +HELM CHART: +* The version of the Helm chart is now 0.7.1. + +UPGRADE: +* For NGINX, use the 1.9.1 image from our DockerHub: `nginx/nginx-ingress:1.9.1`, `nginx/nginx-ingress:1.9.1-alpine` or `nginx/nginx-ingress:1.9.1-ubi` +* For NGINX Plus, please build your own image using the 1.9.1 source code. +* For Helm, use version 0.7.1 of the chart. + ## NGINX Ingress Controller 1.9.0 20 October 2020 diff --git a/docs-web/technical-specifications.md b/docs-web/technical-specifications.md index ee55ecc7ea..9ca0d1462a 100644 --- a/docs-web/technical-specifications.md +++ b/docs-web/technical-specifications.md @@ -27,12 +27,12 @@ The supported architecture is x86-64. - ``Dockerfile`` - ``nginx:1.19.3``, which is based on ``debian:buster-slim`` - - - ``nginx/nginx-ingress:1.9.0`` + - ``nginx/nginx-ingress:1.9.1`` * - Alpine-based image - ``DockerfileForAlpine`` - ``nginx:1.19.3-alpine``, which is based on ``alpine:3.10`` - - - ``nginx/nginx-ingress:1.9.0-alpine`` + - ``nginx/nginx-ingress:1.9.1-alpine`` * - Debian-based image with Opentracing - ``DockerfileWithOpentracing`` - ``nginx:1.19.3``, which is based on ``debian:buster-slim`` @@ -42,7 +42,7 @@ The supported architecture is x86-64. - ``openshift/Dockerfile`` - ``registry.access.redhat.com/ubi8/ubi:8.3`` - - - ``nginx/nginx-ingress:1.9.0-ubi`` + - ``nginx/nginx-ingress:1.9.1-ubi`` ``` \* -- Dockerfile paths are relative to the ``build`` folder of the Ingress Controller git repo. diff --git a/docs-web/third-party-modules/opentracing.md b/docs-web/third-party-modules/opentracing.md index ef192abd94..5999d94f42 100644 --- a/docs-web/third-party-modules/opentracing.md +++ b/docs-web/third-party-modules/opentracing.md @@ -2,7 +2,7 @@ The Ingress Controller supports [OpenTracing](https://opentracing.io/) with the third-party module [opentracing-contrib/nginx-opentracing](https://github.com/opentracing-contrib/nginx-opentracing). -This document explains how to use OpenTracing with the Ingress Controller. Additionally, we have an [example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.0/examples/opentracing) on how to enable OpenTracing for a simple web application using Jaeger as a tracer. +This document explains how to use OpenTracing with the Ingress Controller. Additionally, we have an [example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.9.1/examples/opentracing) on how to enable OpenTracing for a simple web application using Jaeger as a tracer. ## Prerequisites 1. **Use the Ingress Controller image with OpenTracing.** The default Ingress Controller images don’t include the OpenTracing module. To use OpenTracing, you need to build the image with that module. Follow the build instructions to build the image using `DockerfileWithOpentracing` for NGINX or `DockerfileWithOpentracingForPlus` for NGINX Plus.