Skip to content

Commit 82eb701

Browse files
authored
Merge pull request #86685 from subhtk/osd10841
OSDOCS 10841: Added helm charts updates in oc-mirror v2 docs.
2 parents 61f5354 + 76c8918 commit 82eb701

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,70 @@ 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. The `oc-mirror` plugin does not support helm charts with manually modified `values.yaml` files.
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+
imagePaths:
116+
- "{.spec.template.spec.custom[*].image}"
117+
----
118+
119+
|`mirror.helm.repositories.name`
120+
|The name of the helm repository to mirror from.
121+
|String. For example: `podinfo`.
122+
123+
|`mirror.helm.repositories.url`
124+
|The URL of the helm repository to mirror from.
125+
|String. For example: [x-]`https://example.github.io/podinfo`.
126+
127+
|`mirror.helm.repositories.charts`
128+
|The remote helm charts to mirror.
129+
|Array of objects.
130+
131+
|`mirror.helm.repositories.charts.name`
132+
|The name of the helm chart to mirror.
133+
|String. For example: `podinfo`.
134+
135+
|`mirror.helm.repositories.charts.imagePaths`
136+
|The custom path of a container image inside of the helm chart.
137+
+
138+
[NOTE]
139+
====
140+
`oc-mirror` detects and mirrors container images from the helm chart by searching well-known paths. You can also specify custom paths using this field.
141+
====
142+
|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"`.
143+
80144
|`mirror.operators`
81145
|The Operators configuration of the image set.
82146
|Array of objects

modules/oc-mirror-v2-about.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ To use the new Technology Preview version of oc-mirror, add the `--v2` flag to t
1313

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

16+
* Provides a centralized method to mirror {product-title} releases, Operators, helm charts, and other images.
17+
18+
1619
* Verifies that the complete image set specified in the image set configuration file is mirrored to the mirrored registry, regardless of whether the images were previously mirrored or not.
1720
1821
* Uses a cache system instead of metadata, which prevents the need to start the mirroring process over in the case of a failure for a single step of the process.

0 commit comments

Comments
 (0)