Skip to content

cub run get-starlark

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/Text, AppConfig/YAML, AppConfig/TOML, ConfigHub/YAML, Kubernetes/YAML

cub run get-starlark [flags]

Options

  -h, --help             help for get-starlark
      --param string     Parameters passed to the Starlark program as key=value strings, accessible via the 'params' dict
      --program string   (required) Starlark program that extracts values from resources. Must define an 'extract(r)' function that takes a resource dict and returns a list of dicts, each with fields: ResourceName (string), ResourceType (string), Path (string), Value (any), and optionally AttributeName (string), DataType (string). The function is called once per resource. The 'json', 're' modules and 'params' dict are available.

Options inherited from parent commands

      --change-desc string      change description
      --changeset string        changeset to associate units with
      --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)
      --livestate-type string   Invoke the function on the live state and use the flag value as the toolchain type for live state.
  -o, --output string           Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --quiet                   No output
      --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

SEE ALSO