Skip to main content

atmos artifacts catalog build

Resolve the releases of an inventory in one repository and write them to a catalog snapshot file. Build reads artifact metadata only: it downloads no payload and publishes nothing.

Experimental

Usage​

atmos artifacts catalog build --repository=<alias> --input=<inventory> --output=<file> [flags]

Examples​

# Build a JSON snapshot
atmos artifacts catalog build --repository=shared --input=inventory.yaml --output=catalog.json

# Build a YAML snapshot with a custom catalog name
atmos artifacts catalog build --repository=shared --input=inventory.yaml --output=catalog.yaml --name=platform

Behavior​

Build resolves each reference in the inventory and reads its Record, then writes an AtmosArtifactCatalog manifest. Entries and versions are sorted lexically. When the repository has a catalog that is already published, build records that catalog's revision in the snapshot and prints its digest as base_digest, so a later publish fails if someone published in between. Without a published catalog the base revision is 0.

Build works on a repository without a configured catalog. It does not need one until you publish.

Flags​

--repository, -r (required)

Configured repository alias the inventory refs are relative to. Environment variable: ATMOS_ARTIFACTS_REPOSITORY

--input (required)

An AtmosArtifactInventory manifest listing the releases to resolve. Environment variable: ATMOS_ARTIFACTS_INPUT

--output (required)

The snapshot file to write. The extension selects the format: .yaml and .yml write YAML, anything else writes JSON. The file is replaced atomically. Environment variable: ATMOS_ARTIFACTS_OUTPUT

--name (optional)

The catalog manifest name. Defaults to the name in the configured catalog reference, or catalog. Environment variable: ATMOS_ARTIFACTS_NAME

--format (optional)

Output format: text (default), json, or yaml. Environment variable: ATMOS_ARTIFACTS_FORMAT

Output​

Stdout carries output, base_digest (when a catalog is published), revision, and listed, the number of name and version pairs in the snapshot.

Errors​

Reference not found
An inventory ref does not resolve in the repository. Nothing is written.
Not an Atmos artifact
The ref names a foreign image or plugin release, which a catalog cannot list.
Invalid inventory
The inventory is not an AtmosArtifactInventory, lists no refs, repeats a ref, or uses a ref without a version or digest.

Every failure exits with a nonzero status.

Related​