Types of Artifacts on Spinnaker

Bitbucket File

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Bitbucket file artifact in the UI

The pipeline UI exposes the following fields for the Bitbucket file artifact:

Field	Explanation
Account	A Bitbucket artifact account.
File path	The full path (including filename) for retrieval via the Bitbucket API. Example: `https://api.bitbucket.org/2.0/repositories/$ORG/$REPO/src/$VERSION/$FILEPATH`.

In a trigger

When configuring certain triggers, you can use a Bitbucket file as an expected artifact.

Debian Package

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by the Bake stage.

HTTP file artifact in the UI

The pipeline UI exposes the following fields for the Debian Package artifact:

	Explanation
Account	An HTTP artifact account.
URL	The fully-qualified URL from which the file can be read.

In a trigger

When configuring certain triggers, like Pubsub you can use a custom artifact.

Configuring Debian Package fields in a pipeline trigger’s expected artifact settings.

Docker Image

Mon, 01 Jan 0001 00:00:00 +0000

The artifacts can be deployed to Kubernetes or App Engine, and generally trigger pipelines from notifications sent by their registry.

Docker image artifact in the UI

The pipeline UI exposes the following fields for the Docker image artifact:

Field	Explanation
Account	A Docker registry artifact account.
Docker image	The name of the Docker image, including the registry and image repository.

In a trigger

When configuring the Docker Registry trigger, you can use a Docker image as an expected artifact.

Embedded Base64

Mon, 01 Jan 0001 00:00:00 +0000

Embedded Base64 artifact in the UI

The pipeline UI exposes the following fields for the embedded Base64 artifact:

Field	Explanation
Account	Always "embedded-artifact".
Name	A human-readable identifier for the artifact.
Contents	The Base64-encoded contents of the artifact.

In a trigger

When configuring a trigger, you can (for example) configure an embedded Base64 default artifact.

Providing an embedded Base64 default artifact for a trigger’s expected artifact.

GCS Object

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or App Engine Deploy stage.

GCS object artifact in the UI

The pipeline UI exposes the following fields for the GCS object artifact:

Field	Explanation
Account	A GCS artifact account.
Object path	The path to the artifact file, beginning with `gs://`.

In a trigger

When configuring certain triggers (such as a Pub/Sub trigger with Pub/Sub System Type “Google”), you can use a GCS object as an expected artifact.

Git Repo

Mon, 01 Jan 0001 00:00:00 +0000

The Git Repo artifact is available in version 1.17 or later.

They are consumed by stages that need multiple files to produce an output, such as the Bake (Manifest) stage when using the Kustomize template renderer. Unlike other artifact implementations, the Git Repo artifact works with any Git hosting service as long as the repository can be cloned using the Git CLI.

Git Repo artifact in the UI

The pipeline UI exposes the following fields for the Git Repo artifact:

GitHub File

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a “Deploy (Manifest)” stage.

GitHub file artifact in the UI

The pipeline UI exposes the following fields for the GitHub file artifact:

Field	Explanation
Account	A GitHub artifact account.
File path	The path to the artifact file, beginning at the root of the Git repository.
Content URL	The GitHub API content URL for the artifact file.
Commit/Branch	The commit hash or branch name to use when retrieving the artifact file from GitHub.

In a trigger

When configuring a Git trigger with Type “GitHub”, you can use a GitHub file as an expected artifact.

GitLab File

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

GitLab file artifact in the UI

The pipeline UI exposes the following fields for the GitLab file artifact:

Field	Explanation
Account	A GitLab artifact account.
File path	The path to the artifact file, beginning at the root of the Git repository.
Commit/Branch	The commit hash or branch name to use when retrieving the artifact file from GitLab.

In a trigger

When configuring a Git trigger with Type “GitLab”, you can use a GitLab file as an expected artifact.

HTTP File

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

A file represented by an HTTP file artifact can be downloaded using HTTP Basic authentication.

HTTP file artifact in the UI

The pipeline UI exposes the following fields for the HTTP file artifact:

Field	Explanation
Account	An HTTP artifact account.
URL	The fully-qualified URL from which the file can be read.

In a trigger

When configuring certain triggers, you can use an HTTP file as an expected artifact.

Kubernetes Object

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes object artifact in the UI

The pipeline UI exposes the following fields for the Kubernetes object artifact:

Field	Explanation
Account	An HTTP artifact account.
URL	The fully-qualified URL from which the file can be read.

Kubernetes object artifact in a pipeline definition

The following are the fields that make up a Kubernetes object artifact:

Field	Explanation
`type`	`kubernetes/<kind>`, where `<kind>` is the Kubernetes Kind (such as `Deployment`).
`reference`	The name of the object.
`name`	The name of the object.
`version`	The version of the object. Only set if the resource was deployed with a version (for example, a `ConfigMap` deployed at version `-v120`).
`location`	The namespace of the object.
`artifactAccount`	The Spinnaker account (Kubernetes context) to which the object was deployed.

The following is an example JSON representation of a Kubernetes object artifact, as it would appear in a pipeline definition:

Maven Artifact

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that deploy application artifacts, such as a Deploy stage.

The files stored in a Maven repository are typically called “artifacts”, so on this page, “Maven artifact” may refer to a Spinnaker artifact of type maven/file or to a file (e.g. a JAR file) stored in a Maven repository.

Maven artifact in the UI

The pipeline UI exposes the following fields for the Maven artifact:

Oracle Object

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Oracle object artifact in a pipeline definition

The following are the fields that make up an Oracle object artifact:

Field	Explanation
`type`	Always `oracle/object`.
`reference`	The full path to the artifact file, beginning with`oci://`.

The following is an example JSON representation of an Oracle object artifact, as it would appear in a pipeline definition:

S3 Object

Mon, 01 Jan 0001 00:00:00 +0000

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or AWS Deploy stage.

S3 object artifact in the UI

The pipeline UI exposes the following fields for the S3 object artifact:

Field	Explanation
Account	An S3 artifact account.
Object path	The full path to the artifact file, beginning with `s3://`.

In a trigger

When configuring a trigger, you can use an S3 object as an expected artifact.