Skip to content

Commit

Permalink
Release 3.4.0 (#4794)
Browse files Browse the repository at this point in the history
* Release 3.4.0

---------

Co-authored-by: Paul Abel <p.abel@f5.com>
Co-authored-by: shaun-nx <s.odonovan@f5.com>
Co-authored-by: Paul Abel <128620221+pdabelf5@users.noreply.github.com>
  • Loading branch information
4 people committed Dec 19, 2023
1 parent 0d95575 commit 0811b5c
Show file tree
Hide file tree
Showing 41 changed files with 214 additions and 154 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -98,7 +98,7 @@ In the case of NGINX, the Ingress Controller is deployed in a pod along with the
We publish NGINX Ingress Controller releases on GitHub. See our [releases
page](https://github.com/nginxinc/kubernetes-ingress/releases).

The latest stable release is [3.3.2](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.3.2). For production
The latest stable release is [3.4.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.4.0). For production
use, we recommend that you choose the latest stable release.

The edge version is useful for experimenting with new features that are not yet published in a stable release. To use
Expand All @@ -118,7 +118,7 @@ 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 | Use the 3.3.2 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 3.3.2 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.3.2/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.3.2/charts/nginx-ingress). | [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 | Use the 3.4.0 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 3.4.0 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.4.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.4.0/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |
| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). |

## SBOM (Software Bill of Materials)
Expand Down
8 changes: 4 additions & 4 deletions charts/nginx-ingress/Chart.yaml
@@ -1,14 +1,14 @@
apiVersion: v2
name: nginx-ingress
version: 1.0.2
appVersion: 3.3.2
version: 1.1.0
appVersion: 3.4.0
kubeVersion: ">= 1.22.0-0"
type: application
description: NGINX Ingress Controller
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.3.2/charts/nginx-ingress/chart-icon.png
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.0/charts/nginx-ingress/chart-icon.png
home: https://github.com/nginxinc/kubernetes-ingress
sources:
- https://github.com/nginxinc/kubernetes-ingress/tree/v3.3.2/charts/nginx-ingress
- https://github.com/nginxinc/kubernetes-ingress/tree/v3.4.0/charts/nginx-ingress
keywords:
- ingress
- nginx
Expand Down
16 changes: 8 additions & 8 deletions charts/nginx-ingress/README.md
Expand Up @@ -79,14 +79,14 @@ To install the chart with the release name my-release (my-release is the name th
For NGINX:

```console
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.0.2
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.1.0
```

For NGINX Plus: (assuming you have pushed the Ingress Controller image `nginx-plus-ingress` to your private registry
`myregistry.example.com`)

```console
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.0.2 --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.1.0 --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true
```

This will install the latest `edge` version of the Ingress Controller from GitHub Container Registry. If you prefer to
Expand All @@ -101,7 +101,7 @@ CRDs](#upgrading-the-crds).
To upgrade the release `my-release`:

```console
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.0.2
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.1.0
```

### Uninstalling the Chart
Expand Down Expand Up @@ -142,7 +142,7 @@ upgrading/deleting the CRDs.
1. Pull the chart sources:

```console
helm pull oci://ghcr.io/nginxinc/charts/nginx-ingress --untar --version 1.0.2
helm pull oci://ghcr.io/nginxinc/charts/nginx-ingress --untar --version 1.1.0
```

2. Change your working directory to nginx-ingress:
Expand Down Expand Up @@ -228,7 +228,7 @@ The steps you should follow depend on the Helm release name:
Selector: app=nginx-ingress-nginx-ingress
```

2. Checkout the latest available tag using `git checkout v3.3.2`
2. Checkout the latest available tag using `git checkout v3.4.0`

3. Navigate to `/kubernates-ingress/charts/nginx-ingress`

Expand Down Expand Up @@ -280,7 +280,7 @@ reviewing its events:
Selector: app=<helm_release_name>-nginx-ingress
```

2. Checkout the latest available tag using `git checkout v3.3.2`
2. Checkout the latest available tag using `git checkout v3.4.0`

3. Navigate to `/kubernates-ingress/charts/nginx-ingress`

Expand Down Expand Up @@ -347,7 +347,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
|`controller.logLevel` | The log level of the Ingress Controller. | 1 |
|`controller.image.digest` | The image digest of the Ingress Controller. | None |
|`controller.image.repository` | The image repository of the Ingress Controller. | nginx/nginx-ingress |
|`controller.image.tag` | The tag of the Ingress Controller image. | 3.3.2 |
|`controller.image.tag` | The tag of the Ingress Controller image. | 3.4.0 |
|`controller.image.pullPolicy` | The pull policy for the Ingress Controller image. | IfNotPresent |
|`controller.lifecycle` | The lifecycle of the Ingress Controller pods. | {} |
|`controller.customConfigMap` | The name of the custom ConfigMap used by the Ingress Controller. If set, then the default config is ignored. | "" |
Expand Down Expand Up @@ -375,7 +375,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
|`controller.initContainerResources` | The resources of the init container which is used when `controller.readOnlyRootFilesystem` is set to `true` | requests: cpu=100m,memory=128Mi |
|`controller.replicaCount` | The number of replicas of the Ingress Controller deployment. | 1 |
|`controller.ingressClass.name` | A class of the Ingress Controller. An IngressClass resource with the name equal to the class must be deployed. Otherwise, the Ingress Controller will fail to start. The Ingress Controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. The Ingress Controller processes all the VirtualServer/VirtualServerRoute/TransportServer resources that do not have the "ingressClassName" field for all versions of Kubernetes. | nginx |
|`controller.ingressClass.create` | Creates a new IngressClass object with the name `controller.ingressClass.name`. Set to `false` to use an existing ingressClass created using `kubectl` with the same name. If you use `helm upgrade`, do not change the values from the previous release as helm will delete IngressClass objects managed by helm. If you are upgrading from a release earlier than 3.3.2, do not set the value to false. | true |
|`controller.ingressClass.create` | Creates a new IngressClass object with the name `controller.ingressClass.name`. Set to `false` to use an existing ingressClass created using `kubectl` with the same name. If you use `helm upgrade`, do not change the values from the previous release as helm will delete IngressClass objects managed by helm. If you are upgrading from a release earlier than 3.4.0, do not set the value to false. | true |
|`controller.ingressClass.setAsDefaultIngress` | New Ingresses without an `"ingressClassName"` field specified will be assigned the class specified in `controller.ingressClass.name`. Requires `controller.ingressClass.create`. | false |
|`controller.watchNamespace` | Comma separated list of namespaces the Ingress Controller should watch for resources. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespaceLabel`. Please note that if configuring multiple namespaces using the Helm cli `--set` option, the string needs to wrapped in double quotes and the commas escaped using a backslash - e.g. `--set controller.watchNamespace="default\,nginx-ingress"`. | "" |
|`controller.watchNamespaceLabel` | Configures the Ingress Controller to watch only those namespaces with label foo=bar. By default the Ingress Controller watches all namespaces. Mutually exclusive with `controller.watchNamespace`. | "" |
Expand Down
2 changes: 1 addition & 1 deletion charts/nginx-ingress/values-icp.yaml
Expand Up @@ -4,7 +4,7 @@ controller:
nginxplus: true
image:
repository: mycluster.icp:8500/kube-system/nginx-plus-ingress
tag: "3.3.2"
tag: "3.4.0"
nodeSelector:
beta.kubernetes.io/arch: "amd64"
proxy: true
Expand Down
2 changes: 1 addition & 1 deletion charts/nginx-ingress/values-plus.yaml
Expand Up @@ -3,4 +3,4 @@ controller:
nginxplus: true
image:
repository: nginx-plus-ingress
tag: "3.3.2"
tag: "3.4.0"
10 changes: 5 additions & 5 deletions charts/nginx-ingress/values.schema.json
Expand Up @@ -305,10 +305,10 @@
},
"tag": {
"type": "string",
"default": "3.3.2",
"default": "3.4.0",
"title": "The tag of the Ingress Controller image",
"examples": [
"3.3.2"
"3.4.0"
]
},
"digest": {
Expand Down Expand Up @@ -345,7 +345,7 @@
"examples": [
{
"repository": "nginx/nginx-ingress",
"tag": "3.3.2",
"tag": "3.4.0",
"pullPolicy": "IfNotPresent"
}
]
Expand Down Expand Up @@ -1393,7 +1393,7 @@
"customPorts": [],
"image": {
"repository": "nginx/nginx-ingress",
"tag": "3.3.2",
"tag": "3.4.0",
"digest": "",
"pullPolicy": "IfNotPresent"
},
Expand Down Expand Up @@ -1765,7 +1765,7 @@
"customPorts": [],
"image": {
"repository": "nginx/nginx-ingress",
"tag": "3.3.2",
"tag": "3.4.0",
"digest": "",
"pullPolicy": "IfNotPresent"
},
Expand Down
4 changes: 2 additions & 2 deletions charts/nginx-ingress/values.yaml
Expand Up @@ -78,7 +78,7 @@ controller:
repository: nginx/nginx-ingress

## The tag of the Ingress Controller image. If not specified the appVersion from Chart.yaml is used as a tag.
# tag: "3.3.2"
# tag: "3.4.0"

## The digest of the Ingress Controller image.
## If digest is specified it has precedence over tag and will be used instead
Expand Down Expand Up @@ -246,7 +246,7 @@ controller:
## The Ingress Controller processes all the resources that do not have the "ingressClassName" field for all versions of kubernetes.
name: nginx

## Creates a new IngressClass object with the name "controller.ingressClass.name". Set to false to use an existing IngressClass with the same name. If you use helm upgrade, do not change the values from the previous release as helm will delete IngressClass objects managed by helm. If you are upgrading from a release earlier than 3.3.2, do not set the value to false.
## Creates a new IngressClass object with the name "controller.ingressClass.name". Set to false to use an existing IngressClass with the same name. If you use helm upgrade, do not change the values from the previous release as helm will delete IngressClass objects managed by helm. If you are upgrading from a release earlier than 3.4.0, do not set the value to false.
create: true

## New Ingresses without an ingressClassName field specified will be assigned the class specified in `controller.ingressClass`. Requires "controller.ingressClass.create".
Expand Down
4 changes: 2 additions & 2 deletions deployments/daemon-set/nginx-ingress.yaml
Expand Up @@ -32,7 +32,7 @@ spec:
# - name: nginx-log
# emptyDir: {}
containers:
- image: nginx/nginx-ingress:3.3.2
- image: nginx/nginx-ingress:3.4.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
Expand Down Expand Up @@ -96,7 +96,7 @@ spec:
#- -enable-prometheus-metrics
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
# initContainers:
# - image: nginx/nginx-ingress:3.3.2
# - image: nginx/nginx-ingress:3.4.0
# imagePullPolicy: IfNotPresent
# name: init-nginx-ingress
# command: ['cp', '-vdR', '/etc/nginx/.', '/mnt/etc']
Expand Down
4 changes: 2 additions & 2 deletions deployments/daemon-set/nginx-plus-ingress.yaml
Expand Up @@ -32,7 +32,7 @@ spec:
# - name: nginx-log
# emptyDir: {}
containers:
- image: nginx-plus-ingress:3.3.2
- image: nginx-plus-ingress:3.4.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down Expand Up @@ -99,7 +99,7 @@ spec:
#- -enable-prometheus-metrics
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
# initContainers:
# - image: nginx/nginx-ingress:3.3.2
# - image: nginx/nginx-ingress:3.4.0
# imagePullPolicy: IfNotPresent
# name: init-nginx-ingress
# command: ['cp', '-vdR', '/etc/nginx/.', '/mnt/etc']
Expand Down
4 changes: 2 additions & 2 deletions deployments/deployment/nginx-ingress.yaml
Expand Up @@ -33,7 +33,7 @@ spec:
# - name: nginx-log
# emptyDir: {}
containers:
- image: nginx/nginx-ingress:3.3.2
- image: nginx/nginx-ingress:3.4.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
Expand Down Expand Up @@ -97,7 +97,7 @@ spec:
#- -enable-prometheus-metrics
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
# initContainers:
# - image: nginx/nginx-ingress:3.3.2
# - image: nginx/nginx-ingress:3.4.0
# imagePullPolicy: IfNotPresent
# name: init-nginx-ingress
# command: ['cp', '-vdR', '/etc/nginx/.', '/mnt/etc']
Expand Down
4 changes: 2 additions & 2 deletions deployments/deployment/nginx-plus-ingress.yaml
Expand Up @@ -33,7 +33,7 @@ spec:
# - name: nginx-log
# emptyDir: {}
containers:
- image: nginx-plus-ingress:3.3.2
- image: nginx-plus-ingress:3.4.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down Expand Up @@ -103,7 +103,7 @@ spec:
#- -enable-service-insight
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
# initContainers:
# - image: nginx/nginx-ingress:3.3.2
# - image: nginx/nginx-ingress:3.4.0
# imagePullPolicy: IfNotPresent
# name: init-nginx-ingress
# command: ['cp', '-vdR', '/etc/nginx/.', '/mnt/etc']
Expand Down
4 changes: 2 additions & 2 deletions docs/content/configuration/configuration-examples.md
Expand Up @@ -11,5 +11,5 @@ docs: "DOCS-584"

Our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress) includes a number of configuration examples:

- [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v3.3.2/examples/custom-resources) show how to advanced NGINX features by using VirtualServer, VirtualServerRoute, TransportServer and Policy Custom Resources.
- [*Examples of Ingress Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v3.3.2/examples/ingress-resources) show how to use advanced NGINX features in Ingress resources with annotations.
- [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v3.4.0/examples/custom-resources) show how to advanced NGINX features by using VirtualServer, VirtualServerRoute, TransportServer and Policy Custom Resources.
- [*Examples of Ingress Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v3.4.0/examples/ingress-resources) show how to use advanced NGINX features in Ingress resources with annotations.

0 comments on commit 0811b5c

Please sign in to comment.