Skip to content

Commit b41f5ff

Browse files
mkingstADubhlaoichmjang
authored
Simplify NIM helm Instructions - Update deploy-using-helm.md (#130)
* Update deploy-using-helm.md * Update deploy-using-helm.md * Update content/nim/deploy/kubernetes/deploy-using-helm.md --------- Co-authored-by: Alan Dooley <a.dooley@f5.com> Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>
1 parent fb92ed5 commit b41f5ff

File tree

1 file changed

+39
-113
lines changed

1 file changed

+39
-113
lines changed

content/nim/deploy/kubernetes/deploy-using-helm.md

Lines changed: 39 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -49,85 +49,9 @@ To deploy NGINX Instance Manager using a Helm chart, you need:
4949

5050
### Using Docker
5151

52-
#### Configure Docker to access the NGINX Instance Manager public registry
53-
54-
{{< include "nim/docker/docker-registry-login.md" >}}
55-
56-
#### Pull the NGINX Instance Manager images
57-
You can now pull the necessary images for NGINX Instance Manager from the private registry at `private-registry.nginx.com`.
58-
59-
Replace `<version-tag>` with the specific version you want to use.
60-
61-
{{< note >}} The `latest` tag is not supported. {{< /note >}}
62-
63-
```shell
64-
docker pull private-registry.nginx.com/nms/apigw:<version-tag>
65-
docker pull private-registry.nginx.com/nms/core:<version-tag>
66-
docker pull private-registry.nginx.com/nms/dpm:<version-tag>
67-
docker pull private-registry.nginx.com/nms/ingestion:<version-tag>
68-
docker pull private-registry.nginx.com/nms/integrations:<version-tag>
69-
docker pull private-registry.nginx.com/nms/utility:<version-tag>
70-
```
71-
72-
If needed, you can push these images to your own private registry.
73-
74-
#### Push images to your private registry
75-
76-
After pulling the images, tag them and upload them to your private registry.
77-
78-
1. Log in to your private registry:
79-
80-
```shell
81-
docker login <my-docker-registry>
82-
```
83-
84-
2. Tag and push each image. Replace `<my-docker-registry>` with your registry’s path and `<version-tag>` with the version you’re using (for example, `2.17.0`):
85-
86-
- For the `apigw` image:
87-
88-
```shell
89-
docker tag private-registry.nginx.com/nms/apigw:<version-tag> <my-docker-registry>/nms/apigw:<version-tag>
90-
docker push <my-docker-registry>/nms/apigw:<version-tag>
91-
```
92-
93-
- For the `core` image:
94-
95-
```shell
96-
docker tag private-registry.nginx.com/nms/core:<version-tag> <my-docker-registry>/nms/core:<version-tag>
97-
docker push <my-docker-registry>/nms/core:<version-tag>
98-
```
99-
100-
- For the `dpm` image:
101-
102-
```shell
103-
docker tag private-registry.nginx.com/nms/dpm:<version-tag> <my-docker-registry>/nms/dpm:<version-tag>
104-
docker push <my-docker-registry>/nms/dpm:<version-tag>
105-
```
106-
107-
- For the `ingestion` image:
108-
109-
```shell
110-
docker tag private-registry.nginx.com/nms/ingestion:<version-tag> <my-docker-registry>/nms/ingestion:<version-tag>
111-
docker push <my-docker-registry>/nms/ingestion:<version-tag>
112-
```
113-
114-
- For the `integrations` image:
115-
116-
```shell
117-
docker tag private-registry.nginx.com/nms/integrations:<version-tag> <my-docker-registry>/nms/integrations:<version-tag>
118-
docker push <my-docker-registry>/nms/integrations:<version-tag>
119-
```
120-
121-
- For the `utility` image:
122-
123-
```shell
124-
docker tag private-registry.nginx.com/nms/utility:<version-tag> <my-docker-registry>/nms/utility:<version-tag>
125-
docker push <my-docker-registry>/nms/utility:<version-tag>
126-
```
127-
12852
### Using Helm with a JWT token
12953

130-
If you don't need a private registry, you can use a JWT token as a Docker configuration secret with Helm charts.
54+
You can use your NGINX JWT as a Docker configuration secret with Helm charts.
13155

13256
Create a Docker registry secret on the cluster, using the JWT token as the username and `none` as the password. The Docker server is `private-registry.nginx.com`.
13357

@@ -179,8 +103,8 @@ The `values.yaml` file customizes the Helm chart installation without editing th
179103

180104
1. Create a `values.yaml` file similar to this example:
181105

182-
- Replace `<my-docker-registry:port>` with your private Docker registry and port (if needed).
183106
- In the `imagePullSecrets` section, add the credentials for your private Docker registry.
107+
- Change the version tag to the version of NGINX Instance Manager you would like to install. See "Install the chart" below for versions.
184108

185109
{{< see-also >}} For more on creating a secret, see Kubernetes [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). {{</ see-also >}}
186110

@@ -190,27 +114,27 @@ The `values.yaml` file customizes the Helm chart installation without editing th
190114
- name: regcred
191115
apigw:
192116
image:
193-
repository: <my-docker-registry:port>/nms-apigw
117+
repository: private-registry.nginx.com/nms-apigw
194118
tag: <version>
195119
core:
196120
image:
197-
repository: <my-docker-registry:port>/nms-core
121+
repository: private-registry.nginx.com/nms-core
198122
tag: <version>
199123
dpm:
200124
image:
201-
repository: <my-docker-registry:port>/nms-dpm
125+
repository: private-registry.nginx.com/nms-dpm
202126
tag: <version>
203127
ingestion:
204128
image:
205-
repository: <my-docker-registry:port>/nms-ingestion
129+
repository: private-registry.nginx.com/nms-ingestion
206130
tag: <version>
207131
integrations:
208132
image:
209-
repository: <my-docker-registry:port>/nms-integrations
133+
repository: private-registry.nginx.com/nms-integrations
210134
tag: <version>
211135
utility:
212136
image:
213-
repository: <my-docker-registry:port>/nms-utility
137+
repository: private-registry.nginx.com/nms-utility
214138
tag: <version>
215139
```
216140
@@ -220,36 +144,7 @@ The `values.yaml` file customizes the Helm chart installation without editing th
220144

221145
---
222146

223-
## Manage network policies
224147

225-
To apply network policies for NGINX Instance Manager, ensure Kubernetes has a [network plugin](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) installed before the Helm chart installation.
226-
227-
By default, the following network policies will be created in the release namespace:
228-
229-
```shell
230-
kubectl get netpol -n nms
231-
```
232-
233-
```text
234-
NAME POD-SELECTOR AGE
235-
apigw app.kubernetes.io/name=apigw 4m47s
236-
clickhouse app.kubernetes.io/name=clickhouse 4m47s
237-
core app.kubernetes.io/name=core 4m47s
238-
dpm app.kubernetes.io/name=dpm 4m47s
239-
ingestion app.kubernetes.io/name=ingestion 4m47s
240-
integrations app.kubernetes.io/name=integrations 4m47s
241-
utility app.kubernetes.io/name=integrations 4m47s
242-
```
243-
244-
To disable network policies, update the `values.yaml` file:
245-
246-
```yaml
247-
networkPolicies:
248-
# Set this to true to enable network policies for NGINX Instance Manager.
249-
enabled: false
250-
```
251-
252-
---
253148

254149
## Install the chart
255150

@@ -342,6 +237,37 @@ This deletes the `nms` application and all associated Kubernetes resources.
342237

343238
---
344239

240+
## Manage network policies
241+
242+
To apply network policies for NGINX Instance Manager, ensure Kubernetes has a [network plugin](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) installed before the Helm chart installation.
243+
244+
By default, the following network policies will be created in the release namespace:
245+
246+
```shell
247+
kubectl get netpol -n nms
248+
```
249+
250+
```text
251+
NAME POD-SELECTOR AGE
252+
apigw app.kubernetes.io/name=apigw 4m47s
253+
clickhouse app.kubernetes.io/name=clickhouse 4m47s
254+
core app.kubernetes.io/name=core 4m47s
255+
dpm app.kubernetes.io/name=dpm 4m47s
256+
ingestion app.kubernetes.io/name=ingestion 4m47s
257+
integrations app.kubernetes.io/name=integrations 4m47s
258+
utility app.kubernetes.io/name=integrations 4m47s
259+
```
260+
261+
To disable network policies, update the `values.yaml` file:
262+
263+
```yaml
264+
networkPolicies:
265+
# Set this to true to enable network policies for NGINX Instance Manager.
266+
enabled: false
267+
```
268+
269+
---
270+
345271
## Troubleshooting
346272

347273
For instructions on creating a support package to share with NGINX Customer Support, see [Create a Support Package from a Helm Installation]({{< relref "/nms/support/k8s-support-package.md" >}}).

0 commit comments

Comments
 (0)