Skip to content

cub run

cub run

invoke a function

Synopsis

invoke a function

cub run [flags]

Options

      --change-desc string      change description
      --changeset string        changeset to associate units with
      --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
      --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. Adds and overwrites only; retiring a guard is cub unit set-guard --remove-guard
  -h, --help                    help for run
  -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
      --reload                  Reload the function list
      --reset                   Reset the function list
      --resource-type string    resource-type filter
      --show string             Select which part of the function response to display. One of: output, values, data
      --space string            space ID to perform command on
      --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)
      --wait                    wait for completion
      --where string            where filter
      --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

SEE ALSO

  • cub - ConfigHub CLI
  • cub run cel-validate - [Deprecated; use vet-celexpr instead] Returns true if validation expression evaluates to true for all resources. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run compute-mutations - Diffs the previous config data from the parameter with the current config data from the unit and returns a list of resource mutations made to the config data. The output can be used with patch-mutations. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run delete-path - Deletes the specified attribute path. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run delete-resource - Remove the specified resource from the configuration data. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run ensure-context - [Deprecated] It is recommended to bridge implementers to do this in the bridge instead so as not to clutter configuration data. Set function context values (e.g., unit slug, space ID) in configuration resource/element attributes (if possible) if add-context is true and remove the context if false. These values can be used to find the corresponding unit in ConfigHub, such as with cub k8s source. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run ensure-namespaces - Ensure every namespaced resource has a namespace field by adding one with the placeholder value if it is not present. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run generate-kubecontext - Generates a time-bound kubeconfig for an existing ServiceAccount. The ServiceAccount must have the confighub.com/generate-kubecontext: allow annotation. The kubeconfig is encrypted with the caller's X25519 public key. Supported toolchains: Kubernetes/YAML
  • cub run get-annotation - Get an annotation. Supported toolchains: Kubernetes/YAML
  • cub run get-attribute - Returns values of a specified registered attribute. See https://docs.confighub.com/guide/functions/#getters-and-setters-attributes-and-the-path-registry for more information about registered attributes. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-bool-path - Returns the value(s) of the specified attribute path. Supported toolchains: AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-cel - Extracts attribute values from configuration resources using a CEL expression that returns a list of attribute value maps. Evaluated once per resource. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-container-flag - Get the value of a POSIX-style flag (--flag=value) in container args. Supported toolchains: Kubernetes/YAML
  • cub run get-container-image - Get the image for a container. Supported toolchains: Kubernetes/YAML
  • cub run get-container-image-reference - Get the image reference for a container. Supported toolchains: Kubernetes/YAML
  • cub run get-container-name - Get the container name. Supported toolchains: Kubernetes/YAML
  • cub run get-container-repository-uri - Get the image repository URI for a container. Supported toolchains: Kubernetes/YAML
  • cub run get-env-var - Get an environment variable for a container. Supported toolchains: Kubernetes/YAML
  • cub run get-hash - Computes a SHA-256 hash of all values at the specified path and returns it, without modifying the configuration data. Returns the same hash set-hash stores. Use as an UpstreamGetter on a TransformPaths Link to propagate a content hash to another Unit. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-hostname - Get the hostname. Supported toolchains: Kubernetes/YAML
  • cub run get-hostname-domain - Get the domain name. Supported toolchains: Kubernetes/YAML
  • cub run get-hostname-subdomain - Get the subdomain. Supported toolchains: Kubernetes/YAML
  • cub run get-image - Get the image for a container. [Deprecated: use get-container-image/set-container-image]. Supported toolchains: Kubernetes/YAML
  • cub run get-image-reference - Get the image reference for a container. [Deprecated: use get-container-image-reference/set-container-image-reference]. Supported toolchains: Kubernetes/YAML
  • cub run get-image-uri - Get the image repository URI for a container. [Deprecated: use get-container-repository-uri/set-container-repository-uri]. Supported toolchains: Kubernetes/YAML
  • cub run get-int-path - Returns the value(s) of the specified attribute path. Supported toolchains: AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-label - Get a label. Supported toolchains: Kubernetes/YAML
  • cub run get-name - Get metadata.name in resources. Use --where-resource to scope to a specific resource type. Supported toolchains: Kubernetes/YAML
  • cub run get-namespace - Get the namespace attributes in resource. Supported toolchains: Kubernetes/YAML
  • cub run get-needed - Returns a list of needed attributes with setter functions. See https://docs.confighub.com/background/concepts/needsprovides/ for more information. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-path - Returns the value(s) of the specified attribute path of any type. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-paths - Returns the current values at the specified attribute paths. Used to fetch values for stored NeededPaths and ProvidedPaths. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-placeholder-mutations - Returns a list of resource mutations for attributes containing the placeholder string 'confighubplaceholder' or number 999999999. See https://docs.confighub.com/background/concepts/placeholders/ for more information about placeholders. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-placeholders - Returns a list of attributes containing the placeholder string 'confighubplaceholder' or number 999999999. See https://docs.confighub.com/background/concepts/placeholders/ for more information about placeholders. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-provided - Returns a list of Provided attributes. See https://docs.confighub.com/background/concepts/needsprovides/ for more information. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-references - Returns a list of all resource references (paths with NeededRequired["ResourceType"]) and their current values, whether or not the value is a placeholder. The returned AttributeValues include AttributeNeedsProvidesDetails. See https://docs.confighub.com/background/concepts/needsprovides/ for more information. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-references-of-type - Gets references targeting the specified type. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-replicas - Get the replicas for workload controllers. Supported toolchains: Kubernetes/YAML
  • cub run get-resources - Returns a list of resources and their types. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-resources-of-type - Returns a list of resources of the specified type. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-starlark - Extracts attribute values from configuration resources using a Starlark program that defines an extract(r) function returning an AttributeValueList. Called once per resource. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-string-path - Returns the value(s) of the specified attribute path. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run get-workload-labels - Get pod-template labels and pod label-selectors on workload controllers and resources that select pods. Returns one AttributeValue per labels/selector map path; the value is the YAML serialization of the map. Supported toolchains: Kubernetes/YAML
  • cub run get-yq - Returns the result of running yq with the specified expression on the configuration data filtered by WhereResource. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run is-approved - [Deprecated; use vet-approvedby instead] Returns true if sufficient approvers are present. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run list-paths - Returns every path present in the configuration data, in the syntax the set-* functions accept, together with its value and the registered attribute it belongs to, if any. Reports what the data contains, not what its schema permits. Restrict the output with path-prefix, depth, and attributes-only; WhereResource restricts which resources are walked. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run no-placeholders - [Deprecated; use vet-placeholders instead] Returns true if no attributes contain the placeholder string 'confighubplaceholder' or number 999999999. See https://docs.confighub.com/background/concepts/placeholders/ for more information about placeholders. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run patch-mutations - Selectively patch attributes if their mutations indicate they are patchable. Intended to be used with compute-mutations. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run prune-configmaps - For each group of immutable v1/ConfigMap resources sharing a confighub.com/ResourceNameStableCore annotation, retains at most the configured number of newest (highest confighub.com/RevisionNum) entries, removing the rest. The newest entry retains the confighub.com/RenderRevision: Latest annotation; older retained entries have it stripped and are marked with confighub.com/VisitorOptions: IgnoreProvided. Mutable ConfigMaps are left untouched. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run render-configmap - Renders the AppConfig unit's data as a Kubernetes ConfigMap YAML document. Intended to be used as the transform invocation on an Upsert Link whose downstream unit is Kubernetes/YAML. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML
  • cub run replicate - Replicate the specified configuration resource/element replicas minus one times. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run reset - Sets attributes back to placeholder values if last set by mutations that are not protected. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run search-replace - Replace all instances of the search-value in all strings of all resource types with replace-value. Set regexp to true to match search-value as a regular expression and expand submatch references in replace-value, similar to sed. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run select-where-resource - Returns resources for which all terms of the conjunction of relational expressions evaluate to true. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-annotation - Set an annotation. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-attributes - Set specified attributes to the specified values. Each attribute is set on the resource named by its ResourceName; an attribute with no ResourceName is set on every resource of its ResourceType. This function is intended to be used for read-modify-write operations in combination with any (typically get-) functions returning output of the type AttributeValueList. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-automount-service-account-token-false - Set automountServiceAccountToken to false on all pod specs. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-bool-path - Set the value of the specified attribute path. Mutating. Supported toolchains: AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-cel - Mutates configuration resources by merging a partial CEL expression result into the original resource. Comments are preserved. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-container-flag - Set the value of a POSIX-style flag (--flag=value) in container args. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-image - Set the image for a container. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-image-reference - Set the image reference for a container. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-port - Set a port for a container, adding it if not present. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-probe-defaults - Add liveness, readiness, and startup probes to containers that don't have them, using the first containerPort for HTTP GET probes. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-repository-uri - Set the image repository URI for a container. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-resources - Set resource requests and limits for a container. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-resources-defaults - Set minimum resource requests (128m CPU, 128Mi memory) for containers that don't have resources set. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-container-volume-mount-path - Set a volume mount for a container and ensure the volume exists in the pod spec. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-default-names - Set the values of identified name fields containing the placeholder string 'confighubplaceholder' or number 999999999. See https://docs.confighub.com/background/concepts/placeholders/ for more details regarding placeholder values. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-env - Set environment variables for a container using = syntax. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-env-var - Set an environment variable for a container. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-hash - Computes a SHA-256 hash of all values at the specified path and stores it at the resource provider's context path for Hash (e.g., confighub.com/Hash annotation for Kubernetes). Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-hostname - Set the hostname. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-hostname-domain - Set the domain name. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-hostname-subdomain - Set the subdomain. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-image - Set the image for a container. [Deprecated: use get-container-image/set-container-image]. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-image-reference - Set the image reference for a container. [Deprecated: use get-container-image-reference/set-container-image-reference]. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-image-reference-by-uri - Set the reference for a specified image URI. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-image-registry-by-registry - Replace the specified image registry prefix with a new registry prefix; an empty registry prepends the new registry to images that have none. Optionally restrict to a single container by name. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-image-uri - Set the image repository URI for a container. [Deprecated: use get-container-repository-uri/set-container-repository-uri]. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-int-path - Set the value of the specified attribute path. Mutating. Supported toolchains: AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-label - Set a label. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-name - Set metadata.name in resources. Use --where-resource to scope to a specific resource type. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-namespace - Set the namespace on every namespaced resource, the name on v1/Namespace resources, and Service DNS references in pod-spec command/args/env values. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-path - Set the YAML document at the specified path, replacing all fields there; a terminal ?key=value segment find-or-appends a merge-keyed list element. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-path-comment - Set the comment of the specified attribute path. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-pod-container-security-context-defaults - Set security context defaults for pods (seccomp, runAsNonRoot, runAsUser, runAsGroup, fsGroup) and containers (readOnlyRootFilesystem, allowPrivilegeEscalation, privileged). Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-pod-defaults - Set default pod settings. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-pod-security-defaults - Set pod security labels on Namespace resources (baseline enforce, restricted warn). Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-protection - Set Protected values on a unit's MutationSources for the given resource paths, marking them local overrides a merge must not overwrite. Fails if any path does not exist in the unit's data. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-references-of-type - Sets references targeting the specified type. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-replicas - Set the replicas for workload controllers. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-starlark - Mutates configuration resources using a Starlark program executed per resource. Comments are preserved. The 're' module provides regex support (search, match, sub, findall). Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-string-path - Set the value of the specified attribute path. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-template - Renders a Go text/template expression and writes the result to the specified path of each resource matched by WhereResource. FunctionContext fields are accessible at the top level; vararg key=value params are accessible under .Params. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run set-workload-labels - Set pod-template labels and pod label-selectors on workload controllers and resources that select pods, using = syntax. Mutating. Supported toolchains: Kubernetes/YAML
  • cub run set-yq - The configuration data is updated with the result of running yq -i with the specified expression on the configuration data filtered by WhereResource. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run upsert-resource - Append the resource if it is not present or replace the existing resource if it is already present in the configuration data. Intended to be used with get-resources. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run validate - Returns true if schema passes validation. Validating. Supported toolchains: Kubernetes/YAML
  • cub run vet-approvedby - Returns true if sufficient approvers are present. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-cel - Validates configuration resources using a CEL expression that returns bool or {passed: bool, details: [string]}. Evaluated once per resource. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-celexpr - Returns true if validation expression evaluates to true for all resources. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-disruption - Validates how disruptive a pending change is, by comparing registered per-severity paths against the last-released revision. Registering a path under disruption-critical / -high / -medium / -low grades a change to it; the score-threshold decides which severities fail. Unlike vet-immutable this is graded rather than binary, so one rule can block a destructive change while merely reporting a benign one. Validation passes when there is no baseline, because creating a resource is not replacing one. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-format - Validates YAML format: no anchors/aliases, no empty values, no duplicate keys, no truthy values (yes/no/on/off/y/n), no old-style octals (0755). Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-images - Validates that all container images pass the specified allow/deny filter. If AllowStrings is non-empty, all images must be in the allow list. Images in DenyStrings are always rejected. Validating. Supported toolchains: Kubernetes/YAML
  • 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-jsonschema - Validates each resource against its corresponding JSONSchema from the provided map. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-merge-keys - Returns true if no arrays contain duplicate strategic merge patch keys. Duplicate merge keys in Kubernetes resources (such as duplicate container names or environment variable names) cause apply errors. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-no-merge-conflicts - Returns true if the unit has no outstanding merge conflicts. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-placeholders - Returns true if no attributes contain the placeholder string 'confighubplaceholder' or number 999999999. See https://docs.confighub.com/background/concepts/placeholders/ for more information about placeholders. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-schemas - Returns true if schema passes validation. Validating. Supported toolchains: Kubernetes/YAML
  • cub run vet-starlark - Validates configuration resources using a Starlark program that defines a validate(r) function returning {passed: bool, details: [string]}. Called once per resource. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run vet-values - Validates that all values at the paths registered for the specified attribute pass the specified allow/deny filter. Supports string, int, and bool values. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run where-filter - Returns true if all terms of the conjunction of relational expressions evaluate to true for at least one matching path of a resource of the specified type. Intended to be used for filtering rather than validating, though it returns the same output type. Validating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run yq - [Deprecated; use get-yq instead] Returns the result of running yq with the specified expression on the configuration data filtered by WhereResource. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML
  • cub run yq-i - [Deprecated; use set-yq instead] The configuration data is updated with the result of running yq -i with the specified expression on the configuration data filtered by WhereResource. Mutating. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML