Skip to content

cub component update

cub component update

Update a component or multiple components

Synopsis

Update a Component entity.

Changing which ChangeWorkflows a component allows, whether one is required, whether changes have to be tracked, or its permissions requires Manage permission on the component. ChangeWorkflows are addressed as / or by UUID; prefix one with '-' to stop allowing it.

Examples:

  # Allow another ChangeWorkflow and stop allowing one
  cub component update --patch my-app \
    --allowed-change-workflow platform/canary-rollout \
    --allowed-change-workflow -platform/hotfix

  # Stop requiring a ChangeWorkflow to promote and release
  cub component update --patch my-app --require-change-workflow=false

  # Require every change to the configuration of the variants' units to be made in a ChangeSet
  # or under a ChangeOrder
  cub component update --patch my-app --require-change-tracking

  # Replace the component from a JSON definition
  cub component update my-app --from-stdin --replace < component.json

  # Give every component a backing Unit, in the platform space, holding its configuration
  cub component update --patch --where "Slug LIKE '%'" --with-backing-units --backing-unit-space platform

With no name, --patch updates every component --where selects.

cub component update [<name or id>] [flags]

Options

      --allowed-change-workflow strings   ChangeWorkflow, as <space>/<slug> or UUID, to allow, or -<ChangeWorkflow> to stop allowing (can be repeated or comma-separated)
      --annotation strings                annotations in key=value format; can separate by commas and/or use multiple instances of the flag
      --backing-unit-space string         space, by slug or UUID, for the backing Units --with-backing-units creates; required with it, since a Component is in no space of its own
      --delete-gate strings               delete gates in key[=true] format; can separate by commas and/or use multiple instances of the flag
      --display-name string               friendly name for the entity, which need not be unique or URL-safe; an entity without one is shown by its slug
      --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-backing-units                patch each Component selected with what its backing Unit holds that it has not taken yet; the patch the other flags make is applied after it
      --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)
      --include-hidden string[="*"]       Also select hidden entities, to list or to act on: those hidden for the given HiddenReasons, comma-separated, as in --include-hidden=BackingUnit, or for any reason when given no value or "*". ConfigHub/YAML Units, which hold the configuration of other entities, are hidden with the reason BackingUnit. A --where naming entities by Slug or ID selects them whether hidden or not
      --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 patch API
      --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
      --require-change-tracking           require changes to the configuration of the variants' units to be made in a changeset open on the unit or under a change order
      --require-change-workflow           require a ChangeWorkflow to promote and release, and to open a changeset on the variants' units
      --set stringArray                   set a field of the Component by its path, as <path>=<value> (repeatable). A path is field names separated by dots; a list element is addressed as ?<key>=<value> or by position, as in Stages.?Name=prod.WhereSpace, and is added if it is not there. A list of plain values separates them with ';'; an object or a list of objects is given as YAML or JSON. A reference is given as it is elsewhere, by slug, <space>/<slug> or ID. With --patch, only a path with no list element in it
      --unset stringArray                 clear a field of the Component by its path, or remove the list element the path ends at (repeatable)
      --verbose                           Detailed output, additive with default output
      --where string                      Filter expression using SQL-inspired syntax. Supports conjunctions with AND. String operators: =, !=, <, >, <=, >=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*. Pattern matching with LIKE/ILIKE uses % and _ wildcards. Regex operators (~, ~*, !~, !~*) support POSIX regular expressions. A related entity is referenced by prefix, as in "UpstreamUnit.Slug = 'base'"; when the reference names a list, a * segment matches any element, as in "FromLink.*.Slug = 'upgrade-app'". Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'". 'cub <entity> explain --where' lists the attributes an entity's expressions can name
      --with-backing-units                give each Component the bulk operation writes a backing Unit if it has none: a ConfigHub/YAML Unit holding its configuration, kept in step with it

Options inherited from parent commands

      --context string   The context to use for this command
      --debug            Debug output

SEE ALSO