Skip to content

Commit 9971e59

Browse files
committed
docs: clarify managed job API egress policy
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
1 parent 8277f67 commit 9971e59

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

k8s/helm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ The generated `networkPolicies` values reference remains in the table below.
432432
| networkPolicies.jobs.externalEgress.ports | list | `[]` | Optional list of ports for external egress. Empty allows all ports to the configured ipBlocks. |
433433
| networkPolicies.jobs.extraEgress | list | `[]` | Extra NetworkPolicy egress rules appended to the managed job policy, for cluster-specific dependencies or additional allowed CIDRs. |
434434
| networkPolicies.jobs.platformApi | object | `{"enabled":true,"port":""}` | Allow managed job pods to reach the in-namespace Platform API pods. |
435-
| networkPolicies.jobs.platformApi.enabled | bool | `true` | Enable egress to the platform API pods. |
435+
| networkPolicies.jobs.platformApi.enabled | bool | `true` | Enable the default egress exception to the platform API pods. Disable only when managed job pods should not call the in-namespace API, or when API access is supplied through cluster-specific extraEgress rules. |
436436
| networkPolicies.jobs.platformApi.port | string | `""` | Optional NetworkPolicy port for the platform API. Empty uses api.service.port. |
437437
| networkPolicies.jobs.podSelector | object | `{"matchLabels":{"app":"nemo-job","nmp.nvidia.com/managed_by":"jobs-controller"}}` | Pod selector for managed job pods. The default matches Kubernetes/Volcano pods created by the jobs controller. |
438438
| ngcAPIKey | string | `"YOUR-NGC-API-KEY"` | Your NVIDIA GPU Cloud (NGC) API key authenticates API calls to NGC services, such as model downloads. The existing secret overrides this key if you provide one to the `existingSecret` key. |

k8s/helm/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ networkPolicies:
169169
nmp.nvidia.com/managed_by: jobs-controller
170170
# -- Allow managed job pods to reach the in-namespace Platform API pods.
171171
platformApi:
172-
# -- Enable egress to the platform API pods.
172+
# -- Enable the default egress exception to the platform API pods. Disable only when managed job pods should not call the in-namespace API, or when API access is supplied through cluster-specific extraEgress rules.
173173
enabled: true
174174
# -- Optional NetworkPolicy port for the platform API. Empty uses api.service.port.
175175
port: ""

0 commit comments

Comments
 (0)