Update Configuration#

Update an existing NIM deployment configuration by specifying the namespace and the configuration name of the configuration.

Prerequisites#

Before you can update a NIM deployment configuration, make sure that you have:

Access to the NeMo Deployment Management service through the NeMo platform host if you have installed the NeMo platform or the independent base URL if you have installed the service individually. Store the base URL in an environment variable DEPLOYMENT_BASE_URL.
The namespace and name of the configuration to update.

To Update a Configuration#

Choose one of the following options of updating a configuration.

Python SDK

Create a NeMoMicroservices client instance using the base URL of the NeMo Deployment Management microservice and perform the task as follows.

from nemo_microservices import NeMoMicroservices

client = NeMoMicroservices(
    base_url=os.environ["DEPLOYMENT_MANAGEMENT_BASE_URL"],
    inference_base_url=os.environ["NIM_PROXY_BASE_URL"]
)

response = client.deployment.configs.update(
    "your-custom-config",
    namespace="your-namespace",
    description="Updated custom configuration",
    nim_deployment={
        "image_name": "string",
        "image_tag": "string",
        "gpu": 0,
        "additional_envs": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "namespace": "string"
    },
)
print(response)

cURL

Make a PATCH request to the /v1/deployment/configs/<namespace>/<config_name> endpoint.

For more details on the request body, see the Deployment Management API reference.

curl -X PATCH \
  "${DEPLOYMENT_BASE_URL}/v1/deployment/configs/<namespace>/<config_name>" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "model": "string",
    "nim_deployment": {
      "image_name": "string",
      "image_tag": "string",
      "gpu": 0,
      "additional_envs": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "namespace": "string"
    },
    "external_endpoint": {
      "host_url": "https://example.com/",
      "api_key": "string",
      "enabled_models": [
        "string"
      ]
    },
    "schema_version": "1.0",
    "project": "string",
    "custom_fields": {},
    "ownership": {
      "created_by": "",
      "access_policies": {}
    }
  }' | jq

Tip

You can update any field of the configuration. Only the fields you include in the request will be updated.