Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Doc about installing ImagePuller #2835

Merged
merged 2 commits into from
Dec 12, 2024
Merged

fix: Doc about installing ImagePuller #2835

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c66bcf7
fix: Doc about installing ImagePuller
tolusha Dec 12, 2024
cad1f70
Merge remote-tracking branch 'origin/main' into CRW-7865
tolusha Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
30 changes: 19 additions & 11 deletions .../administration-guide/pages/installing-image-puller-on-openshift-using-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
tolusha marked this conversation as resolved.
Show resolved Hide resolved
====

.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.
+
Expand All @@ -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:
Expand Down Expand Up @@ -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 -
----


Expand All @@ -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[]
Loading