Skip to content

Commit 3520204

Browse files
committed
Updated about helm charts in oc-mirror v2 docs
1 parent b5a3e5c commit 3520204

File tree

2 files changed

+60
-1
lines changed

2 files changed

+60
-1
lines changed

modules/oc-mirror-imageset-config-parameters-v2.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,63 @@ Example: `registry.redhat.io/ubi8/ubi:latest`
7777
|Array of strings
7878
Example: `docker.io/library/alpine`
7979

80+
|`mirror.helm`
81+
|The helm configuration of the image set. Note that the oc-mirror plugin supports only helm charts that do not require user input when rendered.
82+
|Object
83+
84+
|`mirror.helm.local`
85+
|The local helm charts to mirror.
86+
|Array of objects. For example:
87+
88+
[source,yaml]
89+
----
90+
local:
91+
- name: podinfo
92+
path: /test/podinfo-5.0.0.tar.gz
93+
----
94+
95+
|`mirror.helm.local.name`
96+
|The name of the local helm chart to mirror.
97+
|String. For example: `podinfo`.
98+
99+
|`mirror.helm.local.path`
100+
|The path of the local helm chart to mirror.
101+
|String. For example: `/test/podinfo-5.0.0.tar.gz`.
102+
103+
|`mirror.helm.repositories`
104+
|The remote helm repositories to mirror from.
105+
|Array of objects. For example:
106+
107+
[source,yaml]
108+
----
109+
repositories:
110+
- name: podinfo
111+
url: https://example.github.io/podinfo
112+
charts:
113+
- name: podinfo
114+
version: 5.0.0
115+
----
116+
117+
|`mirror.helm.repositories.name`
118+
|The name of the helm repository to mirror from.
119+
|String. For example: `podinfo`.
120+
121+
|`mirror.helm.repositories.url`
122+
|The URL of the helm repository to mirror from.
123+
|String. For example: [x-]`https://example.github.io/podinfo`.
124+
125+
|`mirror.helm.repositories.charts`
126+
|The remote helm charts to mirror.
127+
|Array of objects.
128+
129+
|`mirror.helm.repositories.charts.name`
130+
|The name of the helm chart to mirror.
131+
|String. For example: `podinfo`.
132+
133+
|`mirror.helm.repositories.charts.version`
134+
|The version of the named helm chart to mirror.
135+
|String. For example: `5.0.0`.
136+
80137
|`mirror.operators`
81138
|The Operators configuration of the image set.
82139
|Array of objects

modules/oc-mirror-v2-about.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@
99

1010
The oc-mirror OpenShift CLI (`oc`) plugin is a single tool that mirrors all required {product-title} content and other images to your mirror registry.
1111

12-
To use the new Technology Preview version of oc-mirror, add the `--v2` flag to the oc-mirror plugin v2 command line.
12+
To use the new general available version of oc-mirror, add the `--v2` flag to the oc-mirror plugin v2 command line.
1313

1414
oc-mirror plugin v2 has the following features:
1515

1616
* Verifies that the complete image set specified in the image set config is mirrored to the mirrored registry, regardless of whether the images were previously mirrored or not.
1717
18+
* Provides a centralized method to mirror {product-title} releases, Operators, helm charts, and other images.
19+
1820
* Uses a cache system instead of metadata.
1921
2022
* Maintains minimal archive sizes by incorporating only new images into the archive.

0 commit comments

Comments
 (0)