You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/includes/nim/kubernetes/access-webui-helm.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -23,4 +23,4 @@ You can access the NGINX Instance Manager web interface using the external IP ad
23
23
24
24
For example, `https://10.108.57.167/ui`.
25
25
26
-
This IP address might not be reachable, depending on how the Kubernetes cluster networking was configured. If so, the `apigw` service type can be changed to a more suitable option, such as `LoadBalancer`, by changing the [Configurable Helm Setting]({{< relref "/nim/deploy/kubernetes/helm-config-settings.md" >}}) value for `nms-hybrid.apigw.service.type`.
26
+
This IP address might not be reachable, depending on how the Kubernetes cluster networking was configured. If so, the `apigw` service type can be changed to a more suitable option, such as `LoadBalancer`, by changing the [Configurable Helm Setting]({{< relref "/nim/deploy/kubernetes/helm-config-settings.md" >}}) value for `apigw.service.type`.
@@ -55,20 +55,30 @@ Create a Docker registry secret on the cluster, using the JWT token as the usern
55
55
56
56
-**Kubernetes**:
57
57
58
+
```shell
59
+
kubectl create namespace nms
60
+
```
61
+
58
62
```shell
59
63
kubectl create secret docker-registry regcred \
60
64
--docker-server=private-registry.nginx.com \
61
65
--docker-username=<JWT Token> \
62
-
--docker-password=none
66
+
--docker-password=none \
67
+
-n nms
63
68
```
64
69
65
70
-**OpenShift**:
66
71
72
+
```shell
73
+
oc new-project nms
74
+
```
75
+
67
76
```shell
68
77
oc create secret docker-registry regcred \
69
78
--docker-server=private-registry.nginx.com \
70
79
--docker-username=<JWT Token> \
71
-
--docker-password=none
80
+
--docker-password=none \
81
+
-n nms
72
82
```
73
83
74
84
{{< warning >}}
@@ -84,13 +94,13 @@ To confirm the secret is created:
84
94
-**Kubernetes**:
85
95
86
96
```shell
87
-
kubectl get secret regcred --output=yaml
97
+
kubectl get secret regcred --output=yaml -n nms
88
98
```
89
99
90
100
-**OpenShift**:
91
101
92
102
```shell
93
-
oc get secret regcred --output=yaml
103
+
oc get secret regcred --output=yaml -n nms
94
104
```
95
105
96
106
@@ -127,37 +137,36 @@ The `values.yaml` file customizes the Helm chart installation without modifying
127
137
{{< see-also >}} For details 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 >}}
@@ -169,65 +178,24 @@ The `values.yaml` file customizes the Helm chart installation without modifying
169
178
If deploying on OpenShift, include this setting in the `values.yaml` file:
170
179
171
180
```yaml
172
-
nms-hybrid:
173
-
openshift:
174
-
enabled: true
181
+
openshift:
182
+
enabled: true
175
183
```
176
184
177
185
### How OpenShift handles security constraints
178
186
179
187
When `openshift.enabled: true` is set in the `values.yaml` file, the NGINX Instance Manager deployment automatically creates a **custom Security Context Constraint (SCC)** and links it to the Service Account used by all pods.
180
188
181
-
By default, OpenShift enforces strict security policies that require containers to run as **non-root** users. The NGINX Instance Manager deployment needs specific user IDs (UIDs) for certain services, such as **1000** for `nms` and **101** for `nginx` and `clickhouse`. Since the default SCCs do not allow these UIDs, a **custom SCC** is created. This ensures that the deployment can run with the necessary permissions while maintaining OpenShift’s security standards.
189
+
By default, OpenShift enforces strict security policies that require containers to run as **non-root** users. The NGINX Instance Manager deployment needs specific user IDs (UIDs) for certain services, such as **1000** for `nms` and **101** for `nginx` and `clickhouse`. Since the default SCCs do not allow these UIDs, a **custom SCC** is created. This ensures that the deployment can run with the necessary permissions while maintaining OpenShift’s security standards. The custom SCC allows these UIDs by setting the `runAsUser` field, which controls which users can run containers.
190
+
191
+
{{< note >}} If you’re encountering errors with the custom [Security Context Constraints](https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/authentication_and_authorization/managing-pod-security-policies), you may not have permissions to access the Security Context Constraints resource. Please contact a Cluster Administrator to request access, either through a cluster role binding or by adjusting your user role. {{< /note >}}
182
192
183
-
The custom SCC allows these UIDs by setting the `runAsUser` field, which controls which users can run containers. To verify that the SCC has been created, run:
193
+
To verify that the custom SCC has been created, after installing the helm chart, run:
184
194
185
195
```shell
186
196
oc get scc nms-restricted-v2-scc --output=yaml
187
197
```
188
198
189
-
190
-
---
191
-
192
-
193
-
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.
194
-
195
-
By default, the following network policies will be created in the release namespace:
To disable network policies, update the `values.yaml` file:
224
-
225
-
```yaml
226
-
networkPolicies:
227
-
# Set this to true to enable network policies for NGINX Instance Manager.
228
-
enabled: false
229
-
```
230
-
231
199
---
232
200
233
201
## Install the chart
@@ -239,19 +207,19 @@ Run the `helm install` command to deploy NGINX Instance Manager:
239
207
240
208
{{< important >}} Remember to save the password for future use. Only the encrypted password is stored, and there's no way to recover or reset it if lost. {{< /important >}}
241
209
242
-
(Optional) Replace `<nms-chart-version>` with the desired chart version. If omitted, the latest version will be installed.
210
+
(Optional) Replace `<chart-version>` with the desired chart version. If omitted, the latest version will be installed. Currently only version 2.19.0 is supported.
To help you choose the right NGINX Instance Manager chart version, see the table in:
222
+
To help you choose the right NGINX Instance Manager chart version, see the following table (through version v2.18.0):
255
223
256
224
{{< include "nim/kubernetes/nms-chart-supported-module-versions.md" >}}
257
225
@@ -289,14 +257,16 @@ To upgrade:
289
257
290
258
1. [Update the Helm repository list](#add-helm-repository).
291
259
1. [Adjust your `values.yaml` file](#create-a-helm-deployment-values.yaml-file) if needed.
292
-
1. To upgrade the NGINX instance deployment, run the following command. This command updates the `nms` deployment with a new version from the `nginx-stable/nms` repository. It also hashes the provided password and uses the `values.yaml` file at the path you specify.
260
+
1. To upgrade the NGINX Instance Manager deployment, run the following command. This command updates the `nms` deployment with a new version from the `nginx-stable/nms-hybrid` repository. It also hashes the provided password and uses the `values.yaml` file at the path you specify.
261
+
262
+
(Optional) Replace `<chart-version>` with the desired chart version. If omitted, the latest version will be installed. Currently only version 2.19.0 is supported.
0 commit comments