diff --git a/docs/content/app-protect-waf/configuration.md b/docs/content/app-protect-waf/configuration.md index 0e24da1381..979822ee6b 100644 --- a/docs/content/app-protect-waf/configuration.md +++ b/docs/content/app-protect-waf/configuration.md @@ -478,7 +478,7 @@ To access the application, curl the coffee and the tea services. We'll use the - ### Configuration Example of Virtual Server -Refer to github repo for [Virtual Server example](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.2.1/examples/custom-resources/app-protect-waf/webapp.yaml). +Refer to GitHub repo for [Virtual Server example](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.2.1/examples/custom-resources/app-protect-waf/webapp.yaml). ```yaml apiVersion: k8s.nginx.org/v1 diff --git a/docs/content/configuration/policy-resource.md b/docs/content/configuration/policy-resource.md index 8c2bc3a214..91477652ff 100644 --- a/docs/content/configuration/policy-resource.md +++ b/docs/content/configuration/policy-resource.md @@ -143,7 +143,7 @@ When you reference more than one rate limit policy, NGINX Ingress Controller wil ### BasicAuth -The basic auth policy configures NGINX to authenticate cllient requests using the [HTTP Basic authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). +The basic auth policy configures NGINX to authenticate client requests using the [HTTP Basic authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). For example, the following policy will reject all requests that do not include a valid username/password combination in the HTTP header `Authentication` diff --git a/docs/content/installation/installation-with-helm.md b/docs/content/installation/installation-with-helm.md index 14965f4753..cd04a6c092 100644 --- a/docs/content/installation/installation-with-helm.md +++ b/docs/content/installation/installation-with-helm.md @@ -327,7 +327,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont |`controller.extraContainers` | Extra (eg. sidecar) containers for the Ingress Controller pods. | [] | |`controller.resources` | The resources of the Ingress Controller pods. | requests: cpu=100m,memory=128Mi | |`controller.replicaCount` | The number of replicas of the Ingress Controller deployment. | 1 | -|`controller.ingressClass` | 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` | 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.setAsDefaultIngress` | New Ingresses without an `"ingressClassName"` field specified will be assigned the class specified in `controller.ingressClass`. | 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`. | "" | diff --git a/docs/content/installation/using-the-jwt-token-docker-secret.md b/docs/content/installation/using-the-jwt-token-docker-secret.md index 1bc4a31b34..8c66988577 100644 --- a/docs/content/installation/using-the-jwt-token-docker-secret.md +++ b/docs/content/installation/using-the-jwt-token-docker-secret.md @@ -35,19 +35,19 @@ You will need the following information from [MyF5](https://my.f5.com) for these 1. Choose your desired [NGINX Ingress Controller Image](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#images-with-nginx-plus). 1. Log into the [MyF5 Portal](https://myf5.com/), navigate to your subscription details, and download the relevant .cert, .key and .JWT files. 1. Create a Kubernetes secret using the JWT token. You should use `cat` to view the contents of the JWT token and store the output for use in later steps. -1. Ensure there are no additional characters or extra whiespace that might have been accidently added. This will break authorization and prevent the NGINX Ingress Controller image from being downloaded. +1. Ensure there are no additional characters or extra whitespace that might have been accidentally added. This will break authorization and prevent the NGINX Ingress Controller image from being downloaded. 1. Modify your deployment (manifest or helm) to use the Kubernetes secret created in step three. 1. Deploy NGINX Ingress Controller into your Kubernetes cluster and verify successful installation. ## Using the JWT token in a Docker Config Secret -1. Create a kubernetes `docker-registry` secret type on the cluster, using the JWT token as the username and `none` for password (Password is unused). The name of the docker server is `private-registry.nginx.com`. +1. Create a Kubernetes `docker-registry` secret type on the cluster, using the JWT token as the username and `none` for password (Password is unused). The name of the docker server is `private-registry.nginx.com`. ```shell kubectl create secret docker-registry regcred --docker-server=private-registry.nginx.com --docker-username= --docker-password=none [-n nginx-ingress] ``` - It is important that the `--docker-username=` contains the contents of the token and is not pointing to the token itself. Ensure that when you copy the contents of the JWT token, there are no additional characters or extra whitepaces. This can invalidate the token and cause 401 errors when trying to authenticate to the registry. + It is important that the `--docker-username=` contains the contents of the token and is not pointing to the token itself. Ensure that when you copy the contents of the JWT token, there are no additional characters or extra whitespaces. This can invalidate the token and cause 401 errors when trying to authenticate to the registry. 1. Confirm the details of the created secret by running: @@ -86,7 +86,7 @@ If you are using `helm` for deployment, there are two main methods: using *sourc ### Helm Source -The [Helm installation page for NGINX Ingess Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#managing-the-chart-via-sources) has a section describing how to use sources: these are the unique steps for Docker secrets using JWT tokens. +The [Helm installation page for NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#managing-the-chart-via-sources) has a section describing how to use sources: these are the unique steps for Docker secrets using JWT tokens. 1. Clone the NGINX [`kubernetes-ingress` repository](https://github.com/nginxinc/kubernetes-ingress). 1. Navigate to the `deployments/helm-chart` folder of your local clone. @@ -98,7 +98,7 @@ You must change a few lines NGINX Ingress Controller with NGINX Plus to be deplo 1. Change the `repository` argument to the NGINX Ingress Controller image you intend to use. 1. Add an argument to `imagePullSecretName` to allow Docker to pull the image from the private registry. -The following codeblock shows snippets of the parameters you will need to change, and an example of their contents: +The following code block shows snippets of the parameters you will need to change, and an example of their contents: ```yaml ## Deploys the Ingress Controller for NGINX Plus diff --git a/docs/content/releases.md b/docs/content/releases.md index 7a8be8741a..7b28aab682 100644 --- a/docs/content/releases.md +++ b/docs/content/releases.md @@ -48,7 +48,7 @@ FIXES: - [3798](https://github.com/nginxinc/kubernetes-ingress/pull/3798) Update VirtualServer template to generate an internal jwt auth location per policy applied. - [3844](https://github.com/nginxinc/kubernetes-ingress/pull/3844) Fix gunzip support for VS and add python tests. - [3870](https://github.com/nginxinc/kubernetes-ingress/pull/3870) Add Funcs() method to UpdateVirtualServerTemplate method. Thanks to [Bryan Hendryx](https://github.com/coolbry95). -- [3933](https://github.com/nginxinc/kubernetes-ingress/pull/3933) fix --enternal-service flag when using serviceNameOverride. Thanks to [Tim N](https://github.com/timnee). +- [3933](https://github.com/nginxinc/kubernetes-ingress/pull/3933) fix --external-service flag when using serviceNameOverride. Thanks to [Tim N](https://github.com/timnee). CHANGES: @@ -368,7 +368,7 @@ FEATURES: - [2914](https://github.com/nginxinc/kubernetes-ingress/pull/2914) Support watching multiple namespaces. - [2884](https://github.com/nginxinc/kubernetes-ingress/pull/2884) Include year in logs. - [2993](https://github.com/nginxinc/kubernetes-ingress/pull/2993) Accept proxy protocol when TLS passthrough enabled. -- [3041](https://github.com/nginxinc/kubernetes-ingress/pull/3041) Support external name service for TansportServer. +- [3041](https://github.com/nginxinc/kubernetes-ingress/pull/3041) Support external name service for TransportServer. - [2939](https://github.com/nginxinc/kubernetes-ingress/pull/2939) Add support for wildcard hostname in VirtualServer. IMPROVEMENTS: diff --git a/docs/content/tutorials/ingress-path-regex-annotation.md b/docs/content/tutorials/ingress-path-regex-annotation.md index d3db4696cb..4b951fdc6c 100644 --- a/docs/content/tutorials/ingress-path-regex-annotation.md +++ b/docs/content/tutorials/ingress-path-regex-annotation.md @@ -9,7 +9,7 @@ toc: true ## Customizing NGINX Ingress Controller with Path-Regex Annotations We suggest reading the NGINX [documentation on resolve location priority](https://docs.nginx.com/nginx/admin-guide/web-server/web-server/#nginx-location-priority) -to gain additional contenx about NGINX and NGINX Plus before using the ``path-regex`` annotation. +to gain additional context about NGINX and NGINX Plus before using the ``path-regex`` annotation. ## Ingress Type diff --git a/docs/content/tutorials/nginx-ingress-istio.md b/docs/content/tutorials/nginx-ingress-istio.md index a61d9d8a22..6bb752ae04 100644 --- a/docs/content/tutorials/nginx-ingress-istio.md +++ b/docs/content/tutorials/nginx-ingress-istio.md @@ -27,7 +27,7 @@ To begin, Istio needs to be installed into your cluster. ## Install Istio Link to Istio install guide: -[Installing istio](https://istio.io/latest/docs/setup/install/) +[Installing Istio](https://istio.io/latest/docs/setup/install/) It is crucial to make sure you install Istio **BEFORE** installing NGINX Ingress Controller. This ensures that the Istio sidecar is injected correctly into the NGINX Ingress controller pod. diff --git a/docs/content/tutorials/nginx-ingress-osm.md b/docs/content/tutorials/nginx-ingress-osm.md index a5dcf5526e..440a65f5a4 100644 --- a/docs/content/tutorials/nginx-ingress-osm.md +++ b/docs/content/tutorials/nginx-ingress-osm.md @@ -335,7 +335,7 @@ kubectl apply -f osm-nginx-client-cert.yaml ``` -Ensure the secrets exisit in the `nginx-ingress` namespace: +Ensure the secrets exist in the `nginx-ingress` namespace: ```console kubectl get secrets -n nginx-ingress diff --git a/docs/content/tutorials/oidc-custom-configuration.md b/docs/content/tutorials/oidc-custom-configuration.md index e91c189d9f..2604cead1a 100644 --- a/docs/content/tutorials/oidc-custom-configuration.md +++ b/docs/content/tutorials/oidc-custom-configuration.md @@ -61,7 +61,7 @@ oidc.conf: # Rest of configuration file truncated ``` -## Step 2 - Customising the default configuration +## Step 2 - Customizing the default configuration Once the contents of the `oidc.conf` file has been added to the ConfigMap, you are free to customize the contents of this ConfigMap. This example demonstrates adding a comment to the top of the file. The comment will be shown at the top of the `oidc.conf` file.