Release 1.10.0 (#1321)

* Release 1.10.0

* Apply suggestions from code review

Co-authored-by: Dean Coakley <[email protected]>

* Apply suggestions from code review

Co-authored-by: Michael Pleshakov <[email protected]>

* Updating github master links to v1.10.0

* Updated instructions for upgrading CRDs with helm

* Added warning for kubectl delete command

* Only the specific upgrade docs should contain deletion of policies

* Merging removal of ingressLink doc changes

* Operator docs now refer to 1.9.1 instead of 1.10.0

Co-authored-by: Dean Coakley <[email protected]>
Co-authored-by: Michael Pleshakov <[email protected]>
Co-authored-by: Michael Pleshakov <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -52,7 +52,13 @@ UPGRADE:
 * For Helm, use version 0.8.0 of the chart.
 * As a result of [1270](https://github.com/nginxinc/kubernetes-ingress/pull/1270) and [1277](https://github.com/nginxinc/kubernetes-ingress/pull/1277), the Ingress Controller improved validation of Ingress annotations: more annotations are validated and validation errors are reported via events for Ingress resources. Additionally, the default behavior for invalid annotation values was changed: instead of using the default values, the Ingress Controller will reject a resource with an invalid annotation value, which will make clients see `404` responses from NGINX. See this [document](https://docs.nginx.com/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations/#validation) to learn more. Before upgrading, ensure the Ingress resources don't have annotations with invalid values. Otherwise, after the upgrade, the Ingress Controller will reject such resources.
 * In [1232](https://github.com/nginxinc/kubernetes-ingress/pull/1232) `controller.serviceAccount.imagePullSecrets` was removed. Use the new `controller.serviceAccount.imagePullSecretName` instead.
-* The Policy resource was promoted to `v1`. If you used the `alpha1` version, the policies are needed to be recreated with the `v1` version. Note that all policies except for `accessControl` are still in preview. To enable them, run the Ingress Controller with `- -enable-preview-policies` command-line argument (`controller.enablePreviewPolicies` Helm parameter).
+* The Policy resource was promoted to `v1`. If you used the `alpha1` version, the policies are needed to be recreated with the `v1` version. Before upgrading the Ingress Controller, run the following command to remove the `alpha1` policies CRD (that will also remove all existing `alpha1` policies):
+    ```
+     kubectl delete crd policies.k8s.nginx.org
+    ```
+  As part of the upgrade, make sure to create the `v1` policies CRD. See the corresponding instructions for the [manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/#create-custom-resources) and [Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#upgrading-the-crds) installations.
+
+  Also note that all policies except for `accessControl` are still in preview. To enable them, run the Ingress Controller with `- -enable-preview-policies` command-line argument (`controller.enablePreviewPolicies` Helm parameter).
 * It is necessary to update secret resources. See the section UPDATING SECRETS below.
 
 UPDATING SECRETS:

deployments/helm-chart/Chart.yaml

@@ -4,10 +4,10 @@ appVersion: 1.10.0
 apiVersion: v1
 kubeVersion: ">= 1.14.0-0"
 description: NGINX Ingress Controller
-icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/master/deployments/helm-chart/chart-icon.png
+icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v1.10.0/deployments/helm-chart/chart-icon.png
 home: https://github.com/nginxinc/kubernetes-ingress
 sources:
-  - https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments/helm-chart
+  - https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/deployments/helm-chart
 keywords:
   - ingress
   - nginx

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/master/examples/appprotect).
+> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/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/master/examples/appprotect).
+> Check out the complete [NGINX Ingress Controller with App Protect example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/appprotect).
 
 ## Enable App Protect for an Ingress Resource
 

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/master/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.10.0/examples/appprotect).
 

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/master/examples) show how to use advanced NGINX features in Ingress resources with annotations.
-* [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/master/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.10.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.10.0/examples-of-custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases.

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 <https://nginx.org/en/docs/http/ngx_http_core_module.html#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 <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/externalname-services>`_.
+     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/externalname-services>`_.
    * - ``resolver-ipv6``
      - Enables IPv6 resolution in the resolver. Supported in NGINX Plus only.
      - ``True``
-     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/externalname-services>`_.
+     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/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 <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/externalname-services>`_.
+     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/externalname-services>`_.
    * - ``resolver-timeout``
      - Sets the `resolver_timeout <https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_timeout>`_ for name resolution. Supported in NGINX Plus only.
      - ``30s``
-     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/externalname-services>`_.
+     - `Support for Type ExternalName Services <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/externalname-services>`_.
    * - ``keepalive-timeout``
      - Sets the value of the `keepalive_timeout <https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout>`_ directive.
      - ``65s``
@@ -204,15 +204,15 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres
      - 
    * - ``log-format``
      - Sets the custom `log format <https://nginx.org/en/docs/http/ngx_http_log_module.html#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 <https://github.com/nginxinc/kubernetes-ingress/blob/master/internal/configs/version1/nginx.tmpl>`_ for the access log.
+     - See the `template file <https://github.com/nginxinc/kubernetes-ingress/blob/v1.10.0/internal/configs/version1/nginx.tmpl>`_ for the access log.
      - `Custom Log Format <https://github.com/nginxinc/kubernetes-ingress/tree/update-log-format/examples/custom-log-format>`_.
    * - ``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).
      - ``default``
      -
    * - ``stream-log-format``
      - Sets the custom `log format <https://nginx.org/en/docs/stream/ngx_stream_log_module.html#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 <https://github.com/nginxinc/kubernetes-ingress/blob/master/internal/configs/version1/nginx.tmpl>`_.
+     - See the `template file <https://github.com/nginxinc/kubernetes-ingress/blob/v1.10.0/internal/configs/version1/nginx.tmpl>`_.
      - 
    * - ``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 <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/proxy-protocol>`_.
+     - `Proxy Protocol <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/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 <https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/tcp-udp>`_.
+     - `Support for TCP/UDP Load Balancing <https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples/tcp-udp>`_.
    * - ``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 <https://opentracing.io>`_ globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Note: requires the Ingress Controller image with OpenTracing module and a tracer. See the `docs </nginx-ingress-controller/third-party-modules/opentracing>`_ for more information.
      - ``False``
-     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
+     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/v1.10.0/examples/opentracing/README.md>`_.
    * - ``opentracing-tracer``
      - Sets the path to the vendor tracer binary plugin.
      - N/A
-     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
+     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/v1.10.0/examples/opentracing/README.md>`_.
    * - ``opentracing-tracer-config``
      - Sets the tracer configuration in JSON format.
      - N/A
-     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
+     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/v1.10.0/examples/opentracing/README.md>`_.
    * - ``app-protect-cookie-seed``
      - Sets the ``app_protect_cookie_seed`` `global directive </nginx-app-protect/configuration/#global-directives>`_.
      - Random automatically generated string

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/master/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.10.0/examples/custom-templates).

docs-web/configuration/handling-host-collisions.md

@@ -66,4 +66,4 @@ Similarly, if `cafe-ingress` was created first, it will win `cafe.example.com` a
 
 It is possible to merge configuration for multiple Ingress resources for the same host. One common use case for this approach is distributing resources across multiple namespaces. See the [Cross-namespace Configuration](/nginx-ingress-controller/configuration/ingress-resources/cross-namespace-configuration/) doc for more information.
 
-It is *not* possible to merge the configurations for multiple VirtualServer resources for the same host. However, you can split the VirtualServers into multiple VirtualServerRoute resources, which a single VirtualServer can then reference. See the [corresponding example](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples-of-custom-resources/cross-namespace-configuration) on GitHub.
+It is *not* possible to merge the configurations for multiple VirtualServer resources for the same host. However, you can split the VirtualServers into multiple VirtualServerRoute resources, which a single VirtualServer can then reference. See the [corresponding example](https://github.com/nginxinc/kubernetes-ingress/tree/v1.10.0/examples-of-custom-resources/cross-namespace-configuration) on GitHub.