OCI artifacts in Artifact Registry
- Tier: Premium, Ultimate
- Offering: GitLab.com
- Status: Beta
An Open Container Initiative (OCI) repository in Artifact Registry stores any OCI artifact, including ones that are not container images. It uses the same endpoints as a Docker repository. The difference is what it accepts on push.
Supported clients
oras- Docker CLI
- Podman
Authenticate
Prerequisites:
- The GitLab CLI, version 1.115.0 or later.
Authentication requires the GITLAB_TOKEN to be set. To check
if the environment variable is set, run:
echo $GITLAB_TOKENIf nothing is printed, authenticate with the
GitLab CLI to set GITLAB_TOKEN:
glab auth loginTo authenticate with the Docker CLI, run the following command:
glab artifact-registry login --docker --registry <registry_host>For <registry_host>, use a bare hostname, not a URL. This registers glab as a Docker credential helper, so every pull and push gets a fresh token. --duration does not apply, because the helper gets a new token each time.
For oras and Podman, there is no login flag. To authenticate, get a token and pass it to the client:
glab artifact-registry get-token |
oras login <registry_host> --username __token__ --password-stdinNothing refreshes this token. Run the command again before it expires.
Configure your client
An artifact in an OCI repository is available at:
<registry_host>/<registry_handle>/container/<repository_name>/<image_name>:<tag>Replace the following placeholders:
<registry_host>: Enter the bare hostname from your repository’s setup instructions. To find it, go to your repository and select More actions > View setup instructions. Docker stores credentials by hostname, so use the bare hostname, such asar.example.com.<registry_handle>: Enter your organization’s registry handle.<repository_name>: Enter the name of your repository.<image_name>: Enter the image name in the repository.<tag>: Enter the image tag, such aslatest.
The path segment is container for both Docker and OCI repositories. One set of endpoints
serves both formats. docker and oci appear only in management API URLs.
How an OCI repository differs from a Docker repository
- An OCI repository accepts any manifest type, including artifacts that carry no image configuration and refer to nothing.
- A Docker repository accepts only image manifests and manifests that refer to an image. For details, see Docker images in Artifact Registry.
- Both reject Docker manifest schema 1.
- The format is fixed when you create a repository, so you cannot convert one to the other. Create a new repository instead.
- Choose an OCI repository for Helm charts, WebAssembly modules, machine learning models, and other artifacts that are not container images.
Image names and path length
- A name uses lowercase letters and digits, with periods, underscores, and hyphens as separators.
- A name can hold several segments separated by slashes. The whole thing counts as one name.
- The full path, made up of the registry handle, the repository name, and the artifact name, cannot be longer than 255 characters. Separator characters count.
Limits
| Limit | Value |
|---|---|
| Blob size | 50 GB |
| Manifest size | 4 MB |
| References per manifest | 200 |
| Manifests per artifact | 25,000 |
| Tags per manifest | 1,000 |
For the full list of limits, see Artifact Registry limits.
Deleting artifacts
- Deleting a manifest also deletes the tags that point at it.
- A manifest that another manifest references returns
409. Delete the referencing manifests first.
For specific steps, see the Artifact Registry API.
Remote and virtual repositories
An OCI remote repository proxies and caches an upstream registry, the same as a Docker remote repository.
Virtual repositories are not available for any format in beta.
For details, see Artifact Registry formats.