ocibuilder

package module
v0.0.0-...-b7fcf81 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 15, 2020 License: Apache-2.0 Imports: 0 Imported by: 0

README

ocibuilder - Build Open Container Initiative (OCI) compliant images the declarative way

slack Go Report Card CircleCI Docs License

What is the ocibuilder?

The ocibuilder offers a command line tool called the ocictl to build, push and pull OCI compliant images through declarative specifications, allowing you to pick between Buildah or Docker as the container build tool.

Logo

Features

  • Specify docker or buildah as a build tool.
  • Define multiple builds in single build configuration.
  • Ability to templatize build stages.
  • Multi-stage build support
  • Parameterize build configuration at runtime with environment variable support.
  • Supports distroless to produce lean images.
  • Supports ansible roles as build stage.
  • Supports build contexts like Local Filesystem, Git, S3, Google Cloud Storage, Azure Storage Blob, Aliyun OSS
  • All basic features like registry login, pulling and pushing images from/to multiple registries.

Architecture

architecture

Install

Binary downloads of the ocictl are available on the Releases page.

You can use the install.sh script to install the latest version of ocictl:

curl https://raw.githubusercontent.com/ocibuilder/ocibuilder/master/install.sh | sh

This requires GOPATH to be set, with bin added to your PATH.

The latest images with Buildah and Docker pre-installed alongside the ocictl is available on our Dockerhub repository.

Read the full installation guide available in our docs.

Getting Started

To learn more about the ocibuilder and how to get started take a look at our quick start guide.

Documentation

View our complete documentation.

The ocibuilder.yaml specification file with all fields available and examples is documented here.

Roadmap

Take a look at our roadmap and features in developement here

Contribute

Please read the CONTRIBUTING.md for contributing guidelines.

License

Apache License Version 2.0, see LICENSE

References

Docker: https://github.com/docker

Buildah Commands: https://github.com/containers/buildah

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
pkg
apis/ocibuilder/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.
client/ocibuilder/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/ocibuilder/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/ocibuilder/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/ocibuilder/clientset/versioned/typed/ocibuilder/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/ocibuilder/clientset/versioned/typed/ocibuilder/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
oci
testing
e2e

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL