Skip to content

cub run vet-immutable

cub run vet-immutable

Validates that immutable fields have not been changed compared to the baseline revision data provided via OtherData. If no OtherData is present (e.g., the unit has never been published), validation passes. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML

cub run vet-immutable [flags]

Options

      --attribute-name string   Name of the attribute whose registered paths to check for immutability. Defaults to 'immutable'.
  -h, --help                    help for vet-immutable

Options inherited from parent commands

      --change-desc string            change description
      --changeset string              changeset to associate units with
      --channel string                channel whose client executes the function, as a run of the command the channel declares for it
      --clearance stringArray         class of guarded reason this change is cleared for, as KEY, KEY=VALUE[;VALUE...], KEY!=VALUE[;VALUE...], or !KEY to refuse any path carrying KEY (repeatable). A guarded path this does not cover is not written, and the withheld change is reported as a conflict
      --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
      --dry-run                       dry run mode: execute functions but skip updating configuration data
      --executor-space string         Space ID or slug whose executor to use for builtin functions (org-level only)
      --filter string                 filter to apply (slug, space/filter, or UUID)
      --guard stringArray             reason to record on the paths this change writes, as KEY=VALUE (repeatable). A later operation must be cleared for it before overwriting those paths, this one included, so --clearance has to cover it. Adds and overwrites only; retiring a guard is cub unit set-guard --remove-guard
      --include-conflicts             pass each unit's outstanding merge conflicts to the functions, for functions that reason about them (e.g. vet-no-merge-conflicts); triggers run with --trigger always get them
      --include-link-findings         pass what the resolves of each unit's links could not do to the functions, for functions that reason about it (e.g. vet-no-link-findings); triggers run with --trigger always get them
      --inherited-guard stringArray   inherited guard to record on the paths this change writes, as KEY=VALUE (repeatable): unlike --guard, a clone of the unit receives it and a merge carries it to the units downstream. --clearance has to cover it, as it covers --guard, and a key may not be given to both
  -o, --output string                 Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --protect                       record the paths this change writes as protected local overrides, so a later merge from upstream does not overwrite them; by default a change claims nothing and each path keeps the protection it already has
      --quiet                         No output
      --resource-type string          select only the units that contain a resource of this type, such as apps/v1/Deployment (with --where-data, one that matches it); it does not narrow which resources the function operates on, so a function such as set-label still changes every resource of each unit selected: use --where-resource for that
      --show string                   Select which part of the function response to display. One of: output, values, data
      --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>; "*" means the same as omitting it
      --toolchain string              Toolchain type for the function invocations (default "Kubernetes/YAML")
      --unit strings                  target specific units by slug or UUID (can be repeated or comma-separated)
      --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
      --wait                          wait for completion
      --where string                  where filter
      --where-data string             where data filter
      --where-resource string         filter which resources the function operates on

SEE ALSO