1
1
# go-containerregistry
2
2
3
- [ ![ GitHub Actions Build Status] ( https://github.com/stgrace /go-containerregistry/workflows/Build/badge.svg )] ( https://github.com/stgrace /go-containerregistry/actions?query=workflow%3ABuild )
4
- [ ![ GoDoc] ( https://godoc.org/github.com/stgrace /go-containerregistry?status.svg )] ( https://godoc.org/github.com/stgrace /go-containerregistry )
3
+ [ ![ GitHub Actions Build Status] ( https://github.com/google /go-containerregistry/workflows/Build/badge.svg )] ( https://github.com/google /go-containerregistry/actions?query=workflow%3ABuild )
4
+ [ ![ GoDoc] ( https://godoc.org/github.com/google /go-containerregistry?status.svg )] ( https://godoc.org/github.com/google /go-containerregistry )
5
5
[ ![ Code Coverage] ( https://codecov.io/gh/google/go-containerregistry/branch/main/graph/badge.svg )] ( https://codecov.io/gh/google/go-containerregistry )
6
6
7
7
## Introduction
@@ -15,9 +15,9 @@ The following diagram shows the main types that this library handles.
15
15
## Philosophy
16
16
17
17
The overarching design philosophy of this library is to define interfaces that present an immutable
18
- view of resources (e.g. [ ` Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1#Image ) ,
19
- [ ` Layer ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1#Layer ) ,
20
- [ ` ImageIndex ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1#ImageIndex ) ),
18
+ view of resources (e.g. [ ` Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1#Image ) ,
19
+ [ ` Layer ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1#Layer ) ,
20
+ [ ` ImageIndex ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1#ImageIndex ) ),
21
21
which can be backed by a variety of medium (e.g. [ registry] ( ./pkg/v1/remote/README.md ) ,
22
22
[ tarball] ( ./pkg/v1/tarball/README.md ) , [ daemon] ( ./pkg/v1/daemon/README.md ) , ...).
23
23
@@ -43,45 +43,45 @@ Over time, we will add new functionality under experimental environment variable
43
43
44
44
#### Sources
45
45
46
- * [ ` remote.Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#Image )
47
- * [ ` tarball.Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/tarball#Image )
48
- * [ ` daemon.Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/daemon#Image )
49
- * [ ` layout.Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/layout#Path.Image )
50
- * [ ` random.Image ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/random#Image )
46
+ * [ ` remote.Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#Image )
47
+ * [ ` tarball.Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/tarball#Image )
48
+ * [ ` daemon.Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/daemon#Image )
49
+ * [ ` layout.Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/layout#Path.Image )
50
+ * [ ` random.Image ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/random#Image )
51
51
52
52
#### Sinks
53
53
54
- * [ ` remote.Write ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#Write )
55
- * [ ` tarball.Write ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/tarball#Write )
56
- * [ ` daemon.Write ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/daemon#Write )
57
- * [ ` legacy/tarball.Write ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/legacy/tarball#Write )
58
- * [ ` layout.AppendImage ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/layout#Path.AppendImage )
54
+ * [ ` remote.Write ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#Write )
55
+ * [ ` tarball.Write ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/tarball#Write )
56
+ * [ ` daemon.Write ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/daemon#Write )
57
+ * [ ` legacy/tarball.Write ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/legacy/tarball#Write )
58
+ * [ ` layout.AppendImage ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/layout#Path.AppendImage )
59
59
60
60
### ` v1.ImageIndex `
61
61
62
62
#### Sources
63
63
64
- * [ ` remote.Index ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#Index )
65
- * [ ` random.Index ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/random#Index )
66
- * [ ` layout.ImageIndexFromPath ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/layout#ImageIndexFromPath )
64
+ * [ ` remote.Index ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#Index )
65
+ * [ ` random.Index ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/random#Index )
66
+ * [ ` layout.ImageIndexFromPath ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/layout#ImageIndexFromPath )
67
67
68
68
#### Sinks
69
69
70
- * [ ` remote.WriteIndex ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#WriteIndex )
71
- * [ ` layout.Write ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/layout#Write )
70
+ * [ ` remote.WriteIndex ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#WriteIndex )
71
+ * [ ` layout.Write ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/layout#Write )
72
72
73
73
### ` v1.Layer `
74
74
75
75
#### Sources
76
76
77
- * [ ` remote.Layer ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#Layer )
78
- * [ ` tarball.LayerFromFile ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/tarball#LayerFromFile )
79
- * [ ` random.Layer ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/random#Layer )
80
- * [ ` stream.Layer ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/stream#Layer )
77
+ * [ ` remote.Layer ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#Layer )
78
+ * [ ` tarball.LayerFromFile ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/tarball#LayerFromFile )
79
+ * [ ` random.Layer ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/random#Layer )
80
+ * [ ` stream.Layer ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/stream#Layer )
81
81
82
82
#### Sinks
83
83
84
- * [ ` remote.WriteLayer ` ] ( https://godoc.org/github.com/stgrace /go-containerregistry/pkg/v1/remote#WriteLayer )
84
+ * [ ` remote.WriteLayer ` ] ( https://godoc.org/github.com/google /go-containerregistry/pkg/v1/remote#WriteLayer )
85
85
86
86
## Overview
87
87
0 commit comments