Release 1.5.0

Author: pleshakov

CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+### 1.5.0
+
+FEATURES:
+* [560](https://github.com/nginxinc/kubernetes-ingress/pull/560): Add new configuration resources -- VirtualServer and VirtualServerRoute.
+* [554](https://github.com/nginxinc/kubernetes-ingress/pull/554): Add new Prometheus metrics related to the Ingress Controller's operation (as opposed to NGINX/NGINX Plus metrics).
+* [496](https://github.com/nginxinc/kubernetes-ingress/pull/496): Support a wildcard TLS certificate for TLS-enabled Ingress resources.
+* [485](https://github.com/nginxinc/kubernetes-ingress/pull/485): Support ExternalName services in Ingress backends.
+
+IMPROVEMENTS:
+* Add new ConfigMap keys: `keepalive-timeout`, `keepalive-requests`, `access-log-off`, `variables-hash-bucket-size`, `variables-hash-max-size`. Added in [565](https://github.com/nginxinc/kubernetes-ingress/pull/565), [511](https://github.com/nginxinc/kubernetes-ingress/pull/511).
+* [504](https://github.com/nginxinc/kubernetes-ingress/pull/504): Run the Prometheus exporter inside the Ingress Controller process instead of a sidecar container.
+
+BUGFIXES:
+* [520](https://github.com/nginxinc/kubernetes-ingress/pull/520): Fix the type of the Prometheus port annotation in manifests.
+* [481](https://github.com/nginxinc/kubernetes-ingress/pull/481): Fix the HSTS support.
+* [439](https://github.com/nginxinc/kubernetes-ingress/pull/439): Fix the validation of the `lb-method` ConfigMap key and `nginx.org/lb-method` annotation.
+
+HELM CHART:
+* The version of the helm chart is now 0.3.0.
+* The helm chart is now available in our helm chart repo `helm.nginx.com/stable`. 
+* Add new parameters to the Chart: `controller.service.httpPort.targetPort`, `controller.service.httpsPort.targetPort`, `controller.service.name`, `controller.pod.annotations`, `controller.config.name`, `controller.reportIngressStatus.leaderElectionLockName`, `controller.service.httpPort`, `controller.service.httpsPort`, `controller.service.loadBalancerIP`, `controller.service.loadBalancerSourceRanges`, `controller.tolerations`, `controller.affinity`. Added in [562](https://github.com/nginxinc/kubernetes-ingress/pull/562), [561](https://github.com/nginxinc/kubernetes-ingress/pull/561), [553](https://github.com/nginxinc/kubernetes-ingress/pull/553), [534](https://github.com/nginxinc/kubernetes-ingress/pull/534) thanks to [Paulo Ribeiro](https://github.com/paigr), [479](https://github.com/nginxinc/kubernetes-ingress/pull/479) thanks to [Alejandro Llanes](https://github.com/sombralibre),  [468](https://github.com/nginxinc/kubernetes-ingress/pull/468), [456](https://github.com/nginxinc/kubernetes-ingress/pull/456).
+* [546](https://github.com/nginxinc/kubernetes-ingress/pull/546): Support deploying multiple Ingress Controllers in a cluster. **Note**: The generated resources have new names that are unique for each Ingress Controller. As a consequence, the name change affects the upgrade. See the HELM UPGRADE section for more information. 
+* [542](https://github.com/nginxinc/kubernetes-ingress/pull/542): Reduce the required privileges in the RBAC manifests.
+
+CHANGES:
+* Update NGINX version to 1.15.12.
+* Prometheus metrics for NGINX/NGINX Plus have new namespace `nginx_ingress`. Examples: `nginx_http_requests_total` -> `nginx_ingress_http_requests_total`, `nginxplus_http_requests_total` -> `nginx_ingress_nginxplus_http_requests_total`.
+
+UPGRADE:
+* For NGINX, use the 1.5.0 image from our DockerHub: `nginx/nginx-ingress:1.5.0` or `nginx/nginx-ingress:1.5.0-alpine`
+* For NGINX Plus, please build your own image using the 1.5.0 source code.
+* For Helm, use version 0.3.0 of the chart.
+
+HELM UPGRADE:
+
+The new version of the helm chart uses different names for the generated resources. This makes it possible to deploy multiple Ingress Controllers in a cluster. However, as a side effect, during the upgrade from the previous version, helm will recreate the resources, instead of updating the existing ones. This, in turn, might cause problems for the following resources:
+* Service: If the service was created with the type LoadBalancer, the public IP of the new service might change. Additionally, helm updates the selector of the service, so that the old pods will be immediately excluded from the service. 
+* Deployment/DaemonSet: Because the resource is recreated, the old pods will be removed and the new ones will be launched, instead of the default Deployment/Daemonset upgrade strategy. 
+* ConfigMap: After the helm removes the resource, the old Ingress Controller pods will be immediately reconfigured to use the default values of the ConfigMap keys. During a small window between the reconfiguration and the shutdown of the old pods, NGINX will use the configuration with the default values.
+
+We advise not to upgrade to the new version of the helm chart unless the mentioned problems are acceptable for your case. We will provide special upgrade instructions for helm that mitigate the problems for the next minor release of the Ingress Controller (1.5.1).
+
 ### 1.4.6
 
 CHANGES:

Makefile

@@ -1,6 +1,6 @@
 all: push
 
-VERSION = edge
+VERSION = 1.5.0
 TAG = $(VERSION)
 PREFIX = nginx/nginx-ingress
 

README.md

@@ -49,7 +49,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.4.6](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v1.4.6). 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.5.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v1.5.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.
 
 To use the Ingress controller, you need to have access to:
 * An Ingress controller image.
@@ -62,7 +62,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.4.6`, `nginx/nginx-ingress:1.4.6-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/build). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/build). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/deployments/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/v1.4.6/examples). |
+| Latest stable release | For production use | `nginx/nginx-ingress:1.5.0`, `nginx/nginx-ingress:1.5.0-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/build). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/build). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/deployments/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/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/build). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/build). | [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). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples). |
 
 ## Contacts

build/README.md

@@ -30,6 +30,7 @@ We build the image using the make utility and the provided `Makefile`. Let’s c
 1. Clone the Ingress controller repo:
     ```
     $ git clone https://github.com/nginxinc/kubernetes-ingress/
+    $ git checkout v1.5.0
     ```
 
 1. Build the image:
@@ -40,7 +41,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 the result, the image **myregistry.example.com/nginx-ingress:edge** is built and pushed to the registry. Note that the tag `edge` comes from the `VERSION` variable, defined in the Makefile.
+      As the result, the image **myregistry.example.com/nginx-ingress:1.5.0** is built and pushed to the registry. Note that the tag `1.5.0` 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:
       ```
@@ -54,7 +55,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 the result, the image **myregistry.example.com/nginx-plus-ingress:edge** is built and pushed to the registry. Note that the tag `edge` comes from the `VERSION` variable, defined in the Makefile.
+      As the result, the image **myregistry.example.com/nginx-plus-ingress:1.5.0** is built and pushed to the registry. Note that the tag `1.5.0` comes from the `VERSION` variable, defined in the Makefile.
 
 Next you will find the details about available Makefile targets and variables.
 

deployments/daemon-set/nginx-ingress.yaml

@@ -17,8 +17,7 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx/nginx-ingress:edge
-        imagePullPolicy: Always
+      - image: nginx/nginx-ingress:1.5.0
         name: nginx-ingress
         ports:
         - name: http

deployments/daemon-set/nginx-plus-ingress.yaml

@@ -17,8 +17,7 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx-plus-ingress:edge
-        imagePullPolicy: Always
+      - image: nginx-plus-ingress:1.5.0
         name: nginx-plus-ingress
         ports:
         - name: http

deployments/deployment/nginx-ingress.yaml

@@ -18,8 +18,7 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx/nginx-ingress:edge
-        imagePullPolicy: Always
+      - image: nginx/nginx-ingress:1.5.0
         name: nginx-ingress
         ports:
         - name: http

deployments/deployment/nginx-plus-ingress.yaml

@@ -18,8 +18,7 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx-plus-ingress:edge
-        imagePullPolicy: Always
+      - image: nginx-plus-ingress:1.5.0
         name: nginx-plus-ingress
         ports:
         - name: http

deployments/helm-chart/Chart.yaml

@@ -1,10 +1,10 @@
 name: nginx-ingress
-version: 0.9.0
-appVersion: edge
+version: 0.3.0 
+appVersion: 1.5.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.5.0/deployments/helm-chart/chart-icon.png
 sources:
-  - https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments/helm-chart
+  - https://github.com/nginxinc/kubernetes-ingress/tree/v1.5.0/deployments/helm-chart
 keywords:
   - ingress
   - nginx

deployments/helm-chart/README.md

@@ -6,38 +6,61 @@ This chart deploys the NGINX Ingress controller in your Kubernetes cluster.
 
 ## Prerequisites
 
-  - Kubernetes 1.6+.
   - Helm 2.8.x+.
-  - Git.
+  - Git (for installation using the chart source files).
   - If you’d like to use NGINX Plus:
-    - Build an Ingress controller image with NGINX Plus and push it to your private registry by following the instructions from [here](../../build/README.md).
-    - Update the `controller.image.repository` field of the `values-plus.yaml` accordingly.
+    - Build an Ingress controller image with NGINX Plus and push it to your private registry by following the instructions from [here](https://github.com/nginxinc/kubernetes-ingress/blob/v1.5.0/build/README.md).
+    - Configure `controller.nginxplus` and `controller.image.repository` parameters accordingly using a values file or the `--set` flag of the `helm install` command.
 
 ## Installing the Chart
 
-1. Clone the Ingress controller repo:
-    ```console
+### Installing via Helm Repository
+
+1. Add NGINX Helm repository:
+    ```
+    $ helm repo add nginx-stable https://helm.nginx.com/stable
+    $ helm repo update
+    ```
+
+2. To install the chart with the release name my-release (my-release is the name that you choose):
+
+    For NGINX:
+    ```
+    $ helm install nginx-stable/nginx-ingress --name my-release
+    ```
+
+    For NGINX Plus (assuming you have pushed the Ingress controller image `nginx-plus-ingress` to your private registry `myregistry.example.com`):
+    ```
+    $ helm install nginx-stable/nginx-ingress --name my-release --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true
+    ```
+
+### Installing Using Chart Sources
+
+1. Clone the Ingress controller repo and check out the latest stable version:
+    ```
     $ git clone https://github.com/nginxinc/kubernetes-ingress/
+    $ git checkout v1.5.0
     ```
 2. Change your working directory to /deployments/helm-chart:
-    ```console
+    ```
     $ cd kubernetes-ingress/deployments/helm-chart
     ```
 3. To install the chart with the release name my-release (my-release is the name that you choose):
 
     For NGINX:
-    ```console
+    ```
     $ helm install --name my-release .
     ```
 
-    For NGINX Plus:
-    ```console
+    For NGINX Plus (assuming you have configured the `controller.nginxplus` and `controller.image.repository` parameters in the values file `values-plus.yaml`):
+    ```
     $ helm install --name my-release -f values-plus.yaml .
     ```
 
-    The command deploys the Ingress controller in your Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
+### Notes
 
-    When deploying the Ingress controller, make sure to use your own TLS certificate and key for the default server rather than the default pre-generated ones. Read the [Configuration](#Configuration) section below to see how to configure a TLS certificate and key for the default server. Note that the default server returns the Not Found page with the 404 status code for all requests for domains for which there are no Ingress rules defined.
+* The `helm install` command deploys the Ingress controller in your Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
+* When deploying the Ingress controller, make sure to use your own TLS certificate and key for the default server rather than the default pre-generated ones. Read the [Configuration](#Configuration) section below to see how to configure a TLS certificate and key for the default server. Note that the default server returns the Not Found page with the 404 status code for all requests for domains for which there are no Ingress rules defined.
 
 > **Tip**: List all releases using `helm list`
 
@@ -63,7 +86,7 @@ Parameter | Description | Default
 `controller.hostNetwork` | Enables the Ingress controller pods to use the host's network namespace. | false
 `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.image.repository` | The image repository of the Ingress controller. | nginx/nginx-ingress
-`controller.image.tag` | The tag of the Ingress controller image. | edge
+`controller.image.tag` | The tag of the Ingress controller image. | 1.5.0
 `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.entries` | The entries of the ConfigMap for customizing NGINX configuration. | {}