Skip to content

cub component delete

cub component delete

Delete a component or multiple components

Synopsis

Delete a Component entity, or the Components --where selects.

A Component is not deleted while spaces name it as their variants. --recursive deletes those first, with their units, in one request, so that a deployment and the base it was cloned from go together; a unit with a delete gate still stops it unless --force is given, and a reference from outside the component stops it unless --detach is given.

Examples:

  cub component delete my-app

  # Delete a component together with every one of its variants
  cub component delete --recursive my-app

  # Delete the components whose backing Units are empty, keeping the Units
  cub component delete --from-backing-units --where "Labels.team = 'platform'"
cub component delete [<name or id>] [flags]

Options

      --detach                        Remove the references other entities have to what is deleted, instead of refusing the delete while any remain
      --force                         with --recursive, delete the variants' units even if some have delete gates
      --from-backing-units            prune: delete only the components selected whose backing Units are empty, which says they should not exist, and keep the Units; the rest are left alone
  -h, --help                          help for delete
      --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
  -o, --output string                 Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --quiet                         No default output.
      --recursive                     also delete the component's variants, with everything in them
      --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

Options inherited from parent commands

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

SEE ALSO