Skip to main content

service update

To update an existing service in an enclave, run:

kurtosis service update $THE_ENCLAVE_IDENTIFIER $THE_SERVICE_IDENTIFIER [flags]

where $THE_ENCLAVE_IDENTIFIER and $THE_SERVICE_IDENTIFIER are resource identifiers for the enclave and service, respectively.

This command updates a service in-place by modifying its configuration. Only the specified parameters will be changed — the rest of the service config will remain as-is.

Much like docker run, this command has multiple options available to customize the updated service:

  1. The --image flag can be used to update the service’s container image
  2. The --entrypoint flag can override the binary the service runs
  3. The --env flag can be used to set or override environment variables. Env var overrides with the same key will override existing env vars.
  4. The --ports flag can be used to add or override private port definitions. Port overrides with the same port id will override existing port bindings.
  5. The --files flag can be used to mount new file artifacts. Files artifacts overrides with the same key will override existing files artifact mounts.
  6. The --cmd flag can be used to override the CMD that is run when the container starts

Example:

kurtosis service update my-enclave test-service \
  --image my-custom-image \
  --entrypoint my-binary \
  --env "FOO:bar,BAR:baz" \
  --ports "port1:8080/tcp"
Restarted Container

This command replaces the existing service with a new container using the updated configuration. The service will be briefly stopped and restarted as part of this process.