Skip to main content

ims orchestration allocation update

Update allocation.

Synopsis​

The update command allows you to do a full update of the allocation. The command takes a JSON payload (UpdateAllocationV0Body) either through a pipe or using the --file flag.

The JSON payload contains:

  • name: the new name of the allocation (optional).
  • specification: the specification of the allocation detailing things like the max/min payloads, buffer size, image, the command to run, the ports to expose, etc.

It should be in the following format:

{
  "name": "Updated allocation name",
  "spec": {
    "buffer_size": "",
    "cluster_id": "",
    "expiry_time": "0001-01-01T00:00:00.000Z",
    "max_payloads": 0,
    "min_payloads": 0,
    "payload_spec": {
      "command": "",
      "args": [],
      "environment_variables": [],
      "image": "",
      "ports": [],
      "resources": {
        "cpu": null,
        "memory": null
      }
    }
  }
}

For more details on the UpdateAllocationV0Body please refer to the OpenAPI specification https://docs.ims.improbable.io/openapi/ims-zeuz/orchestration-api#operation/UpdateAllocationV0

ims orchestration allocation update [flags]

Examples​

ims orchestration allocation update --project-id alpha-beta-123456 --allocation-id 1a2b3c4d-1a2b-3c4d-5e6f-1a2b3c4d5e6f --file ./UpdateAllocationV0Body.json
cat ./UpdateAllocationV0Body.json | ims orchestration allocation update --project-id alpha-beta-123456 --allocation-id 1a2b3c4d-1a2b-3c4d-5e6f-1a2b3c4d5e6f

Options​

      --allocation-id string   ID of the allocation to update (required)
      --file string            path to a json file that contains the UpdateAllocationV0Body
  -h, --help                   help for update
      --project-id string      IMS project ID of the allocation to update (required)

Options inherited from parent commands​

      --ci                   include this when running in a CI environment, this switches to the IMS service account authentication flow
      --config string        config file location, defaults to $HOME/.ims
      --output-type string   command output type (human/json) (default "human")

SEE ALSO​