Use edge version in manifests and Helm chart

Author: pleshakov

README.md

@@ -37,6 +37,26 @@ We provide the following extensions to our Ingress controller:
 
 Additional extensions as well as a mechanism to customize NGINX configuration are available. See [examples/customization](examples/customization).
 
+## NGINX Ingress Controller Releases
+
+We publish Ingress controller releases on GitHub. See our [releases page](https://github.com/nginxinc/kubernetes-ingress/releases).
+
+The latest stable release is [1.3.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v1.3.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.
+* Installation manifests or a Helm chart.
+* Documentation and examples.
+
+It is important that the versions of those things above match. 
+
+The table below summarizes the options regarding the images, manifests, helm chart, documentation and examples and gives your links to the correct versions:
+
+| 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.3.0`, `nginx/nginx-ingress:1.3.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.3.0/nginx-controller). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.0/nginx-controller). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.0/install). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.0/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.0/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.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/nginx-controller). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/nginx-controller). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/master/install). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/master/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples). |
+
 ## Benefits of Using the Ingress Controller with NGINX Plus
 
 [NGINX Plus](https://www.nginx.com/products/) is a commercial version of NGINX that comes with advanced features and support.

examples/openshift/nginx-ingress-rc.yaml

@@ -15,7 +15,7 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx/nginx-ingress:1.3.0
+      - image: nginx/nginx-ingress:edge
         imagePullPolicy: Always
         name: nginx-ingress
         ports:

examples/openshift/nginx-plus-ingress-rc.yaml

@@ -15,8 +15,8 @@ spec:
     spec:
       serviceAccountName: nginx-ingress
       containers:
-      - image: nginx-plus-ingress:1.3.0
-        # imagePullPolicy: Always
+      - image: nginx-plus-ingress:edge
+        imagePullPolicy: Always
         name: nginx-plus-ingress
         ports:
         - containerPort: 80

helm-chart/Chart.yaml

@@ -1,6 +1,6 @@
 name: nginx-ingress
 version: 0.1.2
-appVersion: 1.3.0
+appVersion: edge
 description: NGINX Ingress Controller
 sources:
   - https://github.com/nginxinc/kubernetes-ingress/tree/master/helm-chart

helm-chart/README.md

@@ -17,7 +17,11 @@ This chart deploys the NGINX Ingress controller in your Kubernetes cluster.
 
 1. Clone the Ingress controller repo:
     ```
-    $ git clone [email protected]:nginxinc/kubernetes-ingress.git
+    $ git clone https://github.com/nginxinc/kubernetes-ingress/
+    ```
+1.  If you're using a stable release, check out the corresponding tag. For release 1.3.0, run:
+    ```
+    $ git checkout v1.3.0
     ```
 2. Change your working directory to /helm-chart:
     ```
@@ -62,7 +66,7 @@ Parameter | Description | Default
 `controller.nginxplus` | Deploys the Ingress controller for NGINX Plus. | false
 `controller.hostNetwork` | Enables the Ingress controller pods to use the host's network namespace. | false
 `controller.image.repository` | The image repository of the Ingress controller. | nginx/nginx-ingress
-`controller.image.tag` | The tag of the Ingress controller image. | 1.3.0
+`controller.image.tag` | The tag of the Ingress controller image. | edge
 `controller.image.pullPolicy` | The pull policy for the Ingress controller image. | IfNotPresent
 `controller.config.entries` | The entries of the ConfigMap for customizing NGINX configuration. | { }
 `controller.defaultTLS.cert` | The base64-encoded TLS certificate for the default HTTPS server. If not specified, a pre-generated self-signed certificate is used. **Note:** It is recommended that you specify your own certificate. | A pre-generated self-signed certificate.

helm-chart/values-icp.yaml

@@ -5,7 +5,7 @@ controller:
   hostNetwork: false
   image:
     repository: mycluster.icp:8500/kube-system/nginx-plus-ingress
-    tag: "1.3.0"
+    tag: "edge"
     pullPolicy: IfNotPresent
   # It is recommended to use your own TLS certificate and key
   defaultTLS:

helm-chart/values-plus.yaml

@@ -5,7 +5,7 @@ controller:
   hostNetwork: false
   image:
     repository: nginx-plus-ingress
-    tag: "1.3.0"
+    tag: "edge"
     pullPolicy: IfNotPresent
   # It is recommended to use your own TLS certificate and key
   defaultTLS:

helm-chart/values.yaml

@@ -5,7 +5,7 @@ controller:
   hostNetwork: false
   image:
     repository: nginx/nginx-ingress
-    tag: "1.3.0"
+    tag: "edge"
     pullPolicy: IfNotPresent
   config:
     entries: {}

install/daemon-set/nginx-ingress.yaml

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

install/daemon-set/nginx-plus-ingress-with-prometheus.yaml

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

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

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

install/deployment/nginx-ingress.yaml

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

install/deployment/nginx-plus-ingress-with-prometheus.yaml

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

install/deployment/nginx-plus-ingress.yaml

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

nginx-controller/Makefile

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

nginx-controller/README.md

@@ -33,6 +33,11 @@ We build the image using the make utility and the provided `Makefile`. Let’s c
     $ cd kubernetes-ingress/nginx-controller
     ```
 
+1. If you're using a stable release, check out the corresponding tag. For release 1.3.0, run:
+    ```
+    $ git checkout v1.3.0
+    ```
+
 1. Build the image:
     * For NGINX:
       ```
@@ -41,7 +46,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:1.3.0** is built and pushed to the registry. Note that the tag `1.3.0` comes from the `VERSION` variable, defined in the Makefile.
+      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.
 
     * 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 `nginx-controller` folder:
       ```
@@ -55,7 +60,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:1.3.0** is built and pushed to the registry. Note that the tag `1.3.0` comes from the `VERSION` variable, defined in the Makefile.
+      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.
 
 Next you will find the details about available Makefile targets and variables.