Skip to content

Commit 9c85cf4

Browse files
authored
fix: Doc about installing ImagePuller (#2835)
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
1 parent a3345f2 commit 9c85cf4

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ include::partial$snip_configuring-kubernetes-image-puller.adoc[]
2323

2424
.Additional resources
2525

26+
* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
2627
* link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository]

modules/administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@
99

1010
You can install the {image-puller-name} on OpenShift by using OpenShift `oc` management tool.
1111

12+
[IMPORTANT]
13+
====
14+
If the ImagePuller is installed with the `oc` CLI, it cannot be configured via the `CheCluster` Custom Resource.
15+
====
16+
1217
.Prerequisites
1318

1419
* An active `oc` session with administrative permissions to the OpenShift cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].
1520

1621
.Procedure
1722

18-
. Gather a list of relevant container images to pull by navigating to the links:
19-
* `pass:c,a,q[{prod-url}]/plugin-registry/v3/external_images.txt`
20-
* `pass:c,a,q[{prod-url}]/devfile-registry/devfiles/external_images.txt`
23+
. Gather a list of relevant container images to pull by following the doc:
24+
xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
2125

2226
. Define the memory requests and limits parameters to ensure pulled containers and the platform have enough memory to run.
2327
+
@@ -37,8 +41,8 @@ Pulling 5 images on 20 nodes, with a container memory limit of `20Mi` requires `
3741
+
3842
[subs="+attributes,+quotes"]
3943
----
40-
$ git clone https://github.com/che-incubator/{image-puller-repository-name}
41-
$ cd {image-puller-repository-name}/deploy/openshift
44+
git clone https://github.com/che-incubator/{image-puller-repository-name}
45+
cd {image-puller-repository-name}/deploy/openshift
4246
----
4347

4448
. Configure the `app.yaml`, `configmap.yaml` and `serviceaccount.yaml` OpenShift templates using following parameters:
@@ -133,16 +137,16 @@ $ cd {image-puller-repository-name}/deploy/openshift
133137
+
134138
[subs="+attributes,+quotes"]
135139
----
136-
$ oc new-project __<{image-puller-namespace}>__
140+
oc new-project __<{image-puller-namespace}>__
137141
----
138142

139143
. Process and apply the templates to install the puller:
140144
+
141145
[subs="+attributes,+quotes"]
142146
----
143-
$ oc process -f serviceaccount.yaml | oc apply -f -
144-
$ oc process -f configmap.yaml | oc apply -f -
145-
$ oc process -f app.yaml | oc apply -f -
147+
oc process -f serviceaccount.yaml | oc apply -f -
148+
oc process -f configmap.yaml | oc apply -f -
149+
oc process -f app.yaml | oc apply -f -
146150
----
147151

148152

@@ -152,12 +156,16 @@ $ oc process -f app.yaml | oc apply -f -
152156
+
153157
[source%nowrap,dummy,subs="+quotes,+attributes"]
154158
----
155-
$ oc get deployment,daemonset,pod --namespace __<{image-puller-namespace}>__
159+
oc get deployment,daemonset,pod --namespace __<{image-puller-namespace}>__
156160
----
157161

158162
. Verify the values of the __<{image-puller-deployment-name}>__ `ConfigMap`.
159163
+
160164
[source%nowrap,dummy,subs="+quotes,+attributes"]
161165
----
162-
$ oc get configmap __<{image-puller-deployment-name}>__ --output yaml
166+
oc get configmap __<{image-puller-deployment-name}>__ --output yaml
163167
----
168+
169+
.Additional resources
170+
171+
* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]

0 commit comments

Comments
 (0)