Skip to content

Commit b392c5e

Browse files
committed
Update helm install ngf with agent options
1 parent 01c0d91 commit b392c5e

File tree

2 files changed

+51
-47
lines changed

2 files changed

+51
-47
lines changed

content/includes/ngf/installation/install-oci-registry.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

content/nginx-one/k8s/add-ngf.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Log in to NGINX One Console. If you need more information, review our [Get start
2121
You also need:
2222

2323
- Administrator access to a Kubernetes cluster.
24-
- [Helm](https://helm.sh) and [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) must be installed locally.
24+
- If you use [Helm](https://helm.sh) and [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl), install them locally.
2525

2626

2727
### Create a data plane key
@@ -34,6 +34,8 @@ If you've forgotten your data plane key, you can create a new one. Select **Mana
3434

3535
For more options associated with data plane keys, see [Create and manage data plane keys]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}}).
3636

37+
<!-- Helm tab -->
38+
3739
### Create a Kubernetes secret with the data plane key
3840

3941
To create a Kubernetes secret, you'll need:
@@ -52,14 +54,59 @@ Once you have that information, run the following command:
5254
-n <namespace>
5355
```
5456

55-
56-
## Install the Gateway API resources
57+
## Install Gateway API resources
5758
<!-- Corresponds to step 2 in the UX -->
5859
{{< include "/ngf/installation/install-gateway-api-resources.md" >}}
5960

6061
## Install from the OCI registry
6162
<!-- Corresponds to step 3 in the UX -->
62-
{{< include "/ngf/installation/install-oci-registry.md" >}}
63+
64+
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.
65+
66+
{{<tabs name="install-helm-oci">}}
67+
68+
{{%tab name="NGINX"%}}
69+
70+
To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command:
71+
72+
```shell
73+
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric \
74+
--create-namespace -n nginx-gateway \
75+
--set nginxAgent.enable=true \
76+
--set nginxAgent.dataplaneKeySecretName=<data_plane_key_secret_name> \
77+
--set nginxAgent.endpointHost=agent.connect.nginx.com
78+
```
79+
80+
{{% /tab %}}
81+
82+
{{%tab name="NGINX Plus"%}}
83+
84+
{{< note >}} If applicable, replace the F5 Container registry `private-registry.nginx.com` with your internal registry for your NGINX Plus image, and replace `nginx-plus-registry-secret` with your Secret name containing the registry credentials. If your NGINX Plus JWT Secret has a different name than the default `nplus-license`, then define that name using the `nginx.usage.secretName` flag. {{< /note >}}
85+
86+
To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command:
87+
88+
```shell
89+
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric \
90+
--set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus \
91+
--set nginx.plus=true \
92+
--set nginx.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway \
93+
--set nginxAgent.enable=true \
94+
--set nginxAgent.dataplaneKeySecretName=<data_plane_key_secret_name> \
95+
--set nginxAgent.endpointHost=agent.connect.nginx.com
96+
```
97+
98+
{{% /tab %}}
99+
100+
{{</tabs>}}
101+
102+
`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.
103+
104+
If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your install command.
105+
106+
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:
107+
108+
```shell
109+
kubectl wait --timeout=5m -n nginx-gateway deployment/ngf-nginx-gateway-fabric --for=condition=Available
63110

64111
### Install from sources {#install-from-sources}
65112
<!-- Corresponds to step 4 in the UX -->

0 commit comments

Comments
 (0)