Skip to content

Commit 90711d2

Browse files
committed
Clear up installation language
Added some more information to help ease the installation flow for both helm installation and creating the JWT and then installing.
1 parent 222ecc0 commit 90711d2

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

site/content/installation/installing-ngf/helm.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ To complete this guide, you'll need to install:
4949

5050
### Install from the OCI registry
5151

52+
The following steps install NGINX Gateway Fabric directly from the OCI helm registry. If you prefer, you can [install from sources](#install-from-sources) instead.
53+
5254
{{<tabs name="install-helm-oci">}}
5355

5456
{{%tab name="NGINX"%}}
@@ -68,7 +70,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-nam
6870
To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command:
6971

7072
```shell
71-
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret --create-namespace -n nginx-gateway
73+
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway
7274
```
7375

7476
{{% /tab %}}
@@ -77,7 +79,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx
7779

7880
`ngf` is the name of the release, and can be changed to any name you want. This name is added as a prefix to the Deployment name.
7981

80-
If the namespace already exists, you can omit the optional `--create-namespace` flag. If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command.
82+
If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command.
8183

8284
To wait for the Deployment to be ready, you can either add the `--wait` flag to the `helm install` command, or run the following after installing:
8385

@@ -87,6 +89,7 @@ kubectl wait --timeout=5m -n nginx-gateway deployment/ngf-nginx-gateway-fabric -
8789

8890
### Install from sources {#install-from-sources}
8991

92+
If you prefer to install directly from sources, instead of through the OCI helm registry, use the following steps.
9093

9194
{{<include "installation/helm/pulling-the-chart.md" >}}
9295

@@ -109,7 +112,7 @@ helm install ngf . --create-namespace -n nginx-gateway
109112
To install the chart into the **nginx-gateway** namespace, run the following command:
110113

111114
```shell
112-
helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret --create-namespace -n nginx-gateway
115+
helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway
113116
```
114117

115118
{{% /tab %}}
@@ -118,8 +121,6 @@ helm install ngf . --set nginx.image.repository=private-registry.nginx.com/nginx
118121

119122
`ngf` is the name of the release, and can be changed to any name you want. This name is added as a prefix to the Deployment name.
120123

121-
If the namespace already exists, you can omit the optional `--create-namespace` flag.
122-
123124
To wait for the Deployment to be ready, you can either add the `--wait` flag to the `helm install` command, or run the following after installing:
124125

125126
```shell
@@ -212,6 +213,8 @@ To upgrade the CRDs, take the following steps:
212213
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 need to install an NGINX Plus JWT
213214
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{</ important >}}
214215

216+
There are two possible ways to upgrade NGINX Gateway Fabric. You can either upgrade from the OCI registry, or download the chart and upgrade from the source.
217+
215218
#### Upgrade from the OCI registry
216219

217220
- To upgrade to the latest stable release of NGINX Gateway Fabric, run:

site/content/installation/nginx-plus-jwt.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ and the following volume mount to the `nginx` container:
8383

8484
{{</tabs>}}
8585

86+
**If you are reporting to the default licensing endpoint, then you can now proceed with [installing NGINX Gateway Fabric]({{< relref "installation/installing-ngf" >}}). Otherwise, follow the steps below to configure reporting to NGINX Instance Manager.**
87+
8688
### Reporting to NGINX Instance Manager {#nim}
8789

8890
If you are deploying NGINX Gateway Fabric in an environment where you need to report to NGINX Instance Manager instead of the default licensing endpoint, a few extra steps may be required.

0 commit comments

Comments
 (0)