Skip to content

cub run vet-correctness

cub run vet-correctness

Fails a resource the Kubernetes API server would reject, or accept and silently ignore part of, for reasons the schemas do not express: selector-matches-template (a controller's selector selects its own pod template's labels), label-syntax (label keys and values are valid), name-syntax (metadata.name has its type's syntax), port-names (container port names are valid and unique in the container), port-references (a probe or lifecycle handler naming a port names one its container declares), volume-references (each volume mount and device names a volume of the pod), exactly-one-of (one field of each required group is set, such as a PodDisruptionBudget's minAvailable or maxUnavailable), configmap-size (a ConfigMap's data is at most 1 MiB), cronjob (a CronJob's schedule parses, its timeZone exists, and its pods restart OnFailure or Never), deprecated-fields (no superseded field is set without the field replacing it, or with a different value), and deprecated-api (the resource's type, or the version of it, is not deprecated). Name formats, required groups, and deprecated fields and types are declared per resource type, a CRD's deprecated versions included. Each failure is an Issue identified by its check. Fix: what the Issue says, for the check it names. Validating. Supported toolchains: Kubernetes/YAML

cub run vet-correctness [flags]

Options

      --check string           Comma-separated names of the checks to run. Omitted, all of them. The checks are configmap-size, cronjob, deprecated-api, deprecated-fields, exactly-one-of, label-syntax, name-syntax, port-names, port-references, selector-matches-template, volume-references
      --exclude-check string   Comma-separated names of checks not to run
  -h, --help                   help for vet-correctness

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. Without it the change is cleared for Override guards, whatever their value, as a merge is not; a clearance given replaces that, and --clearance '' clears nothing
      --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
      --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>
      --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