Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use latest tag in docs and manifests #1495

Merged
merged 1 commit into from
Apr 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions deployments/daemon-set/nginx-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:edge
imagePullPolicy: Always
- image: nginx/nginx-ingress:1.11.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
- name: http
Expand Down
6 changes: 3 additions & 3 deletions deployments/daemon-set/nginx-plus-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx-plus-ingress:edge
imagePullPolicy: Always
- image: nginx-plus-ingress:1.11.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
- name: http
Expand Down Expand Up @@ -57,7 +57,7 @@ spec:
- -nginx-plus
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
#- -enable-app-protect
#- -enable-app-protect
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
#- -report-ingress-status
#- -external-service=nginx-ingress
Expand Down
4 changes: 2 additions & 2 deletions deployments/deployment/nginx-ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:edge
imagePullPolicy: Always
- image: nginx/nginx-ingress:1.11.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
- name: http
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 @@ -18,8 +18,8 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx-plus-ingress:edge
imagePullPolicy: Always
- image: nginx-plus-ingress:1.11.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
- name: http
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.0.0-edge
appVersion: edge
version: 0.9.0
appVersion: 1.11.0
apiVersion: v1
kubeVersion: ">= 1.16.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.11.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.11.0/deployments/helm-chart
keywords:
- ingress
- nginx
Expand Down
16 changes: 11 additions & 5 deletions deployments/helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ This step is required if you're installing the chart using its sources. Addition
This step is required if you're installing the chart via the helm repository.

```console
$ helm repo add nginx-edge https://helm.nginx.com/edge
$ helm repo add nginx-stable https://helm.nginx.com/stable
$ helm repo update
```

**Note**: If you wish to use the experimental repository, replace `stable` with `edge`.

## Installing the Chart

### Installing the CRDs
Expand All @@ -49,14 +51,16 @@ To install the chart with the release name my-release (my-release is the name th

For NGINX:
```console
$ helm install my-release nginx-edge/nginx-ingress --devel
$ helm install my-release nginx-stable/nginx-ingress
```

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 nginx-edge/nginx-ingress --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true --devel
$ helm install my-release nginx-stable/nginx-ingress --set controller.image.repository=myregistry.example.com/nginx-plus-ingress --set controller.nginxplus=true
```

**Note**: If you wish to use the experimental repository, replace `stable` with `edge` and add the `--devel` flag.

### Installing Using Chart Sources

To install the chart with the release name my-release (my-release is the name that you choose):
Expand All @@ -71,6 +75,8 @@ For NGINX Plus:
$ helm install my-release -f values-plus.yaml .
```

**Note**: If you wish to use the experimental repository, replace the value in the `tag` field inside the yaml files with `edge`.

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.

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.
Expand Down Expand Up @@ -101,7 +107,7 @@ $ helm upgrade my-release .
#### Upgrade via Helm Repository:

```console
$ helm upgrade my-release nginx-edge/nginx-ingress
$ helm upgrade my-release nginx-stable/nginx-ingress
```

## Uninstalling the Chart
Expand Down Expand Up @@ -145,7 +151,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. | edge
`controller.image.tag` | The tag of the Ingress controller image. | 1.11.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: "edge"
tag: "1.11.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: "edge"
tag: "1.11.0"
2 changes: 1 addition & 1 deletion deployments/helm-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ controller:
repository: nginx/nginx-ingress

## The tag of the Ingress controller image.
tag: "edge"
tag: "1.11.0"

## The pull policy for the Ingress controller image.
pullPolicy: IfNotPresent
Expand Down
44 changes: 22 additions & 22 deletions docs-web/app-protect/configuration.md
Original file line number Diff line number Diff line change
@@ -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.11.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.11.0/examples/appprotect).

## Enable App Protect for an Ingress Resource

Expand All @@ -16,16 +16,16 @@ You can enable and configure NGINX App Protect on a per-Ingress-resource basis.

You can define App Protect policies for your Ingress resources by creating an `APPolicy` [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).

> **Note**: The fields `policy.signature-requirements[].minRevisionDatetime` and `policy.signature-requirements[].maxRevisionDatetime` are not currently supported.
> **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) is not currently supported.

To add any [App Protect policy](/nginx-app-protect/policy/#policy) to an Ingress resource:

1. Create an `APPolicy` Custom resource manifest.
2. Add the desired policy to the `spec` field in the `APPolicy` resource.
> **Note**: The relationship between the Policy JSON and the resource spec is 1:1. If you're defining your resources in YAML, as we do in our examples, you'll need to represent the policy as YAML. The fields must match those in the source JSON exactly in name and level.
1. Create an `APPolicy` Custom resource manifest.
2. Add the desired policy to the `spec` field in the `APPolicy` resource.

> **Note**: The relationship between the Policy JSON and the resource spec is 1:1. If you're defining your resources in YAML, as we do in our examples, you'll need to represent the policy as YAML. The fields must match those in the source JSON exactly in name and level.

For example, say you want to use the [DataGuard policy](/nginx-app-protect/policy/#data-guard) shown below:

Expand All @@ -51,7 +51,7 @@ To add any [App Protect policy](/nginx-app-protect/policy/#policy) to an Ingress
"creditCardNumbers": true,
"usSocialSecurityNumbers": true,
"enforcementMode": "ignore-urls-in-list",
"enforcementUrls": []
"enforcementUrls": []
}
}
}
Expand All @@ -62,15 +62,15 @@ To add any [App Protect policy](/nginx-app-protect/policy/#policy) to an Ingress
```yaml
apiVersion: appprotect.f5.com/v1beta1
kind: APPolicy
metadata:
metadata:
name: dataguard-blocking
spec:
policy:
name: dataguard_blocking
template:
template:
name: POLICY_TEMPLATE_NGINX_BASE
applicationLanguage: utf-8
enforcementMode: blocking
enforcementMode: blocking
blocking-settings:
violations:
- name: VIOL_DATA_GUARD
Expand All @@ -93,9 +93,9 @@ You can set the [App Protect Log configurations](/nginx-app-protect/nginx-app-pr

To add the [App Protect log configurations](/nginx-app-protect/policy/#policy) to an Ingress resource:

1. Create an `APLogConf` Custom resource manifest.
2. Add the desired log configuration to the `spec` field in the `APLogConf` resource.
1. Create an `APLogConf` Custom resource manifest.
2. Add the desired log configuration to the `spec` field in the `APLogConf` resource.

> **Note**: The fields from the JSON must be presented in the YAML *exactly* the same, in name and level. The Ingress Controller will transform the YAML into a valid JSON App Protect log config.

For example, say you want to [log state changing requests](nginx-app-protect/troubleshooting/#log-state-changing-requests) for your Ingress resources using App Protect. The App Protect log configuration looks like this:
Expand All @@ -118,30 +118,30 @@ You would add define that config in the `spec` of your `APLogConf` resource as f
```yaml
apiVersion: appprotect.f5.com/v1beta1
kind: APLogConf
metadata:
metadata:
name: logconf
spec:
filter:
filter:
request_type: all
content:
content:
format: default
max_request_size: any
max_message_size: 5k
```
## App Protect User Defined Signatures

You can define App Protect [User Defined Signatures](https://docs.nginx.com/nginx-app-protect/configuration/#user-defined-signature-definitions) for your Ingress resources by creating an `APUserSig` [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
You can define App Protect [User Defined Signatures](https://docs.nginx.com/nginx-app-protect/configuration/#user-defined-signature-definitions) for your Ingress resources by creating an `APUserSig` [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).

> **Note**: The field `revisionDatetime` is not currently supported.
> **Note**: The field `revisionDatetime` is not currently supported.

> **Note**: `APUserSig` resources increase the reload time of NGINX Plus compared with `APPolicy` and `APLogConf` resources. Refer to [NGINX Fails to Start or Reload](/nginx-ingress-controller/app-protect/troubleshooting/#nginx-fails-to-start-or-reload) for more information.

To add the [User Defined Signatures](https://docs.nginx.com/nginx-app-protect/configuration/#user-defined-signature-definitions) to an Ingress resource:

1. Create an `APUserSig` Custom resource manifest.
2. Add the desired User defined signature to the `spec` field in the `APUserSig` resource.
1. Create an `APUserSig` Custom resource manifest.
2. Add the desired User defined signature to the `spec` field in the `APUserSig` resource.

> **Note**: The fields from the JSON must be presented in the YAML *exactly* the same, in name and level. The Ingress Controller will transform the YAML into a valid JSON App Protect User Defined signature. There is no need to reference the user defined signature resource in the ingress resource.
> **Note**: The fields from the JSON must be presented in the YAML *exactly* the same, in name and level. The Ingress Controller will transform the YAML into a valid JSON App Protect User Defined signature. There is no need to reference the user defined signature resource in the ingress resource.

For example, say you want to create the following user defined signature:

Expand Down
2 changes: 1 addition & 1 deletion docs-web/app-protect/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,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/#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.11.0/examples/appprotect).
4 changes: 2 additions & 2 deletions docs-web/configuration/configuration-examples.md
Original file line number Diff line number Diff line change
@@ -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.11.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.11.0/examples-of-custom-resources) show how to use VirtualServer and VirtualServerResources for a few use cases.