7
7
## oci_image
8
8
9
9
<pre >
10
- oci_image(<a href =" #oci_image-name " >name</a >, <a href =" #oci_image-arch " >arch</a >, <a href =" #oci_image-base " >base</a >, <a href =" #oci_image-layers " >layers</a >, <a href =" #oci_image-os " >os</a >)
10
+ oci_image(<a href =" #oci_image-name " >name</a >, <a href =" #oci_image-annotations " >annotations</ a >, < a href = " #oci_image- arch" >arch</a >, <a href =" #oci_image-base " >base</ a >, < a href = " #oci_image-entrypoint " >entrypoint </a >, <a href =" #oci_image-layers " >layers</a >, <a href =" #oci_image-os " >os</a >)
11
11
</pre >
12
12
13
13
14
+
14
15
15
16
** ATTRIBUTES**
16
17
17
18
18
19
| Name | Description | Type | Mandatory | Default |
19
20
| :------------- | :------------- | :------------- | :------------- | :------------- |
20
21
| <a id =" oci_image-name " ></a >name | A unique name for this target. | <a href =" https://bazel.build/docs/build-ref.html#name " >Name</a > | required | |
21
- | <a id =" oci_image-arch " ></a >arch | - | String | optional | "" |
22
- | <a id =" oci_image-base " ></a >base | - | <a href =" https://bazel.build/docs/build-ref.html#labels " >Label</a > | required | |
23
- | <a id =" oci_image-layers " ></a >layers | - | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
24
- | <a id =" oci_image-os " ></a >os | - | String | optional | "" |
22
+ | <a id =" oci_image-annotations " ></a >annotations | | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
23
+ | <a id =" oci_image-arch " ></a >arch | | String | optional | "" |
24
+ | <a id =" oci_image-base " ></a >base | | <a href =" https://bazel.build/docs/build-ref.html#labels " >Label</a > | required | |
25
+ | <a id =" oci_image-entrypoint " ></a >entrypoint | - | List of strings | optional | [ ] |
26
+ | <a id =" oci_image-layers " ></a >layers | | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
27
+ | <a id =" oci_image-os " ></a >os | | String | optional | "" |
25
28
26
29
27
30
<a id =" #oci_image_index " ></a >
28
31
29
32
## oci_image_index
30
33
31
34
<pre >
32
- oci_image_index(<a href =" #oci_image_index-name " >name</a >, <a href =" #oci_image_index-manifests " >manifests</a >)
35
+ oci_image_index(<a href =" #oci_image_index-name " >name</a >, <a href =" #oci_image_index-annotations " >annotations</ a >, < a href = " #oci_image_index- manifests" >manifests</a >)
33
36
</pre >
34
37
35
38
39
+
36
40
37
41
** ATTRIBUTES**
38
42
39
43
40
44
| Name | Description | Type | Mandatory | Default |
41
45
| :------------- | :------------- | :------------- | :------------- | :------------- |
42
46
| <a id =" oci_image_index-name " ></a >name | A unique name for this target. | <a href =" https://bazel.build/docs/build-ref.html#name " >Name</a > | required | |
43
- | <a id =" oci_image_index-manifests " ></a >manifests | - | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
47
+ | <a id =" oci_image_index-annotations " ></a >annotations | | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
48
+ | <a id =" oci_image_index-manifests " ></a >manifests | | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
44
49
45
50
46
51
<a id =" #oci_image_layer " ></a >
47
52
48
53
## oci_image_layer
49
54
50
55
<pre >
51
- oci_image_layer(<a href =" #oci_image_layer-name " >name</a >, <a href =" #oci_image_layer-directory " >directory</a >, <a href =" #oci_image_layer-files " >files</a >, <a href =" #oci_image_layer-symlinks " >symlinks</a >)
56
+ oci_image_layer(<a href =" #oci_image_layer-name " >name</a >, <a href =" #oci_image_layer-directory " >directory</a >, <a href =" #oci_image_layer-file_map " >file_map</ a >, < a href = " #oci_image_layer- files" >files</a >, <a href =" #oci_image_layer-symlinks " >symlinks</a >)
52
57
</pre >
53
58
54
59
60
+
55
61
56
62
** ATTRIBUTES**
57
63
58
64
59
65
| Name | Description | Type | Mandatory | Default |
60
66
| :------------- | :------------- | :------------- | :------------- | :------------- |
61
67
| <a id =" oci_image_layer-name " ></a >name | A unique name for this target. | <a href =" https://bazel.build/docs/build-ref.html#name " >Name</a > | required | |
62
- | <a id =" oci_image_layer-directory " ></a >directory | - | String | optional | "" |
63
- | <a id =" oci_image_layer-files " ></a >files | - | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
64
- | <a id =" oci_image_layer-symlinks " ></a >symlinks | - | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
68
+ | <a id =" oci_image_layer-directory " ></a >directory | | String | optional | "" |
69
+ | <a id =" oci_image_layer-file_map " ></a >file_map | - | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: Label -> String</a > | optional | {} |
70
+ | <a id =" oci_image_layer-files " ></a >files | | <a href =" https://bazel.build/docs/build-ref.html#labels " >List of labels</a > | optional | [ ] |
71
+ | <a id =" oci_image_layer-symlinks " ></a >symlinks | | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
65
72
66
73
67
74
<a id =" #oci_pull " ></a >
@@ -73,26 +80,27 @@ oci_pull(<a href="#oci_pull-name">name</a>, <a href="#oci_pull-digest">digest</a
73
80
</pre >
74
81
75
82
83
+
76
84
77
85
** ATTRIBUTES**
78
86
79
87
80
88
| Name | Description | Type | Mandatory | Default |
81
89
| :------------- | :------------- | :------------- | :------------- | :------------- |
82
90
| <a id =" oci_pull-name " ></a >name | A unique name for this repository. | <a href =" https://bazel.build/docs/build-ref.html#name " >Name</a > | required | |
83
- | <a id =" oci_pull-digest " ></a >digest | - | String | required | |
84
- | <a id =" oci_pull-registry " ></a >registry | - | String | required | |
91
+ | <a id =" oci_pull-digest " ></a >digest | | String | required | |
92
+ | <a id =" oci_pull-registry " ></a >registry | | String | required | |
85
93
| <a id =" oci_pull-repo_mapping " ></a >repo_mapping | A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.< ; p> ; For example, an entry <code >"@foo ": "@bar "</code > declares that, for any time this repository depends on <code >@foo </code > (such as a dependency on <code >@foo //some: target </code >, it should actually resolve that dependency within globally-declared <code >@bar </code > (<code >@bar //some: target </code >). | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | required | |
86
- | <a id =" oci_pull-repository " ></a >repository | - | String | required | |
87
- | <a id =" oci_pull-shallow " ></a >shallow | - | Boolean | optional | True |
94
+ | <a id =" oci_pull-repository " ></a >repository | | String | required | |
95
+ | <a id =" oci_pull-shallow " ></a >shallow | | Boolean | optional | True |
88
96
89
97
90
98
<a id =" #oci_push " ></a >
91
99
92
100
## oci_push
93
101
94
102
<pre >
95
- oci_push(<a href =" #oci_push-name " >name</a >, <a href =" #oci_push-manifest " >manifest</a >, <a href =" #oci_push-registry " >registry</a >, <a href =" #oci_push-repository " >repository</a >)
103
+ oci_push(<a href =" #oci_push-name " >name</a >, <a href =" #oci_push-headers " >headers</ a >, < a href = " #oci_push- manifest" >manifest</a >, <a href =" #oci_push-registry " >registry</a >, <a href =" #oci_push-repository " >repository</ a >, < a href = " #oci_push-tag " >tag</ a >, < a href = " #oci_push-x_meta_headers " >x_meta_headers </a >)
96
104
</pre >
97
105
98
106
@@ -105,8 +113,11 @@ oci_push(<a href="#oci_push-name">name</a>, <a href="#oci_push-manifest">manifes
105
113
| Name | Description | Type | Mandatory | Default |
106
114
| :------------- | :------------- | :------------- | :------------- | :------------- |
107
115
| <a id =" oci_push-name " ></a >name | A unique name for this target. | <a href =" https://bazel.build/docs/build-ref.html#name " >Name</a > | required | |
116
+ | <a id =" oci_push-headers " ></a >headers | (optional) A list of key/values to to be sent to the registry as headers. | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
108
117
| <a id =" oci_push-manifest " ></a >manifest | A manifest to push to a registry. If an OCILayout index, then push all artifacts with a 'org.opencontainers.image.ref.name' annotation. | <a href =" https://bazel.build/docs/build-ref.html#labels " >Label</a > | optional | None |
109
118
| <a id =" oci_push-registry " ></a >registry | A registry host to push to, if not present consult the toolchain. | String | optional | "" |
110
119
| <a id =" oci_push-repository " ></a >repository | A repository to push to, if not present consult the toolchain. | String | optional | "" |
120
+ | <a id =" oci_push-tag " ></a >tag | (optional) A tag to include in the target reference. This will not be included on child images." | String | optional | "" |
121
+ | <a id =" oci_push-x_meta_headers " ></a >x_meta_headers | (optional) A list of key/values to to be sent to the registry as headers with an X-Meta- prefix. | <a href =" https://bazel.build/docs/skylark/lib/dict.html " >Dictionary: String -> String</a > | optional | {} |
111
122
112
123
0 commit comments