Skip to content

cub release update

cub release update

Update a release

Synopsis

Update a release, identified by its globally-unique release ID.

Only a release's labels, annotations, and delete gates can be updated. The bundled configuration a release was published with is fixed, and so is the name it is stored under -- the release's OCI manifest records that -- and whether it is published: use cub release withdraw to take a release out of service, and publish a new release to change what is bundled or what the bundle is called.

The release is located by its ID regardless of which Space it lives in, so --space is not required (a Release lives in its bundled Units' Space, which need not be the caller's default).

By default the release is read and sent back with the requested changes applied. Pass --patch to send just the changes instead, which is also what removes a label, annotation, or delete gate: --label key=- --annotation key=- --delete-gate name=-.

Examples:

  # Label a release
  cub release update 61f26b06-3c34-4363-8b9d-7d0a7c2b5f1c --label environment=production

  # Gate a release against deletion
  cub release update 61f26b06-3c34-4363-8b9d-7d0a7c2b5f1c --delete-gate retention/30-days

  # Clear that gate again
  cub release update --patch 61f26b06-3c34-4363-8b9d-7d0a7c2b5f1c --delete-gate retention/30-days=-

  # Update from a file
  cub release update 61f26b06-3c34-4363-8b9d-7d0a7c2b5f1c --filename release.yaml
cub release update <release-id> [flags]

Options

      --annotation strings     annotations in key=value format; can separate by commas and/or use multiple instances of the flag
      --delete-gate strings    delete gates in key[=true] format; can separate by commas and/or use multiple instances of the flag
      --dry-run                report what the command would write, and write nothing
      --filename string        Read the ConfigHub entity's fields, as YAML or JSON, from file, URL (https://), or stdin (-), as --from-stdin does; mutually exclusive with --from-stdin
      --from-stdin             Read the ConfigHub entity's fields, as YAML or JSON, from stdin; merged with command arguments on create, and merged with command arguments and existing entity on update. A field the entity does not have, or one only the server sets, is refused; cub <entity> explain lists the fields
  -h, --help                   help for update
      --hidden-reason string   hide the entity, giving the reason as a name such as Archived: lists and bulk operations leave it out unless --include-hidden names the reason (use '-' to clear, which shows the entity again)
      --label strings          labels in key=value format; can separate by commas and/or use multiple instances of the flag
  -o, --output string          Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --patch                  use the patch API, sending only the changes; required to remove a label, annotation, or delete gate
      --permission strings     permission in format Action:UserIDOrUsername, Action:group:GroupSlugOrID or Action:serviceaccount:ServiceAccountSlugOrID to add, or the same prefixed with - to remove (e.g., Manage:user@example.com, View:group:platform, View:serviceaccount:deploy-bot, -View:user@example.com, can be repeated)
      --quiet                  No default output.
      --replace                Replace entity instead of merging when using --from-stdin or --filename
      --verbose                Detailed output, additive with default output

Options inherited from parent commands

      --component string   the Component of --variant, when that names the variant alone; --variant <component>/<variant> says the same in one flag
      --context string     The context to use for this command
      --debug              Debug output
      --space string       space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>
      --variant string     variant to operate in, as <component>/<variant>, or as <variant> with --component: the space naming that Component whose Variant label is <variant>. The same scope as --space, named by what it is rather than by the space's slug; the two cannot be combined

SEE ALSO