0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-16 21:56:37 -05:00
zot/README.md

102 lines
3 KiB
Markdown
Raw Normal View History

# zot [![Build Status](https://travis-ci.org/anuvu/zot.svg?branch=master)](https://travis-ci.org/anuvu/zot) [![codecov.io](http://codecov.io/github/anuvu/zot/coverage.svg?branch=master)](http://codecov.io/github/anuvu/zot?branch=master)
2019-06-20 18:36:40 -05:00
2019-10-07 15:26:19 -05:00
**zot** is a vendor-neutral OCI image repository server purely based on
2019-10-09 13:50:10 -05:00
[OCI Distribution Specification](https://github.com/opencontainers/distribution-spec).
2019-06-20 18:36:40 -05:00
* Conforms to [OCI distribution spec](https://github.com/opencontainers/distribution-spec) APIs [![zot](https://github.com/bloodorangeio/oci-distribution-conformance-results/workflows/zot/badge.svg)](https://oci.bloodorange.io/results/report-zot.html) [![zot w. auth](https://github.com/bloodorangeio/oci-distribution-conformance-results/workflows/zot-auth/badge.svg)](https://oci.bloodorange.io/results/report-zot-auth.html)
2019-06-20 18:36:40 -05:00
* Uses [OCI storage layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md) for storage layout
* Currently suitable for on-prem deployments (e.g. colocated with Kubernetes)
2019-06-20 18:36:40 -05:00
* TLS support
2019-08-15 11:34:54 -05:00
* Authentication via TLS mutual authentication and HTTP *BASIC* (local _htpasswd_ and LDAP)
2019-08-28 17:16:11 -05:00
* Doesn't require _root_ privileges
2019-08-15 11:34:54 -05:00
* Swagger based documentation
2019-10-07 15:26:19 -05:00
* Released under Apache 2.0 License
* ```go get -u github.com/anuvu/zot/cmd/zot```
2019-10-07 15:26:19 -05:00
2019-10-07 15:26:19 -05:00
# Presentations
* [OCI Weekly Discussion - Oct 2, 2019](https://hackmd.io/El8Dd2xrTlCaCG59ns5cwg#October-2-2019)
2019-06-26 16:28:34 -05:00
# Build and install binary (using host's toolchain)
```
go get -u github.com/anuvu/zot/cmd/zot
```
# Full CI/CD Build
* Build inside a container (preferred)
```
make binary-container
```
* Alternatively, build inside a container using [stacker](https://github.com/anuvu/stacker) (preferred)
```
make binary-stacker
```
* Build using host's toolchain
```
make
```
Build artifacts are in bin/
2019-10-09 13:50:10 -05:00
# Serving
```
2019-08-28 17:16:11 -05:00
bin/zot serve _config-file_
2019-10-09 13:50:10 -05:00
```
2019-08-28 17:16:11 -05:00
Examples of config files are available in [examples/](examples/) dir.
# Ecosystem
Since we couldn't find clients or client libraries that are stictly compliant to
the dist spec, we had to patch containers/image (available as [anuvu/image](https://github.com/anuvu/image)) and
then link various binaries against the patched version.
2019-08-28 17:16:11 -05:00
## skopeo
[skopeo](https://github.com/containers/skopeo) is a tool to work with remote
image repositories.
We have a [patched version](https://github.com/anuvu/skopeo) available that
works with _zot_.
```
git clone https://github.com/anuvu/skopeo
cd skopeo
make GO111MODULE=on binary-local
```
## cri-o
[cri-o](https://github.com/cri-o/cri-o) is a OCI-based Kubernetes container
runtime interface.
We have a [patched version](https://github.com/anuvu/image) of containers/image
available that works with _zot_ which must be linked with cri-o.
```
git clone https://github.com/cri-o/cri-o
cd cri-o
echo 'replace github.com/containers/image => github.com/anuvu/image v1.5.2-0.20190827234748-f71edca6153a' >> go.mod
make bin/crio crio.conf GO111MODULE=on
```
2019-06-26 16:28:34 -05:00
# Caveats
* go 1.12+
* The OCI distribution spec is still WIP, and we try to keep up