From 9c85cf4653a76b5846acd65ac7b4442302dbc360 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Thu, 12 Dec 2024 17:10:14 +0100 Subject: [PATCH] fix: Doc about installing ImagePuller (#2835) Signed-off-by: Anatolii Bazko --- ...ing-images-for-faster-workspace-start.adoc | 1 + ...g-image-puller-on-openshift-using-cli.adoc | 30 ++++++++++++------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc b/modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc index 65e999e5ba..be6046f3d8 100644 --- a/modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc +++ b/modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc @@ -23,4 +23,5 @@ include::partial$snip_configuring-kubernetes-image-puller.adoc[] .Additional resources +* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[] * link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository] diff --git a/modules/administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc b/modules/administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc index 2ae93e1d17..9184861b77 100644 --- a/modules/administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc +++ b/modules/administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc @@ -9,15 +9,19 @@ You can install the {image-puller-name} on OpenShift by using OpenShift `oc` management tool. +[IMPORTANT] +==== +If the ImagePuller is installed with the `oc` CLI, it cannot be configured via the `CheCluster` Custom Resource. +==== + .Prerequisites * 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]. .Procedure -. Gather a list of relevant container images to pull by navigating to the links: -* `pass:c,a,q[{prod-url}]/plugin-registry/v3/external_images.txt` -* `pass:c,a,q[{prod-url}]/devfile-registry/devfiles/external_images.txt` +. Gather a list of relevant container images to pull by following the doc: +xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[] . Define the memory requests and limits parameters to ensure pulled containers and the platform have enough memory to run. + @@ -37,8 +41,8 @@ Pulling 5 images on 20 nodes, with a container memory limit of `20Mi` requires ` + [subs="+attributes,+quotes"] ---- -$ git clone https://github.com/che-incubator/{image-puller-repository-name} -$ cd {image-puller-repository-name}/deploy/openshift +git clone https://github.com/che-incubator/{image-puller-repository-name} +cd {image-puller-repository-name}/deploy/openshift ---- . 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 + [subs="+attributes,+quotes"] ---- -$ oc new-project __<{image-puller-namespace}>__ +oc new-project __<{image-puller-namespace}>__ ---- . Process and apply the templates to install the puller: + [subs="+attributes,+quotes"] ---- -$ oc process -f serviceaccount.yaml | oc apply -f - -$ oc process -f configmap.yaml | oc apply -f - -$ oc process -f app.yaml | oc apply -f - +oc process -f serviceaccount.yaml | oc apply -f - +oc process -f configmap.yaml | oc apply -f - +oc process -f app.yaml | oc apply -f - ---- @@ -152,12 +156,16 @@ $ oc process -f app.yaml | oc apply -f - + [source%nowrap,dummy,subs="+quotes,+attributes"] ---- -$ oc get deployment,daemonset,pod --namespace __<{image-puller-namespace}>__ +oc get deployment,daemonset,pod --namespace __<{image-puller-namespace}>__ ---- . Verify the values of the __<{image-puller-deployment-name}>__ `ConfigMap`. + [source%nowrap,dummy,subs="+quotes,+attributes"] ---- -$ oc get configmap __<{image-puller-deployment-name}>__ --output yaml +oc get configmap __<{image-puller-deployment-name}>__ --output yaml ---- + +.Additional resources + +* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[] \ No newline at end of file