Skip to content

Commit

Permalink
Update versions in docs (#4460)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucacome authored Oct 3, 2023
1 parent c246567 commit 8af2b04
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 18 deletions.
23 changes: 10 additions & 13 deletions docs/content/installation/using-the-jwt-token-docker-secret.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ To list the available image tags using the Docker registry API, you will also ne

You can also get the image using alternative methods:

* You can use Docker to pull an NGINX Ingress Controller image with NGINX Plus and push it to your private registry by following the ["Pulling the Ingress Controller Image"](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) documentation.
* You can also build an NGINX Ingress Controller image by following the ["Information on how to build an Ingress Controller image"](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/) documentation.
- You can use Docker to pull an NGINX Ingress Controller image with NGINX Plus and push it to your private registry by following the ["Pulling the Ingress Controller Image"](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) documentation.
- You can also build an NGINX Ingress Controller image by following the ["Information on how to build an Ingress Controller image"](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/) documentation.

If you would like an NGINX Ingress Controller image using NGINX open source, we provide the image through [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/).

## Before You Begin

You will need the following information from [MyF5](https://my.f5.com) for these steps:

* A JWT Access Token (Per instance) for NGINX Ingress Controller from an active NGINX Ingress Controller subscription.
* The certificate (`nginx-repo.crt`) and key (`nginx-repo.key`) for each NGINX Ingress Controller instance, used to list the available image tags from the Docker registry API.
- A JWT Access Token (Per instance) for NGINX Ingress Controller from an active NGINX Ingress Controller subscription.
- The certificate (`nginx-repo.crt`) and key (`nginx-repo.key`) for each NGINX Ingress Controller instance, used to list the available image tags from the Docker registry API.

## Prepare NGINX Ingress Controller

Expand All @@ -43,20 +43,18 @@ You will need the following information from [MyF5](https://my.f5.com) for these

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
```shell
kubectl create secret docker-registry regcred --docker-server=private-registry.nginx.com --docker-username=<JWT Token> --docker-password=none [-n nginx-ingress]
```
It is important that the `--docker-username=<JWT Token>` 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.

It is important that the `--docker-username=<JWT Token>` 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:

```shell
```shell
kubectl get secret regcred --output=yaml
```


1. You can now use the newly created Kubernetes secret in `helm` and `manifest` deployments.

## Manifest Deployment
Expand All @@ -73,7 +71,7 @@ spec:
seccompProfile:
type: RuntimeDefault
containers:
- image: private-registry.nginx.com/nginx-ic/nginx-plus-ingress:3.2.0
- image: private-registry.nginx.com/nginx-ic/nginx-plus-ingress:3.3.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
```
Expand Down Expand Up @@ -111,7 +109,7 @@ image:
repository: private-registry.nginx.com/nginx-ic/nginx-plus-ingress
## The version tag
tag: 3.2.0
tag: 3.3.0
serviceAccount:
## The annotations of the service account of the Ingress Controller pods.
Expand All @@ -136,13 +134,12 @@ The above command will install NGINX Ingress Controller in the `nginx-ingress` n

If the namespace does not exist, `--create-namespace` will create it. Using `-f values.yaml` tells `helm` to use the `values.yaml` file that you modified earlier with the settings you want to apply for your NGINX Ingress Controller deployment.


### Helm Chart

If you want to install NGINX Ingress Controller using the charts method, the following is an example of using the command line to pass the required arguments using the `set` parameter.

```shell
helm install my-release -n nginx-ingress oci://ghcr.io/nginxinc/charts/nginx-ingress --version 0.18.0 --set controller.image.repository=private-registry.nginx.com/nginx-ic/nginx-plus-ingress --set controller.image.tag=3.2.0 --set controller.nginxplus=true --set controller.serviceAccount.imagePullSecretName=regcred
helm install my-release -n nginx-ingress oci://ghcr.io/nginxinc/charts/nginx-ingress --version 1.0.0 --set controller.image.repository=private-registry.nginx.com/nginx-ic/nginx-plus-ingress --set controller.image.tag=3.3.0 --set controller.nginxplus=true --set controller.serviceAccount.imagePullSecretName=regcred
```

Checking the validation that the .crts/key and .jwt are able to successfully authenticate to the repo to pull NGINX Ingress controller images:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/troubleshooting/troubleshoot-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ controller:
nginxplus: plus
image:
repository: nginx/nginx-ingress
tag: 2.4.1
tag: 3.3.0
# NGINX Configmap
config:
entries:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorials/custom-listen-ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ spec:
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:3.2.0
- image: nginx/nginx-ingress:3.3.0
imagePullPolicy: IfNotPresent
name: nginx-ingress
ports:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/usage-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ To make the credential available to Usage Reporting, we need to create a Kuberne

If you need to update the basic-auth credentials for NGINX Management Suite in the future, update the `username` and `password` fields, and apply the changes by running the command again. Usage Reporting will automatically detect the changes, using the new username and password without redeployment.

5. Download and save the deployment file [cluster-connector.yaml](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.1.1/examples/shared-examples/usage-reporting/cluster-connector.yaml). Edit the following under the `args` section and then save the file:
5. Download and save the deployment file [cluster-connector.yaml](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.3.0/examples/shared-examples/usage-reporting/cluster-connector.yaml). Edit the following under the `args` section and then save the file:

```yaml
args:
Expand Down
4 changes: 2 additions & 2 deletions examples/custom-resources/service-insight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:
securityContext:
...
containers:
- image: nginx-plus-ingress:3.2.0
- image: nginx-plus-ingress:3.3.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down Expand Up @@ -321,7 +321,7 @@ spec:
securityContext:
...
containers:
- image: nginx-plus-ingress:3.2.0
- image: nginx-plus-ingress:3.3.0
imagePullPolicy: IfNotPresent
name: nginx-plus-ingress
ports:
Expand Down

0 comments on commit 8af2b04

Please sign in to comment.