DOCSEARCHbyAlgolia
Submit Docs

ORAS Documentation

website·Indexed 36 days ago

https://oras.land/

Documentation for ORAS, a tool for distributing OCI artifacts. Includes guides on pushing and pulling artifacts, managing manifest annotations, creating multi-architecture manifests, and using OCI image layouts. Covers CLI commands such as oras push, oras pull, oras manifest fetch, and oras login, as well as client libraries for Go and Python. Supports versions 1.1, 1.2, and 1.3.

Tokens
77.7K
Snippets
504
Records
622
Agent score
71%

What's inside ORAS

  1. Overview of the ORAS Go client library

    The ORAS Go client library allows developers to replicate artifacts between different targets and build custom registry clients. Version v2 is a registry client that conforms to the image-spec v1.1.0-rc6 and distribution-spec v1.1.0-rc4 specifications.

  2. Overview of ORAS for OCI Artifact management

    ORAS (OCI Registry As Storage) provides tools and libraries to push and pull OCI Artifacts to and from OCI Registries. Unlike container-centric tools, ORAS focuses on generic artifacts, treating media types as a critical component to differentiate between various types of non-container data. It handles authentication (login) and authorization (token flow) similarly to the Docker CLI.

  3. Overview of ORAS for OCI Artifact management

    ORAS (OCI Registry As Storage) provides tools and libraries to push and pull OCI Artifacts to and from OCI Registries. Unlike standard container tools, ORAS focuses on generic artifacts rather than container images. It handles authentication (login) and authorization (token flow) and treats media types as a critical component for differentiating artifact types.

    • For a ready-to-use generic registry client, use the ORAS CLI.
    • For building custom clients, use the ORAS client libraries.

  4. Overview of the ORAS Go client library

    The ORAS Go client library allows developers to replicate artifacts between different targets and build custom registry clients. Version v2 is a registry client that conforms to the image-spec v1.1.0-rc6 and distribution-spec v1.1.0-rc4 specifications.

  5. Overview of ORAS tools for OCI artifacts

    ORAS (OCI Registry As Storage) is a set of tools used to distribute and manage OCI artifacts across OCI registries. It provides both a command-line interface for end-users and client libraries for developers to build custom integrations.

  6. Overview of ORAS and OCI Artifacts

    ORAS (OCI Registry As Storage) is a project that enables the use of OCI Registries as generic artifact stores. Unlike standard container tools, ORAS focuses on OCI Artifacts—arbitrary data stored in registries without masquerading them as container images. It handles authentication, token flow, and the pushing/pulling of artifacts by leveraging the config.mediaType field in OCI Image Manifests to differentiate between artifact types.

  7. Overview of the ORAS Go client library

    The ORAS Go client library allows developers to replicate artifacts between different Targets. Version v2 of the library is a registry client that conforms to the OCI image-spec 1.1.1 and distribution-spec v1.1.1 specifications. It can be used to build custom registry clients for pushing and pulling artifacts.
    # Example conceptual usage of a client built with oras-go
myclient push artifacts.example.com/myartifact:1.0 ./mything.thang

  8. Overview of ORAS for OCI Artifact Distribution

    ORAS (OCI Registry As Storage) is a tool and set of client libraries designed to distribute and manage artifacts across OCI-compliant registries. Unlike standard container tools, ORAS treats media types as a critical component and does not assume that the artifact is a container image. It allows users to attach supply chain artifacts to container images, migrate artifacts across registries, and manage artifacts on the local file system using the OCI image layout.

  9. Pull a platform-specific artifact from a multi-architecture manifest

    To download a specific version of an artifact for a particular platform from a multi-architecture manifest, use the oras pull command with the --platform flag. This ensures that only the layers corresponding to the requested architecture and OS are retrieved.
    # Pull the artifact for darwin/amd64 and save it to the ./download directory
oras pull localhost:15000/oras:v1 --platform darwin/amd64 -o ./download

  10. Bundle multiple artifacts using an Image Index

    An Image Index can be used as a high-level entry point to group related OCI artifacts. It can point to multiple Image Manifests, allowing users to select the appropriate artifact based on platform, architecture, or specific annotations.

  11. Manage OCI image indices with oras manifest index

    The oras manifest index command provides experimental operations for managing OCI image indices. It allows developers to create and update indices that group multiple manifests together.
    oras manifest index [command]