kosli attest artifact

Attest an artifact creation to a Kosli flow.

Synopsis

kosli attest artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags]

Attest an artifact creation to a Kosli flow.

The artifact fingerprint can be provided directly with the --fingerprint flag, or calculated based on --artifact-type flag.

Artifact type can be one of: “file” for files, “dir” for directories, “oci” for container images in registries or “docker” for local docker images.

Note: --artifact-type=docker reads the image’s repo digest via the local Docker daemon. The image must have been pushed to or pulled from a registry for a repo digest to exist; a freshly built image (just docker build) will not have one. If the image is already in a registry, prefer --artifact-type=oci, which fetches the digest directly from the registry without needing a local Docker daemon.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a .kosli_ignore file to the root of the artifact. Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using #. The .kosli_ignore will be treated as part of the artifact like any other file, unless it is explicitly ignored itself. This command requires access to a git repo to associate the artifact to the git commit it is originating from. You can optionally redact some of the git commit data sent to Kosli using --redact-commit-info. To record repository information, all three of --repo-id, --repo-url, and --repository must be set together. These are automatically set in GitHub Actions, GitLab CI, Bitbucket Pipelines, and Azure DevOps. In other CI systems, set them explicitly to capture repository metadata.

Flags

Flag	Description
--annotate stringToString	[optional] Annotate the attestation with data using key=value.
-t, --artifact-type string	The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don’t specify ‘--fingerprint’ on commands that allow it).
-b, --build-url string	The url of CI pipeline that built the artifact. (defaulted in some CIs: docs ).
-g, --commit string	[defaulted] The git commit from which the artifact was created. (defaulted in some CIs: docs, otherwise defaults to HEAD ). (default “HEAD”)
-u, --commit-url string	The url for the git commit that created the artifact. (defaulted in some CIs: docs ).
-N, --display-name string	[optional] Artifact display name, if different from file, image or directory name.
-D, --dry-run	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
-x, --exclude strings	[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir.
--external-fingerprint stringToString	[optional] A SHA256 fingerprint of an external attachment represented by --external-url. The format is label=fingerprint (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. There must be an external url with a matching label for each external fingerprint.
--external-url stringToString	[optional] Add labeled reference URL for an external resource. The format is label=url (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. If the resource is a file or dir, you can optionally add its fingerprint via --external-fingerprint
-F, --fingerprint string	[conditional] The SHA256 fingerprint of the artifact. Only required if you don’t specify ‘--artifact-type’.
-f, --flow string	The Kosli flow name.
-h, --help	help for artifact
-n, --name string	The name of the artifact in the yml template file.
--redact-commit-info strings	[optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch].
--registry-password string	[conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry.
--registry-username string	[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry.
--repo-id string	[conditional] The stable, unique identifier for the repository in your VCS provider (e.g. a numeric ID). Do not use the repository name as it can change if the repo is renamed. All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
--repo-provider string	[optional] The source code hosting provider. One of: github, gitlab, bitbucket, azure-devops (defaulted in some CIs: docs ).
--repo-root string	[defaulted] The directory where the source git repository is available. (default ”.”)
--repo-url string	[conditional] The URL of the repository. Must be a valid URL. All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
--repository string	[conditional] The name of the repository (e.g. owner/repo-name). All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
-T, --trail string	The Kosli trail name.

Flags inherited from parent commands

Flag	Description
-a, --api-token string	The Kosli API token.
-c, --config-file string	[optional] The Kosli config file path. (default “kosli”)
--debug	[optional] Print debug logs to stdout.
-H, --host string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
--http-proxy string	[optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port
-r, --max-api-retries int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--org string	The Kosli organization.
-q, --quiet	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

Live Examples in different CI systems

GitHub

View an example of the kosli attest artifact command in GitHub.

In this YAML file, which created this Kosli Event.

GitLab

View an example of the kosli attest artifact command in GitLab.

In this YAML file, which created this Kosli Event.

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

Attest that a file type artifact has been created, and let Kosli calculate its fingerprint

kosli attest artifact FILE.tgz 
	--artifact-type file 
	--build-url https://exampleci.com 
	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom 
	--commit yourCommitShaThatThisArtifactWasBuiltFrom 
	--name yourTemplateArtifactName 

Attest that an artifact has been created and provide its fingerprint (sha256)

kosli attest artifact ANOTHER_FILE.txt 
	--build-url https://exampleci.com 
	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom 
	--commit yourCommitShaThatThisArtifactWasBuiltFrom 
	--fingerprint yourArtifactFingerprint 
	--name yourTemplateArtifactName 

Attest that an artifact has been created and provide external attachments

kosli attest artifact ANOTHER_FILE.txt 
	--build-url https://exampleci.com 
	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom 
	--commit yourCommitShaThatThisArtifactWasBuiltFrom 
	--fingerprint yourArtifactFingerprint 
	--external-url label=https://example.com/attachment 
	--external-fingerprint label=yourExternalAttachmentFingerprint 
	--name yourTemplateArtifactName