zot/README.md

zot

zot: a production-ready vendor-neutral OCI image registry - images stored in OCI image format, distribution specification on-the-wire, that's it!

https://zotregistry.io

For the full-featured (with all extensions enabled):

docker pull ghcr.io/project-zot/zot-linux-amd64:latest

docker run -p 5000:5000 ghcr.io/project-zot/zot-linux-amd64:latest

Or for the minimal image (for the security-minded and extensions stripped):

docker pull ghcr.io/project-zot/zot-minimal-linux-amd64:latest

docker run -p 5000:5000 ghcr.io/project-zot/zot-minimal-linux-amd64:latest

Check the package repository for your os/arch (linux/arm64, darwin/amd64, darwin/arm64)

The following document refers on the core dist-spec, see also the zot-specific extensions spec

Why zot?

What's new?

• Supports push/pull OCI and ORAS Artifacts
• Supports OCI references
• Supports content range for pull requests
• Selectively add extensions on top of minimal build
• Supports container image signatures - cosign and notation
• Multi-arch support
• Clustering support
• Image linting support

Demos

Features

• Conforms to OCI distribution spec APIs

• Clear separation between core dist-spec and zot-specific extensions

  • make binary-minimal builds a dist-spec-only zot
  • make binary builds a zot with all extensions enabled

  Check released binaries for your os/arch

• Uses OCI image layout for image storage

  • Can serve any OCI image layout as a registry

• Supports container image signatures - cosign and notation

• Supports helm charts

• Behavior controlled via configuration

• Supports multi-arch

  OS	Arch	Use Case
  linux	amd64	Intel-based Linux platforms
  linux	arm64	ARM servers and Raspberry PI4
  darwin	amd64	Intel-based Macs
  darwin	arm64	ARM-based Macs

• Supports image deletion by tag

• Currently suitable for on-prem deployments (e.g. colocated with Kubernetes)

• Compatible with ecosystem tools such as skopeo and cri-o

• Vulnerability scanning of images

• TLS support

• Authentication via:

  • TLS mutual authentication
  • HTTP Basic (local htpasswd and LDAP)
  • HTTP Bearer token

• Supports Identity-Based Access Control

• Supports live modifications on the config file while zot is running (Authorization config only)

• Doesn't require root privileges

• Storage optimizations:

  • Automatic garbage collection of orphaned blobs
  • Layer deduplication using hard links when content is identical

• Serve multiple storage paths (and backends) using a single zot server

• Pull and synchronize from other dist-spec conformant registries sync

• Supports ratelimiting including per HTTP method

• Metrics with Prometheus

• Swagger based documentation

• Single binary for all the above features

• zli: command-line client support

• Also, zb: a benchmarking tool for dist-spec conformant registries

• Released under Apache 2.0 License

  • Using a node exporter in case of dist-spec-only zot

• go get -u github.com/project-zot/zot/cmd/zot

Sponsors

• Cisco Systems, Inc.

Presentations

• OCI Weekly Discussion - Oct 2, 2019

Build and install binary (using host's toolchain)

go get -u github.com/project-zot/zot/cmd/zot

Full CI/CD Build

• Build inside a container (preferred)

make binary-container

• Alternatively, build inside a container using stacker (preferred)

make binary-stacker

• Build using host's toolchain

make

• Build zot with specified extensions

make binary EXTENSIONS=extension1,extension2,extension3
# e.g. make binary EXTENSIONS=sync,search,metrics,scrub

Build artifacts are in bin/

Serving

bin/zot serve _config-file_

Examples of config files are available in examples/ dir.

Container Image

The Dockerfile in this repo can be used to build a container image that runs zot.

To build the image with ref zot:latest:

make image

Then run the image with your preferred container runtime:

# with podman
podman run --rm -it -p 5000:5000 -v $(pwd)/registry:/var/lib/registry zot:latest

# with docker
docker run --rm -it -p 5000:5000 -v $(pwd)/registry:/var/lib/registry zot:latest

This will run a registry at http://localhost:5000, storing content at ./registry (bind mounted to /var/lib/registry in the container). By default, auth is disabled.

If you wish use custom configuration settings, you can override the YAML config file located at /etc/zot/config.yml:

# Example: using a local file "custom-config.yml" that
# listens on port 8080 and uses /tmp/zot for storage root
podman run --rm -p 8080:8080 \
  -v $(pwd)/custom-config.yml:/etc/zot/config.yml \
  -v $(pwd)/registry:/tmp/zot \
  zot:latest

CLI

Building zli

You can interact with the zot registry server using the zli binary.

$ make cli

will produce bin/zli binary.

Adding a zot server URL

To add a zot server URL with an alias "remote-zot":

$ zli config add remote-zot https://server-example:8080

List all configured URLs with their aliases:

$ zli config -l
remote-zot https://server-example:8080
local      http://localhost:8080

Listing images

You can list all images from a server by using its alias specified in this step:

$ zli images remote-zot
IMAGE NAME                        TAG                       DIGEST    SIZE
postgres                          9.6.18-alpine             ef27f3e1  14.4MB
postgres                          9.5-alpine                264450a7  14.4MB
busybox                           latest                    414aeb86  707.8KB

Or filter the list by an image name:

$ zli images remote-zot -n busybox
IMAGE NAME                        TAG                       DIGEST    SIZE
busybox                           latest                    414aeb86  707.8KB

Scanning images for known vulnerabilities

You can fetch CVE (Common Vulnerabilities and Exposures) info for images hosted on zot

• Get all images affected by a CVE

$ zli cve remote-zot -i CVE-2017-9935
IMAGE NAME                        TAG                       DIGEST    SIZE
c3/openjdk-dev                    commit-5be4d92            ac3762e2  335MB

• Get all CVEs for an image

$ zli cve remote-zot -I c3/openjdk-dev:0.3.19
ID                SEVERITY  TITLE
CVE-2015-8540     LOW       libpng: underflow read in png_check_keyword()
CVE-2017-16826    LOW       binutils: Invalid memory access in the coff_s...

• Get detailed json output

$ zli cve remote-zot -I c3/openjdk-dev:0.3.19 -o json
{
  "Tag": "0.3.19",
  "CVEList": [
    {
      "Id": "CVE-2019-17006",
      "Severity": "MEDIUM",
      "Title": "nss: Check length of inputs for cryptographic primitives",
      "Description": "A vulnerability was discovered in nss where input text length was not checked when using certain cryptographic primitives. This could lead to a heap-buffer overflow resulting in a crash and data leak. The highest threat is to confidentiality and integrity of data as well as system availability.",
      "PackageList": [
        {
          "Name": "nss",
          "InstalledVersion": "3.44.0-7.el7_7",
          "FixedVersion": "Not Specified"
        },
        {
          "Name": "nss-sysinit",
          "InstalledVersion": "3.44.0-7.el7_7",
          "FixedVersion": "Not Specified"
        },
        {
          "Name": "nss-tools",
          "InstalledVersion": "3.44.0-7.el7_7",
          "FixedVersion": "Not Specified"
        }
      ]
    },

• Get all images in a specific repo affected by a CVE

$ zli cve remote-zot -I c3/openjdk-dev -i CVE-2017-9935
IMAGE NAME                        TAG                       DIGEST    SIZE
c3/openjdk-dev                    commit-2674e8a            71046748  338MB
c3/openjdk-dev                    commit-bd5cc94            0ab7fc76  

• Get all images of a specific repo where a CVE is fixed

$ zli cve remote-zot -I c3/openjdk-dev -i CVE-2017-9935 --fixed
IMAGE NAME                        TAG                       DIGEST    SIZE
c3/openjdk-dev                    commit-2674e8a-squashfs   b545b8ba  321MB
c3/openjdk-dev                    commit-d5024ec-squashfs   cd45f8cf  321MB

Sync (pull-based mirroring)

Periodically pull and synchronize images between zot registries. The synchronization is achieved by copying all the images found at source to destination. To use it see sync-config Supports:

• TLS verification
• Prefix filtering (can contain multiple repos, eg repo1/repoX/repoZ)
• Tags regex filtering
• Tags semver compliance filtering (the 'v' prefix is optional)
• BASIC auth
• Image signatures

Benchmarking

You can benchmark a zot registry or any other dist-spec conformant registry with zb.

Building zb

$ make bench

will produce bin/zb binary.

Running zb

See details

Ecosystem

skopeo

skopeo is a tool to work with remote image repositories.

• Pull Images

skopeo copy docker://<zot-server:port>/repo:tag docker://<another-server:port>/repo:tag

• Push Images

skopeo copy --format=oci docker://<another-server:port>/repo:tag docker://<zot-server:port>/repo:tag

cri-o

cri-o is a OCI-based Kubernetes container runtime interface.

Works with "docker://" transport which is the default.

Metrics

Can be used for both dist-spec-only zot & the zot with all extensions enabled

Node Exporter

The dist-spec-only zot exposes internal metrics into a Prometheus format through a node exporter. The configuration of node exporter contains connection details for the zot server it is intend to scrape metrics from. See a configuration example. The metrics are automatically enabled in the zot server on first scrape from the Node Exporter (no extra configuration option is needed). Similarly, the metrics are automatically disabled when Node Exporter did not perform any scrapings in a while.

bin/zxp config _config-file_

Enable Metrics

In the zot with all extensions case see configuration example for enabling metrics

Image linting

Mandatory Annotations

When pushing an image, if the mandatory annotations option is enabled, linter will verify if the mandatory annotations list present in the config is also found in the manifest's annotations list. If there are any missing annotations, the push will not take place.

Clustering

zot supports clustering by using multiple stateless zot with shared s3 storage and a haproxy (with sticky session) in front of them.

• haproxy configuration example
• zot s3 configuration example

Contributing

We encourage and support an active, healthy community of contributors.

• Details are in the code of conduct
• Details to get started on code development are in contributing document.