Skip to content

Commit c751d94

Browse files
authored
Update documentation website links (#626)
This commit updates multiple files to update links to the documentation website which have changed as a part of iterative information architecture improvements, which change the URLs.
1 parent 9cbc503 commit c751d94

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Learn more about operators in the [Kubernetes Documentation](https://kubernetes.
1111

1212
To install a specific version of the NGINX Ingress Controller with the operator, a specific version of the NGINX Ingress Operator is required.
1313

14-
Up until version 0.5.1, this Operator was Go based. Version 1.0.0 marks an incompatible upgrade as this release switched the Operator to being Helm-based, built from the [NGINX Ingress Controller Helm chart](http://helm.nginx.com/#nginx-ingress-controller). The configuration for the Helm chart can be seen in the [NGINX Ingress Controller documentation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration).
14+
Up until version 0.5.1, this Operator was Go based. Version 1.0.0 marks an incompatible upgrade as this release switched the Operator to being Helm-based, built from the [NGINX Ingress Controller Helm chart](http://helm.nginx.com/#nginx-ingress-controller). The configuration for the Helm chart can be seen in the [NGINX Ingress Controller documentation](https://docs.nginx.com/nginx-ingress-controller/install/helm#configuration).
1515

1616
The following table shows the relation between the versions of the two projects:
1717

@@ -61,11 +61,11 @@ Note: The NGINX Ingress Operator works only for NGINX Ingress Controller version
6161
- Set the `controller.nginxPlus` to true
6262
- Set the `controller.image.repository` and `controller.image.tag` to the appropriate values
6363
- Set the `controller.serviceAccount.imagePullSecretName` if applicable
64-
- For full configuration details see the Helm documentation [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration).
64+
- For full configuration details see the Helm documentation [here](https://docs.nginx.com/nginx-ingress-controller/install/helm/#configuration).
6565

6666
## Notes: Multiple NIC Deployments
6767

68-
- Please see [the NGINX Ingress Controller documentation](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for general information on running multiple NGINX Ingress Controllers in your cluster.
68+
- Please see [the NGINX Ingress Controller documentation](https://docs.nginx.com/nginx-ingress-controller/install/multiple-controllers/) for general information on running multiple NGINX Ingress Controllers in your cluster.
6969
- To run multiple NIC instances deployed by the NGINX Ingress Operator in your cluster in the same namespace, `rbac.create` should be set to `false`, and the ServiceAccount and ClusterRoleBinding need to be created independently of the deployments. Please note that `controller.serviceAccount.imagePullSecretName` will also be ignored in this configuration, and will need to be configured as part of the independent ServiceAccount creation.
7070
- The ClusterRoleBinding needs to configured to bind to the `nginx-ingress-operator-nginx-ingress-admin` ClusterRole.
7171
- See [RBAC example spec](./resources/rbac-example.yaml) for an example ServiceAccount and ClusterRoleBinding manifest.

docs/nginx-ingress-controller.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,15 +230,15 @@ spec:
230230
enableEgress: false
231231
```
232232
233-
For detailed documentation of individual parameters, please refer to the [Configuration](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#configuration) section in our documentation on installing NGINX Ingress Controller with Helm.
233+
For detailed documentation of individual parameters, please refer to the [Configuration](https://docs.nginx.com/nginx-ingress-controller/install/helm/#configuration) section in our documentation on installing NGINX Ingress Controller with Helm.
234234
235235
## Notes
236236
* The service account name cannot be overridden and needs to be set to `nginx-ingress`. This is a requirement due to the RBAC and SCC configuration on OpenShift clusters.
237237
* The defaultServerSecret needs to be created before the IC deployment with the name of the secret supplied in the NginxIngress manifest, and cannot be created by instead supplying a cert and key.
238238
* If required, the `controller.wildcardTLS.secret` must also be created separately with the name of the secret supplied in the NginxIngress manifest.
239239

240240
## Notes: Multiple NIC Deployments
241-
* Please see [the NGINX Ingress Controller doumentation](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for general information on running multiple NGINX Ingress Controllers in your cluster.
241+
* Please see [the NGINX Ingress Controller doumentation](https://docs.nginx.com/nginx-ingress-controller/install/multiple-controllers/) for general information on running multiple NGINX Ingress Controllers in your cluster.
242242
* To run multiple NIC instances deployed by the NGINX Ingress Operator in your cluster in the same namespace, `rbac.create` should be set to `false`, and the ServiceAccount and ClusterRoleBinding need to be created independently of the deployments. Please note that `controller.serviceAccount.imagePullSecretName` will also be ignored in this configuration, and will need to be configured as part of the independant ServiceAccount creation.
243243
* The ClusterRoleBinding needs to configured to bind to the `nginx-ingress-operator-nginx-ingress-admin` ClusterRole.
244244
* See [RBAC example spec](../resources/rbac-example.yaml) for an example ServiceAccount and ClusterRoleBinding manifest.

docs/upgrades.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Install the latest version of the Operator following the steps outlined in [Open
3232

3333
### 4. Deploy new ingress controller deployments
3434

35-
Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-3-5-1) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration)
35+
Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-3-5-1) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/install/helm/#configuration)
3636

3737
## Manual upgrade - 0.5.1 to 1.0.0
3838

@@ -57,4 +57,4 @@ Install the latest version of the Operator following the steps outlined in [manu
5757

5858
### 4. Deploy new ingress controller deployments
5959

60-
Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-3-5-1) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration)
60+
Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-3-5-1) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/install/helm/#configuration)

examples/deployment-plus-min/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ In this example we deploy the NGINX Ingress Controller (edge) as a [Deployment](
66

77
1. Have the NGINX Ingress Operator deployed in your cluster. Follow [installation](../../README.md#installation) steps.
88
2. Build the NGINX Ingress Controller for Plus image and push it to a private repository following
9-
[these instructions](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/#building-the-image-and-pushing-it-to-the-private-registry)
9+
[these instructions](https://docs.nginx.com/nginx-ingress-controller/install/build/#building-the-image-and-pushing-it-to-the-private-registry)
1010
(**Note**: For the build process, if using OpenShift, use the `ubi-image-plus`, `ubi-image-nap-plus`, `ubi-image-dos-plus` or `ubi-image-nap-dos-plus` targets).
11-
3. Setup your NGINX Plus [license](https://docs.nginx.com/nginx-ingress-controller/installation/create-license-secret/) `Secret`
11+
3. Setup your NGINX Plus [license](https://docs.nginx.com/nginx-ingress-controller/install/license-secret/) `Secret`
1212

1313
If you would like to use TransportServers, refer to [this section](README.md#TransportServers) for additional pre-requisites.
1414

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Helm Documentation
22

3-
Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) guide in the NGINX Ingress Controller documentation site.
3+
Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/install/helm/) guide in the NGINX Ingress Controller documentation site.

helm-charts/nginx-ingress/templates/NOTES.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed.
22

33
For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/
44

5-
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/
5+
Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/install/helm/
66

77
{{ if .Release.IsUpgrade -}}
88
If you are upgrading from a version of the chart that uses older Custom Resource Definitions (CRD) it is necessary to manually upgrade the CRDs as this is not managed by Helm.
99
To update to the latest version of the CRDs:
1010
$ kubectl apply -f https://raw.githubusercontent.com/nginx/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml
1111

12-
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds
12+
More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/install/helm#upgrading-the-crds
1313
{{- end -}}

0 commit comments

Comments
 (0)