Skip to content

Commit

Permalink
Release 2.1.0
Browse files Browse the repository at this point in the history
Update to 2.1.0

supported versions

Update arbitrator chart for release

Apply suggestions from code review

Co-authored-by: Ciara Stacke <[email protected]>
overview

add dos images

fix version

Update docs/content/releases.md

Co-authored-by: Michael Pleshakov <[email protected]>
fix overview
  • Loading branch information
ciarams87 committed Jan 6, 2022
1 parent 6dac355 commit 302b978
Show file tree
Hide file tree
Showing 40 changed files with 402 additions and 331 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

### 2.1.0

An automatically generated list of changes can be found on Github at: [2.1.0 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.1.0)

A curated list of changes can be found in the [Releases](http://docs.nginx.com/nginx-ingress-controller/releases/) page on NGINX Documentation website.

### 2.0.3

An automatically generated list of changes can be found on Github at: [2.0.3 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.0.3)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Read [this doc](https://docs.nginx.com/nginx-ingress-controller/intro/nginx-plus

We publish Ingress controller releases on GitHub. See our [releases page](https://github.com/nginxinc/kubernetes-ingress/releases).

The latest stable release is [2.0.3](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.0.3). 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 [2.1.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.1.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.
Expand All @@ -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 | Use the 2.0.3 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress) or [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 2.0.3 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/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 | Use the 2.1.0 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress) or [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | Use the 2.1.0 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/deployments/helm-chart). | [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) or [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs/content/installation/building-ingress-controller-image.md). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs/content/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/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples). |

## Contacts
Expand Down
2 changes: 1 addition & 1 deletion deployments/daemon-set/nginx-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:2.0.3
- image: nginx/nginx-ingress:2.1.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
Expand Down
2 changes: 1 addition & 1 deletion deployments/daemon-set/nginx-plus-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx-plus-ingress:2.0.3
- image: nginx-plus-ingress:2.1.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down
2 changes: 1 addition & 1 deletion deployments/deployment/nginx-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:2.0.3
- image: nginx/nginx-ingress:2.1.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
Expand Down
4 changes: 2 additions & 2 deletions deployments/deployment/nginx-plus-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx-plus-ingress:2.0.3
- image: nginx-plus-ingress:2.1.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down Expand Up @@ -63,4 +63,4 @@ spec:
#- -report-ingress-status
#- -external-service=nginx-ingress
#- -enable-prometheus-metrics
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
#- -global-configuration=$(POD_NAMESPACE)/nginx-configuration
6 changes: 3 additions & 3 deletions deployments/helm-chart-dos-arbitrator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: nginx-appprotect-dos-arbitrator
version: 0.0.1
version: 0.1.0
appVersion: 1.1.0
apiVersion: v1
kubeVersion: ">= 1.19.0-0"
description: NGINX App Protect Dos arbitrator
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v2.0.3/deployments/helm-chart-dos-arbitrator/chart-icon.png
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v2.1.0/deployments/helm-chart-dos-arbitrator/chart-icon.png
home: https://github.com/nginxinc/kubernetes-ingress
sources:
- https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/deployments/helm-chart-dos-arbitrator
- https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/deployments/helm-chart-dos-arbitrator
keywords:
- appprotect-dos
- nginx
Expand Down
2 changes: 1 addition & 1 deletion deployments/helm-chart-dos-arbitrator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This step is required if you're installing the chart using its sources. Addition
2. Change your working directory to /deployments/helm-chart-dos-arbitrator:
```console
$ cd kubernetes-ingress/deployments/helm-chart-dos-arbitrator
$ git checkout v2.0.3
$ git checkout v2.1.0
```

## Adding the Helm Repository
Expand Down
8 changes: 4 additions & 4 deletions deployments/helm-chart/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: nginx-ingress
version: 0.11.3
appVersion: 2.0.3
version: 0.12.0
appVersion: 2.1.0
apiVersion: v1
kubeVersion: ">= 1.19.0-0"
description: NGINX Ingress Controller
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v2.0.3/deployments/helm-chart/chart-icon.png
icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v2.1.0/deployments/helm-chart/chart-icon.png
home: https://github.com/nginxinc/kubernetes-ingress
sources:
- https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/deployments/helm-chart
- https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/deployments/helm-chart
keywords:
- ingress
- nginx
Expand Down
4 changes: 2 additions & 2 deletions deployments/helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,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 v2.0.3
$ git checkout v2.1.0
```

## Adding the Helm Repository
Expand Down Expand Up @@ -153,7 +153,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. | 2.0.3
`controller.image.tag` | The tag of the Ingress controller image. | 2.1.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.annotations` | The annotations of the Ingress controller configmap. | {}
Expand Down
2 changes: 1 addition & 1 deletion deployments/helm-chart/values-icp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ controller:
nginxplus: true
image:
repository: mycluster.icp:8500/kube-system/nginx-plus-ingress
tag: "2.0.3"
tag: "2.1.0"
nodeSelector:
beta.kubernetes.io/arch: "amd64"
proxy: true
Expand Down
2 changes: 1 addition & 1 deletion deployments/helm-chart/values-plus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ controller:
nginxplus: true
image:
repository: nginx-plus-ingress
tag: "2.0.3"
tag: "2.1.0"
2 changes: 1 addition & 1 deletion deployments/helm-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ controller:
repository: nginx/nginx-ingress

## The tag of the Ingress controller image.
tag: "2.0.3"
tag: "2.1.0"

## The pull policy for the Ingress controller image.
pullPolicy: IfNotPresent
Expand Down
6 changes: 3 additions & 3 deletions docs/content/app-protect-dos/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc: true
---

This document describes how to configure the NGINX App Protect Dos module
> Check out the complete [NGINX Ingress Controller with App Protect Dos example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/examples/appprotect-dos).
> Check out the complete [NGINX Ingress Controller with App Protect Dos example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/examples/appprotect-dos).
## App Protect Dos Configuration

Expand Down Expand Up @@ -97,7 +97,7 @@ Then add a reference in the `DosProtectedResrouce` to the `ApDosPolicy`:
spec:
enable: true
name: "my-dos"
apDosMonitor:
apDosMonitor:
uri: "webapp.example.com"
apDosPolicy: "default/dospolicy"
```
Expand Down Expand Up @@ -147,7 +147,7 @@ Then add a reference in the `DosProtectedResource` to the `APDosLogConf`:
spec:
enable: true
name: "my-dos"
apDosMonitor:
apDosMonitor:
uri: "webapp.example.com"
dosSecurityLog:
enable: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation with Helm App Protect Dos Arbitrator
description:
description:
weight: 1900
doctypes: [""]
toc: true
Expand All @@ -11,7 +11,7 @@ toc: true
- A [Kubernetes Version Supported by the Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#supported-kubernetes-versions)
- Helm 3.0+.
- Git.

## Getting the Chart Sources

This step is required if you're installing the chart using its sources. Additionally, the step is also required for managing the custom resource definitions (CRDs), which the Ingress Controller requires by default, or for upgrading/deleting the CRDs.
Expand All @@ -23,7 +23,7 @@ This step is required if you're installing the chart using its sources. Addition
2. Change your working directory to /deployments/helm-chart-dos-arbitrator:
```console
$ cd kubernetes-ingress/deployments/helm-chart-dos-arbitrator
$ git checkout v2.0.3
$ git checkout v2.1.0
```

## Adding the Helm Repository
Expand Down
4 changes: 2 additions & 2 deletions docs/content/app-protect-dos/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This document provides an overview of the steps required to use NGINX App Protec
```
$ git clone https://github.com/nginxinc/kubernetes-ingress/
$ cd kubernetes-ingress
$ git checkout v2.0.3
$ git checkout v2.1.0
```
## Create the namespace and service account
Expand Down Expand Up @@ -63,4 +63,4 @@ Take the steps below to set up and deploy the NGINX Ingress Controller and App P
4. Enable the App Protect Dos module by adding the `enable-app-protect-dos` [cli argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments.md#cmdoption-enable-app-protect-dos) to your Deployment or DaemonSet file.
5. [Deploy the Ingress Controller](/nginx-ingress-controller/installation/installation-with-manifests.md#3-deploy-the-ingress-controller).
For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect-dos/configuration),the [NGINX Ingress Controller with App Protect Dos example for Ingress](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/examples/appprotect-dos) and the [NGINX Ingress Controller with App Protect Dos example for VirtualServer](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/examples/custom-resources/dos).
For more information, see the [Configuration guide](/nginx-ingress-controller/app-protect-dos/configuration),the [NGINX Ingress Controller with App Protect Dos example for Ingress](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/examples/appprotect-dos) and the [NGINX Ingress Controller with App Protect Dos example for VirtualServer](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.0/examples/custom-resources/dos).
8 changes: 4 additions & 4 deletions docs/content/app-protect/configuration.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: Configuration

description:
description:
weight: 1900
doctypes: [""]
toc: true
---

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

Expand All @@ -26,7 +26,7 @@ You can define App Protect policies for your Ingress resources by creating an `A

> **Note**: The fields `policy.signature-requirements[].minRevisionDatetime` and `policy.signature-requirements[].maxRevisionDatetime` are not currently supported.
> **Note**: [The Advanced gRPC Protection for Unary Traffic](/nginx-app-protect/configuration/#advanced-grpc-protection-for-unary-traffic) only supports providing an `idl-file` inline. The fields `policy.idl-files[].link`, `policy.idl-files[].$ref`, and
> **Note**: [The Advanced gRPC Protection for Unary Traffic](/nginx-app-protect/configuration/#advanced-grpc-protection-for-unary-traffic) only supports providing an `idl-file` inline. The fields `policy.idl-files[].link`, `policy.idl-files[].$ref`, and
`policy.idl-files[].file` are not supported. The IDL file should be provided in field `policy.idl-files[].contents`. The value of this field can be base64 encoded. In this case the field `policy.idl-files[].isBase64` should be set to `true`.

To add any [App Protect policy](/nginx-app-protect/policy/#policy) to an Ingress resource:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/app-protect/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ 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/#3-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/v2.0.3/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/v2.1.0/examples/appprotect).
4 changes: 2 additions & 2 deletions docs/content/configuration/configuration-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ toc: true


Our [GitHub repo](https://github.com/nginxinc/kubernetes-ingress) includes a number of configuration examples:
* [*Examples*](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/examples) show how to use advanced NGINX features in Ingress resources with annotations.
* [*Examples of Custom Resources*](https://github.com/nginxinc/kubernetes-ingress/tree/v2.0.3/examples/custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases.
* [*Examples*](https://github.com/nginxinc/kubernetes-ingress/tree/v2.1.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/v2.1.0/examples/custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases.
Loading

0 comments on commit 302b978

Please sign in to comment.