Spinnaker – Types of Artifacts

Docs: Bitbucket File

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

Bitbucket file artifacts are references to files stored in Bitbucket . They are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Fields

Field	Explanation
`type`	Always `bitbucket/file`.
`reference`	The full path including filename for retrieval via the Bitbucket API. `https://api.bitbucket.org/2.0/repositories/$ORG/$REPO/src/$VERSION/$FILEPATH`. For more info, see the documentation here .
`name`	The file path within your repo. `path/to/file.yml` is an example.
`version`	N/A. Must be specified in reference.
`location`	N/A

Example

{
  "type": "bitbucket/file",
  "reference": "https://api.bitbucket.org/2.0/repositories/org/repo/src/master/manifests/config.yaml",
  "name": "manifests/config.yaml"
}

Docs: Docker Image

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

A Docker image is a snapshot of a container, to be run locally, or in the cloud. Docker image artifacts are used as references to images in registries , such as GCR , or Docker Hub . The artifacts can be deployed to Kubernetes or App Engine, and generally trigger pipelines from notifications sent by their registry.

Fields

Field	Explanation
`type`	Always `docker/image`.
`reference`	The fully-qualified image name, including version and registry. This can be done either by tag (`gcr.io/project/my-image:v1.2`) or image digest `gcr.io/project/my-image@sha256:28f82eba`.
`name`	The image’s name (typically the registry and repository) without the image’s version. `gcr.io/project/my-image` is an example.
`version`	The image’s tag or digest.
`location`	N/A

Example

{
  "type": "docker/image",
  "reference": "gcr.io/project/my-image@sha256:28f82eba",
  "name": "gcr.io/project/my-image",
  "version": "sha256:28f82eba"
}

Docs: Embedded base64

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

Rather than refer to a resource by URI, you can embed the artifact’s contents directly into the "reference" field in base64.

Fields

Field	Explanation
`type`	Always `embedded/base64`.
`reference`	The base64 encoded artifact contents.
`name`	An optional human-readable identifier.

Example

{
  "type": "embedded/base64",
  "reference": "dmFsdWU6IDEKZm9vOiBiYXIK",
  "name": "my-properties-file",
}

Docs: GCS Object

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

GCS is an object store, and GCS object artifacts are references to objects stored in GCS buckets. These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or App Engine Deploy stage.

Fields

Field	Explanation
`type`	Always `gcs/object`.
`reference`	The `gs://`-prefixed reference to your file. May be suffixed with the object’s version . `gs://bucket/file.yml#1360383693620000` is an example.
`name`	The same as `reference`, but never with a version.
`version`	The object’s version , if applicable.
`location`	N/A

Example

{
  "type": "gcs/object",
  "reference": "gs://bucket/file.yml#1360383693620000",
  "name": "gs://bucket/file.yml",
  "version": "1360383693620000"
}

Docs: Git Repo

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

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

Git Repo artifacts are references to Git repositories that are hosted by a Git hosting service. 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 implementation, the Git Repo artifact will work with any Git hosting service as long as the repository can be cloned using the Git CLI.

Fields

Field	Explanation
`type`	Always `git/repo`.
`reference`	HTTP or SSH URL of your Git repository. Use HTTP for artifact accounts configured to use a username and password, and use the SSH URL format for accounts configured to use the SSH private key.
`version`	Name of the branch to check out. Default is `master`.
`metadata.subPath`	Relative path of files within the repository to fetch. If set, only files this path will be available to stages consuming this artifact.

Example

Artifact accounts using an SSH private key for authentication.

{
    "type": "git/repo",
    "reference": "git@github.com:spinnaker/spinnaker.github.io",
    "version": "feat-123"
}

Artifact accounts using a username and password or token for authentication.

{
    "type": "git/repo",
    "reference": "https://github.com/spinnaker/spinnaker.github.io",
    "version": "feat-123"
}

When checking out an explicit sub path within repository

{
    "type": "git/repo",
    "reference": "https://github.com/spinnaker/spinnaker.github.io",
    "version": "feat-123",
    "metadata" : {
        "subPath": "reference/artifacts/types"
    }
}

Docs: GitHub File

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

GitHub file artifacts are references to files stored in GitHub or GitHub Enterprise . They are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Fields

Field	Explanation
`type`	Always `github/file`.
`reference`	The full path including filename for retrieval via the GitHub API. This is the `contents_url` as referenced by a PushEvent . `https://api.github.com/repos/baxterthehacker/public-repo/contents/path/to/file.yml` is an example for public GitHub. `https://github.mydomain.com/api/v3/repos/orgname/reponame/contents/path/to/file.yml` is an example for GHE.
`name`	The file path within your repo. `path/to/file.yml` is an example.
`version`	The file’s commit, branch, or tag.
`location`	N/A

Example

{
  "type": "github/file",
  "reference": "https://api.github.com/repos/baxterthehacker/public-repo/contents/path/to/file.yml",
  "name": "path/to/file.yml",
  "version": "aec855f4e0e11"
}

Docs: Gitlab File

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

Gitlab file artifacts are references to files stored in Gitlab . They are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Fields

Field	Explanation
`type`	Always `gitlab/file`.
`reference`	The full path including filename for retrieval via the Gitlab API. `https://gitlab.example.com/api/v4/projects/13083/repository/files/manifests%2Fconfig%2Eyaml/raw` is an example from the Gitlab documentation. For more info, see the documentation here .
`name`	The file path within your repo. `path/to/file.yml` is an example.
`version`	The file’s commit or branch.
`location`	N/A

Example

{
  "type": "gitlab/file",
  "reference": "https://gitlab.example.com/api/v4/projects/13083/repository/files/manifests%2Fconfig%2Eyaml/raw",
  "name": "manifests/config.yaml",
  "version": "master"
}

Docs: HTTP File

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

HTTP file artifacts are references to files stored in plaintext reachable via HTTP. They are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

These files can be downloaded using basic auth.

Fields

Field	Explanation
`type`	Always `http/file`.
`reference`	The fully-qualified URL where your file can be read from.
`name`	An optional identifier for referencing this artifact later.
`version`	N/A
`location`	N/A

Example

{
  "type": "http/file",
  "reference": "https://raw.githubusercontent.com/....",
  "name": "My manifest stored in github",
}

Docs: Kubernetes Object

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

Kubernetes Object artifacts are running, deployed Kubernetes Manifests. This is in contrast to something like a GitHub file that only contains the specification of a deployable Kubernetes Manifest.

Fields

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`	Only set when the resource was deployed with a version. A `ConfigMap` at version `-v120` is an example.
`location`	The object’s namespace.
`artifactAccount`	The Spinnaker account (Kubernetes context) this was deployed to.

Example

{
  "type": "kubernetes/deployment",
  "reference": "frontend",
  "name": "frontend",
  "namespace": "staging",
  "artifactAccount": "gke-us-central1-xnat"
}

Docs: Oracle Object

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

Oracle Object Storage is an object store, and Oracle Object Storage object artifacts are references to objects stored in Oracle Object Storage buckets. These artifacts are generally consumed by stages that read configuration from text files, for example a Deploy Manifest stage.

Fields

Field	Explanation
`type`	Always `oracle/object`.
`reference`	The `oci://`-prefixed reference to your file. Following the bucket name is the path to your file.

Example

{
  "type": "oracle/object",
  "reference": "oci://bucket/file.json"
}

Docs: S3 Object

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

S3 is an object store, and S3 object artifacts are references to objects stored in S3 buckets. These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or AWS Deploy stage.

Fields

Field	Explanation
`type`	Always `s3/object`.
`name`	Name/Path of the object.
`reference`	Name/Path of the object.
`location`	The region where your bucket was created

Example

{
  "type": "s3/object",
  "name": "s3://bucket/file.json",
  "reference": "s3://bucket/file.json",
  "location": "us-east-1"
}