Skip to content

cub function set

cub function set

Run mutating functions on units

Synopsis

Run one or more mutating functions on units.

Only functions whose signature has Mutating=true are accepted; non-mutating functions are rejected. For inspection use 'cub function get'; for validation use 'cub function vet'.

Common idioms: cub function set --dry-run -o mutations set-image nginx nginx:1.25 cub function set --show data set-replicas 3

cub function set <function> [<arg1> ...] [flags]

Options

      --change-desc string         change description
      --changeset string           changeset to associate units with
      --dry-run                    dry run mode: execute functions but skip updating configuration data
      --filter string              Filter entity to apply to the list. Specify as 'space/filter' for cross-space filters or just 'filter' for current space. Supports both slugs and UUIDs. The filter will be combined with any --where clause using AND logic. Examples: "production-filters/security-check", "my-filter-uuid", "validation-rules"
  -h, --help                       help for set
      --invocation strings         execute invocations by UUID, slug, or space/slug (can be repeated or comma-separated)
      --livestate-type string      Invoke the function on the live state and use the flag value as the toolchain type for live state.
      --other-data-source string   additional data source to pass to functions (e.g., LiveRevisionNum)
  -o, --output string              Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
  -O, --output-file string         Write payload to FILE. Accepts {space}, {unit}, {section} placeholders.
      --quiet                      No default output.
      --resource-type string       resource-type filter
      --revision string            target a specific revision (format: unit-slug/revision-number, e.g. mydeployment/3)
      --show string                Select which part of the function response to display. One of: output, values, data
      --timeout string             completion timeout as a duration with units, such as 10s or 2m (default "10m0s")
      --toolchain string           Toolchain type for the function invocations (default "Kubernetes/YAML")
      --trigger strings            execute triggers by UUID, slug, or space/slug (can be repeated or comma-separated)
      --unit strings               target specific units by slug or UUID (can be repeated or comma-separated)
      --update-apply-gates         update ApplyGates on units based on trigger results (requires --trigger)
      --verbose                    Detailed output, additive with default output
      --wait                       wait for completion (default true)
      --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. Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'"
      --where-data string          where data filter
      --where-resource string      filter which resources the function operates on
      --worker string              worker to execute the function

Options inherited from parent commands

      --context string          The context to use for this command
      --debug                   Debug output
      --executor-space string   Space ID or slug whose executor to use for builtin functions (org-level only)
      --space string            space ID to perform command on

SEE ALSO