Registries are evolving as Cloud Native Artifact Stores. To enable this goal, Microsoft has donated ORAS as a means to enable various client libraries with a way to push artifacts to OCI Spec Compliant registries.
ORAS is both a CLI for initial testing and a Go Module to be included with your CLI, enabling a native experience: myclient push artifacts.azurecr.io/myartifact:1.0 ./mything.thang
- ORAS Background
- Supported Registries
- Artifacts Implementing ORAS
- Getting Started
- ORAS CLI
- ORAS Go Module
- Contributing
- Maintainers
- OCI Image Support Comes to Open Source Docker Registry
- Registries Are Evolving as Cloud Native Artifact Stores
- OCI Adopts Artifacts Project
- GitHub: OCI Artifacts Project
Select from one the registries that support OCI Artifacts. Each registry identifies how they support authentication.
ORAS is both a CLI for initial testing and a Go Module to be included with your CLI, enabling a native experience: myclient push artifacts.azurecr.io/myartifact:1.0 ./mything.thang
-
Install
oras
using GoFish:gofish install oras ==> Installing oras... 🐠 oras 0.7.0: installed in 65.131245ms
-
Install from the latest release artifacts:
-
Linux
curl -LO https://github.com/deislabs/oras/releases/download/v0.7.0/oras_0.7.0_linux_amd64.tar.gz mkdir -p oras-install/ tar -zxf oras_0.7.0_*.tar.gz -C oras-install/ mv oras-install/oras /usr/local/bin/ rm -rf oras_0.7.0_*.tar.gz oras-install/
-
macOS
curl -LO https://github.com/deislabs/oras/releases/download/v0.7.0/oras_0.7.0_darwin_amd64.tar.gz mkdir -p oras-install/ tar -zxf oras_0.7.0_*.tar.gz -C oras-install/ mv oras-install/oras /usr/local/bin/ rm -rf oras_0.7.0_*.tar.gz oras-install/
-
Windows
Add
%USERPROFILE%\bin\
to yourPATH
environment variable so thatoras.exe
can be found.curl.exe -sLO https://github.com/deislabs/oras/releases/download/v0.7.0/oras_0.7.0_windows_amd64.tar.gz tar.exe -xvzf oras_0.7.0_windows_amd64.tar.gz mkdir -p %USERPROFILE%\bin\ copy oras.exe %USERPROFILE%\bin\ set PATH=%USERPROFILE%\bin\;%PATH%
-
Docker Image
A public Docker image containing the CLI is available on Docker Hub:
docker run -it --rm -v $(pwd):/workspace orasbot/oras:v0.7.0 help
Note: the default WORKDIR in the image is
/workspace
.
-
Run oras login
in advance for any private registries. By default, this will store credentials in ~/.docker/config.json
(same file used by the docker client). If you have previously authenticated to a registry using docker login
, the credentials will be reused.
Use the -c
/--config
option to specify an alternate location.
While ORAS leverages the local docker client config store, ORAS does NOT have a dependency on Docker Desktop running or being installed. ORAS can be used independently of a local docker daemon.
oras
also accepts explicit credentials via options, for example,
oras pull -u username -p password myregistry.io/myimage:latest
See Supported Registries for registry specific authentication usage.
Pushing single files involves referencing the unique artifact type and at least one file.
The following sample defines a new Artifact Type of Acme Rocket, using application/vnd.acme.rocket.config.v1+json
as the manifest.config.mediaType
-
Create a sample file to push/pull as an artifact
echo "hello world" > artifact.txt
-
Push the sample file to the registry:
oras push localhost:5000/hello-artifact:v1 \ --manifest-config /dev/null:application/vnd.acme.rocket.config.v1+json \ ./artifact.txt
-
Pull the file from the registry:
rm -f artifact.txt # first delete the file oras pull localhost:5000/hello-artifact:v1 cat artifact.txt # should print "hello world"
-
The push a custom layer
mediaType
, representing a unique artifact blob, use the formatfilename[:type]
:oras push localhost:5000/hello-artifact:v2 \ --manifest-config /dev/null:application/vnd.acme.rocket.config.v1+json \ artifact.txt:application/vnd.acme.rocket.layer.v1+txt
The OCI distribution-spec provides for storing optional config objects. These can be used by the artifact to determine how or where to process and/or route the blobs.
-
Create a config file
echo "{\"name\":\"foo\",\"value\":\"bar\"}" > config.json
-
Push an the artifact, with the
config.json
fileoras push localhost:5000/hello-artifact:v2 \ --manifest-config config.json:application/vnd.acme.rocket.config.v1+json \ artifact.txt:application/vnd.acme.rocket.layer.v1+txt
Just as container images support multiple "layers", represented as blobs, ORAS supports pushing multiple files. The file type is up to the artifact author. You can push .tar
to represent a collection of files or individual files like .yaml
, .txt
or whatever your artifact should be represented as. Each blob (layer) type should have a mediaType
to represent the type of blob. See OCI Artifacts for more details.
-
Create additional blobs
echo "Docs on this artifact" > readme.md
-
Create a config file, referencing the doc file
echo "{\"doc\":\"readme.md\"}" > config.json
-
Push multiple files with different
mediaTypes
:oras push localhost:5000/hello-artifact:v2 \ --manifest-config config.json:application/vnd.acme.rocket.config.v1+json \ artifact.txt:application/vnd.acme.rocket.config.v1+json \ readme.md:application/vnd.acme.rocket.docs.layer.v1+json
Pulling artifacts involves specifying the content addressable artifact, along with the type of artifact.
See: Issue 130 for elimnating
-a
and--media-type
oras pull localhost:5000/hello-artifact:v2 -a
While the ORAS CLI provides a great way to get started, and test registry support for OCI Artifacts, the primary experience enables a native experience for your artifact of choice. Using the ORAS Go Module, you can develop your own push/pull experience: myclient push artifacts.azurecr.io/myartifact:1.0 ./mything.thang
The package github.com/deislabs/oras/pkg/oras
can quickly be imported in other Go-based tools that
wish to benefit from the ability to store arbitrary content in container registries.
package main
import (
"context"
"fmt"
"github.com/deislabs/oras/pkg/content"
"github.com/deislabs/oras/pkg/oras"
"github.com/containerd/containerd/remotes/docker"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)
func check(e error) {
if e != nil {
panic(e)
}
}
func main() {
ref := "localhost:5000/oras:test"
fileName := "hello.txt"
fileContent := []byte("Hello World!\n")
customMediaType := "my.custom.media.type"
ctx := context.Background()
resolver := docker.NewResolver(docker.ResolverOptions{})
// Push file(s) w custom mediatype to registry
memoryStore := content.NewMemoryStore()
desc := memoryStore.Add(fileName, customMediaType, fileContent)
pushContents := []ocispec.Descriptor{desc}
fmt.Printf("Pushing %s to %s...\n", fileName, ref)
desc, err := oras.Push(ctx, resolver, ref, memoryStore, pushContents)
check(err)
fmt.Printf("Pushed to %s with digest %s\n", ref, desc.Digest)
// Pull file(s) from registry and save to disk
fmt.Printf("Pulling from %s and saving to %s...\n", ref, fileName)
fileStore := content.NewFileStore("")
defer fileStore.Close()
allowedMediaTypes := []string{customMediaType}
desc, _, err = oras.Pull(ctx, resolver, ref, fileStore, oras.WithAllowedMediaTypes(allowedMediaTypes))
check(err)
fmt.Printf("Pulled from %s with digest %s\n", ref, desc.Digest)
fmt.Printf("Try running 'cat %s'\n", fileName)
}
Want to reach the ORAS community and developers? We're very interested in feedback and contributions for other artifacts.
Join us at CNCF Slack under the #oras channel