oci

Documentation

Overview

/ Copyright 2015 The Bazel Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ////////////////////////////////////////////////////////////////////

Copyright 2015 The Bazel Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //////////////////////////////////////////////////////////////////// Reads an OCI image layout on disk. https://github.com/opencontainers/image-spec/blob/master/image-layout.md

Index

• func AsOCIImage(img v1.Image) (v1.Image, error)
• func Read(src string) (v1.Image, error)
• func Write(img v1.Image, dstPath string) error

Functions

func AsOCIImage

func AsOCIImage(img v1.Image) (v1.Image, error)

AsOCIImage converts the given v1.Image to the equivalent OCI image using an OCI schema 1 manifest.

func Read

func Read(src string) (v1.Image, error)

Read returns a docker image from the given path. The docker image should have been written by "Write". The image in the given path <src> follows the OCI Image Layout. (https://github.com/opencontainers/image-spec/blob/master/image-layout.md#oci-image-layout-specification) Specifically, <src> must contains "index.json" that servers as an entrypoint for the contained image. The image content and configs must be non-empty and stored in <src>/blobs/<SHAxxx>/. NOTE: this only reads index with a single image.

func Write

func Write(img v1.Image, dstPath string) error

Write writes a v1.Image to the Path and updates the index.json to reference it. This is just syntactic sugar wrapping Path.AppendImage from the go-container registry.