chainctl policies override create

chainctl policies override create

Create a policy override.

Synopsis

Create an override that waives a policy for one specific artifact.

The override flips the policy’s result to ALLOWED for the artifact identified by –artifact-id, under the policy named by –policy. Which form the artifact takes follows from the policy’s resource type: an image digest for a Repo policy, written as sha256: followed by exactly 64 lowercase hex characters, or a PURL for a library policy, such as pkg:npm/left-pad@1.3.0. A malformed value is rejected locally before any API call, as is a digest aimed at a library policy or a PURL aimed at an image policy. A –reason is required to record why the waiver was granted.

An override matches exactly one artifact. For a multi-arch image, pulls are enforced against the per-platform child manifest, not the index digest, so override the child digest that “chainctl policies check” reports as enforced; overriding the index digest alone may not unblock the pull. A library override matches either one exact version, when the PURL carries one, or every version of the package, when it does not.

Because a policy is identified by its name and resource type together, the same name can exist for images and for each library ecosystem. Pass –resource-type to say which one you mean.

Creating an override requires the policies.override.create capability, a separate capability typically held by organization owners.

chainctl policies override create --policy POLICY --artifact-id ARTIFACT --reason REASON [--parent ORG] [--output=json|table] [flags]

Examples

  # Waive the no-eol policy for a specific image digest
  chainctl policies override create --policy=no-eol --parent=engineering \
  --artifact-id=sha256:<64-hex-digest> --reason="approved exception, ticket OPS-42"
  
  # Waive the cooldown gate for one npm package version
  chainctl policies override create --policy=cooldown --resource-type=Javascript \
  --parent=engineering --artifact-id=pkg:npm/left-pad@1.3.0 \
  --reason="hotfix dependency, approved by SEC, OPS-42"
  
  # Waive the malware gate for one PyPI package version
  chainctl policies override create --policy=malware --resource-type=Python \
  --parent=engineering --artifact-id=pkg:pypi/acme-telemetry@1.4.2 \
  --reason="scanner false positive confirmed by SEC, OPS-42"

Options

      --artifact-id string     The artifact to waive: an image digest for a Repo policy, as sha256: followed by exactly 64 lowercase hex characters, or a PURL for a library policy, e.g. pkg:npm/left-pad@1.3.0. For a multi-arch image use the per-platform child digest that "chainctl policies check" reports, not the index digest.
      --parent string          The name or id of the organization to scope the override to.
      --policy string          The name or UIDP of the policy to override.
      --reason string          The justification for the override.
      --resource-type string   Resource type used to disambiguate a policy referenced by name (shorthand: Repo, Python, Java, Javascript; or a full type). Ignored when the policy is given by UIDP.

Options inherited from parent commands

      --api string         The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
      --audience string    The Chainguard token audience to request. (default "https://console-api.enforce.dev")
      --config string      A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
      --console string     The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
      --force-color        Force color output even when stdout is not a TTY.
  -h, --help               Help for chainctl
      --issuer string      The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
      --log-level string   Set the log level (debug, info) (default "ERROR")
  -o, --output string      Output format. One of: [csv, env, go-template, id, json, markdown, none, table, terse, tree, wide]
  -v, --v int              Set the log verbosity level.

SEE ALSO

• chainctl policies override - Manage policy overrides.