Updating a deployment

Updating deployment details from the UI

1. From the Deployments tab of your deployment space, click the action menu for the deployment and choose Edit configuration.
2. Make the required updates and then click Save.

Tip: You can also update a deployment from the information sheet for the deployment. To do that:

1. Click the deployment name to view the details.
2. Click one of the Edit icons in the information sheet to edit the deployment.

Notes
If in the deployment details you see a warning next to the Deployment owner section, it means that the previous deployment owner left the space and the deployment must be assigned to a new owner. In this situation, only a space administrator can assign a new deployment owner. Refer to Deployment space collaborator roles and permissions.

For details, refer to Updating deployment details by using the Patch API command.

Updating deployment details by using the Patch API command

Use the Watson Machine Learning API Patch command to update deployment details.

curl -X PATCH '<deployment endpoint url>/ml/v4/deployments/<deployment id>?space_id=<space id>&version=<YYYY-MM-DD>' \n--data-raw '[
    {
        "op": "<operation type>",
        "path": "<path>",
        "value": "<new value>"
    },
    {
        "op": "<operation type>",
        "path": "<path>",
        "value": "<new value>"
    }
]'

For example, to update a description for deployment:

curl -X PATCH '<deployment endpoint url>/ml/v4/deployments/<deployment_id>?space_id=<space_id>&version=<YYYY-MM-DD>' \n--data-raw '[
    {
        "op": "replace",
        "path": "/description",
        "value": "<new_description>"
    },
]'

Notes:

• For <operation type>, use "add", "remove", or "replace".

• If you are updating the current deployment owner, only a replace operation is allowed. This operation can only be performed by an admin of the space. New owner must either be a space admin or an editor. Refer to Deployment space collaborator roles and permissions.

Updating an asset from the deployment space UI

1. From the Deployments tab of your deployment space, click the action menu for the deployment and choose Replace asset.

2. Select the asset that you want to replace and click Replace.

3. Drag or upload a new asset to replace the deployed asset.

   Note: Deployed Shiny apps that were created by using code packages can be updated directly from the UI. This can be done by updating the app's underlying code package asset or updating the app's folder path.

4. Wait for the notification message that confirms a successful update, then test the new deployment.

You can import a space or a project, including data assets, into an existing space. This way you can update existing assets. Refer to Importing spaces and projects into existing deployment spaces.

Updating an asset by using the Patch API command

Use the Watson Machine Learning API Patch command to update any supported asset, except for RShiny apps.

Use this method to patch a model for an online deployment.

curl -X PATCH '<deployment endpoint url>/ml/v4/models/<model_id>?space_id=<space_id>&project_id=<project_id>&version=<YYYY-MM-DD>' \n--data-raw '[
    {
        "op": "<operation type>",
        "path": "<path>",
        "value": "<new value>"
    },
    {
        "op": "<operation type>",
        "path": "<path>",
        "value": "<new value>"
    }
]'

For example, patch a model with ID 6f01d512-fe0f-41cd-9a52-1e200c525c84 in space ID f2ddb8ce-7b10-4846-9ab0-62454a449802:

curl -X PATCH '<deployment endpoint url>/ml/v4/models/6f01d512-fe0f-41cd-9a52-1e200c525c84?space_id=f2ddb8ce-7b10-4846-9ab0-62454a449802&project_id=<project_id>&version=<YYYY-MM-DD>' \n--data-raw '[

   {
      "op":"replace",
      "path":"/asset",
      "value":{
         "id":"6f01d512-fe0f-41cd-9a52-1e200c525c84",
         "rev":"1"
      }
   }
]'

A successful output response looks like this:

{
  "entity": {
    "asset": {
      "href": "/v4/models/6f01d512-fe0f-41cd-9a52-1e200c525c84?space_id=f2ddb8ce-7b10-4846-9ab0-62454a449802",
      "id": "6f01d512-fe0f-41cd-9a52-1e200c525c84"
    },
    "custom": {
    },
    "description": "Test V4 deployments",
    "name": "test_v4_dep_online_space_hardware_spec",
    "online": {
    },
    "space": {
      "href": "/v4/spaces/f2ddb8ce-7b10-4846-9ab0-62454a449802",
      "id": "f2ddb8ce-7b10-4846-9ab0-62454a449802"
    },
    "space_id": "f2ddb8ce-7b10-4846-9ab0-62454a449802",
    "status": {
      "online_url": {
        "url": "https://example.com/v4/deployments/349dc1f7-9452-491b-8aa4-0777f784bd83/predictions"
      },
      "state": "updating"
    }
  },
  "metadata": {
    "created_at": "2020-06-08T16:51:08.315Z",
    "description": "Test V4 deployments",
    "guid": "349dc1f7-9452-491b-8aa4-0777f784bd83",
    "href": "/v4/deployments/349dc1f7-9452-491b-8aa4-0777f784bd83",
    "id": "349dc1f7-9452-491b-8aa4-0777f784bd83",
    "modified_at": "2020-06-08T16:55:28.348Z",
    "name": "test_v4_dep_online_space_hardware_spec",
    "parent": {
      "href": ""
    },
    "space_id": "f2ddb8ce-7b10-4846-9ab0-62454a449802"
  }
}

Notes:

• For <operation type>, use "add", "remove", or "replace".

• The initial state for the PATCH API output is "updating". Keep polling the status until it changes to "ready", then retrieve the deployment meta.

• Only the ASSET attribute can be specified for the asset patch. Changing any other attribute will result in an error.

• The schema of the current model and the model being patched is compared to the deployed asset. A warning message is returned in the output of the Patch request API if the two don't match. For example, if a mismatch is detected, you can find this information in the output response.

  "status": {
        "message": {
          "text": "The input schema of the asset being patched does not match with the currently deployed asset. Please ensure that the score payloads are up to date as per the asset being patched."
        },
  

• For information on patching software specifications, refer to Updating software specifications by using the API.

Parent topic: Managing deployments