diff --git a/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc b/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc deleted file mode 100644 index f65493fabd..0000000000 --- a/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:_content-type: SNIPPET - -[source,bash,subs="+attributes,+quotes"] ----- -git clone https://github.com/che-incubator/{image-puller-repository-name} ----- diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 528678522c..6c01ed685c 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -45,10 +45,10 @@ *** xref:configuring-the-open-vsx-registry-url.adoc[] *** xref:configuring-a-user-namespace.adoc[] ** xref:caching-images-for-faster-workspace-start.adoc[] -*** xref:installing-image-puller-by-using-cli.adoc[] -*** xref:installing-image-puller-on-openshift-using-the-web-console.adoc[] +*** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] +*** xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] *** xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[] -*** xref:configuring-image-puller-to-override-default-che-images.adoc[] +*** xref:configuring-image-puller-to-pre-pull-custom-images.adoc[] *** xref:configuring-image-puller-to-pre-pull-additional-images.adoc[] ** xref:configuring-observability.adoc[] **** xref:the-woopra-telemetry-plugin.adoc[] 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 e74c2f3fc2..acd789a568 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 @@ -10,19 +10,21 @@ To improve the start time performance of {prod-short} workspaces, use the {image-puller-name-short}, a {prod-short}-agnostic component that can be used -to pre-pull images for {platforms-name} clusters. The {image-puller-name-short} is an +to pre-pull images for {platforms-name} clusters. + +The {image-puller-name-short} is an additional {platforms-name} deployment which creates a _DaemonSet_ that can be configured to pre-pull relevant {prod-short} workspace images on each node. These images would already be available when a {prod-short} workspace starts, therefore improving the workspace start time. -* xref:installing-image-puller-by-using-cli.adoc[] +* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] -* xref:installing-image-puller-on-openshift-using-the-web-console.adoc[] +* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] * xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[] -* xref:configuring-image-puller-to-override-default-che-images.adoc[] +* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[] * xref:configuring-image-puller-to-pre-pull-additional-images.adoc[] diff --git a/modules/administration-guide/pages/configuring-image-puller-to-override-default-che-images.adoc b/modules/administration-guide/pages/configuring-image-puller-to-override-default-che-images.adoc deleted file mode 100644 index e0c9159b39..0000000000 --- a/modules/administration-guide/pages/configuring-image-puller-to-override-default-che-images.adoc +++ /dev/null @@ -1,42 +0,0 @@ -:_content-type: PROCEDURE -:description: Configuring {image-puller-name-short} to override default {prod-short} images to pre-pull -:keywords: administration-guide, image-puller, CLI -:navtitle: You can configure {image-puller-name} to override default {prod-short} images to pre-pull -:page-aliases: - -[id="configuring-image-puller-to-override-default-che-images"] -= Configuring {image-puller-name-short} to override default {prod-short} images to pre-pull - -You can configure {image-puller-name} to override default {prod-short} images to pre-pull. - -.Prerequisites - -* Your organization's instance of {prod-short} is installed and running on {kubernetes} cluster. - -* {image-puller-name-short} is installed on {kubernetes} cluster. - -* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. - -.Procedure - -. Configure the {image-puller-name-short} to pre-pull {prod-short} images. -+ -[source,shell,subs="+attributes,+quotes"] ----- -{orch-cli} patch checluster/{prod-checluster} \ - --namespace {prod-namespace} \ - --type='merge' \ - --patch '{ - "spec": { - "components": { - "imagePuller": { - "enable": true, - "spec": { - "images": "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__" <1> - } - } - } - } - }' ----- -<1> The semicolon separated list of images \ No newline at end of file diff --git a/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc index 71a1590b7c..b0102ef005 100644 --- a/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc +++ b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc @@ -7,9 +7,7 @@ [id="configuring-image-puller-to-pre-pull-additional-images"] = Configuring {image-puller-name-short} to pre-pull additional images -You can configure {image-puller-name} to pre-pull {prod-short} images. -{prod} operator will control the list of images to pre-pull and automatically updates them -on {prod-short} upgrade. +You can configure {image-puller-name} to pre-pull additional {prod-short} images. .Prerequisites @@ -21,20 +19,32 @@ on {prod-short} upgrade. .Procedure -. Configure the {image-puller-name-short} to pre-pull {prod-short} images. +. Create `{image-puller-namespace}` namespace: + [source,shell,subs="+attributes,"] ---- -{orch-cli} patch checluster/{prod-checluster} \ - --namespace {prod-namespace} \ - --type='merge' \ - --patch '{ - "spec": { - "components": { - "imagePuller": { - "enable": true, - } - } - } - }' ----- \ No newline at end of file +{orch-cli} create namespace {image-puller-namespace} +---- + +. Create `{image-puller-cr-name}` Custom Resource: ++ +[source,shell,subs="+attributes,"] +---- +{orch-cli} apply -f - < +EOF +---- +<1> The semicolon separated list of images + +.Addition resources + +* https://github.com/che-incubator/kubernetes-image-puller[{image-puller-name} source code repository] + +* https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository] + diff --git a/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.adoc b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.adoc new file mode 100644 index 0000000000..428823ec1c --- /dev/null +++ b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.adoc @@ -0,0 +1,42 @@ +:_content-type: PROCEDURE +:description: Configuring {image-puller-name-short} to pre-pull custom images +:keywords: administration-guide, image-puller, CLI +:navtitle: You can configure {image-puller-name} to pre-pull custom images +:page-aliases: + +[id="configuring-image-puller-to-pre-pull-custom-images"] += Configuring {image-puller-name-short} to pre-pull custom images + +You can configure {image-puller-name} to pre-pull custom images. + +.Prerequisites + +* Your organization's instance of {prod-short} is installed and running on {kubernetes} cluster. + +* {image-puller-name-short} is installed on {kubernetes} cluster. + +* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. + +.Procedure + +. Configure the {image-puller-name-short} to pre-pull custom images. ++ +[source,shell,subs="+attributes,+quotes"] +---- +{orch-cli} patch checluster/{prod-checluster} \ + --namespace {prod-namespace} \ + --type='merge' \ + --patch '{ + "spec": { + "components": { + "imagePuller": { + "enable": true, + "spec": { + "images": "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__" <1> + } + } + } + } + }' +---- +<1> The semicolon separated list of images \ No newline at end of file diff --git a/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc index ece9e69be1..f9ccc02dbf 100644 --- a/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc +++ b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc @@ -29,12 +29,12 @@ on {prod-short} upgrade. --namespace {prod-namespace} \ --type='merge' \ --patch '{ - "spec": { - "components": { - "imagePuller": { - "enable": true, - } - } + "spec": { + "components": { + "imagePuller": { + "enable": true + } } + } }' ---- \ No newline at end of file diff --git a/modules/administration-guide/pages/installing-image-puller-by-using-cli.adoc b/modules/administration-guide/pages/installing-image-puller-by-using-cli.adoc deleted file mode 100644 index f6cf8090f7..0000000000 --- a/modules/administration-guide/pages/installing-image-puller-by-using-cli.adoc +++ /dev/null @@ -1,40 +0,0 @@ -:_content-type: PROCEDURE -:description: Installing {image-puller-name-short} by using CLI -:keywords: administration-guide, image-puller, CLI -:navtitle: Installing {image-puller-name-short} by using CLI -:page-aliases: .:installing-image-puller-on-openshift-using-openshift-templates.adoc,installing-image-puller-on-openshift-using-openshift-templates.adoc - -[id="installing-image-puller-by-using-the-cli"] -= Installing {image-puller-name-short} by using the CLI - -You can install the {image-puller-name} on {platforms-name} cluster by using CLI. - -.Prerequisites - -* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. - -.Procedure - -. Clone the {image-puller-name-short} repository: -+ -include::example$snip_{project-context}-cloning-image-puller-project.adoc[] - -. Follow the link:https://github.com/che-incubator/{image-puller-repository-name}?tab=readme-ov-file#about[instruction] -to install the {image-puller-name} on {platforms-name} cluster. - -.Verification steps - -. Verify the existence of a `{image-puller-deployment-name}` deployment and a `{image-puller-deployment-name}` DaemonSet. -The DaemonSet needs to have a Pod for each node in the cluster: -+ -[source,shell,subs="+quotes,+attributes"] ----- -{orch-cli} get deployment,daemonset,pod --namespace {image-puller-namespace} ----- - -. Verify the values of the `{image-puller-deployment-name}` `ConfigMap`. -+ -[source,shell,subs="+quotes,+attributes"] ----- -{orch-cli} get configmap {image-puller-deployment-name} --output yaml ----- diff --git a/modules/administration-guide/pages/installing-image-puller-on-kubernetes-by-using-cli.adoc b/modules/administration-guide/pages/installing-image-puller-on-kubernetes-by-using-cli.adoc new file mode 100644 index 0000000000..8e1f78f3d5 --- /dev/null +++ b/modules/administration-guide/pages/installing-image-puller-on-kubernetes-by-using-cli.adoc @@ -0,0 +1,24 @@ +:_content-type: PROCEDURE +:description: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI +:keywords: administration-guide, image-puller, operator, CLI +:navtitle: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI +:page-aliases: .:installing-image-puller-on-openshift-using-openshift-templates.adoc,installing-image-puller-on-openshift-using-openshift-templates.adoc + +[id="installing-image-puller-on-kubernetes-cluster-by-using-the-cli"] += Installing {image-puller-name-short} operator on {kubernetes} cluster by using CLI + +You can install the {image-puller-name} operator on {kubernetes} cluster by using CLI. + +.Prerequisites + +* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. + +.Procedure + +. Visit link:https://operatorhub.io/operator/kubernetes-imagepuller-operator[{image-puller-operator-name}] page. + +. Click the `Install` button and follow the instruction. + +.Addition resources + +* https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository] \ No newline at end of file diff --git a/modules/administration-guide/pages/installing-image-puller-on-openshift-using-the-web-console.adoc b/modules/administration-guide/pages/installing-image-puller-on-openshift-by-using-the-web-console.adoc similarity index 77% rename from modules/administration-guide/pages/installing-image-puller-on-openshift-using-the-web-console.adoc rename to modules/administration-guide/pages/installing-image-puller-on-openshift-by-using-the-web-console.adoc index fc27ca20f6..64d809f85f 100644 --- a/modules/administration-guide/pages/installing-image-puller-on-openshift-using-the-web-console.adoc +++ b/modules/administration-guide/pages/installing-image-puller-on-openshift-by-using-the-web-console.adoc @@ -1,13 +1,13 @@ :_content-type: PROCEDURE -:description: Installing {image-puller-name-short} on OpenShift using the web console +:description: Installing {image-puller-name-short} on OpenShift by using the web console :keywords: administration-guide, image-puller, openshift, operator, operatorhub -:navtitle: Installing {image-puller-name-short} on OpenShift using the web console -:page-aliases: .:installing-image-puller-on-openshift-using-operatorhub.adoc, installing-image-puller-on-openshift-using-operatorhub.adoc +:navtitle: Installing {image-puller-name-short} on OpenShift by using the web console +:page-aliases: .:installing-image-puller-on-openshift-by-using-operatorhub.adoc, installing-image-puller-on-openshift-using-operatorhub.adoc [id="installing-image-puller-on-openshift-by-using-the-web-console"] = Installing {image-puller-name-short} on OpenShift by using the web console -You can install the {image-puller-operator-name} on OpenShift using the OpenShift web console. +You can install the {image-puller-operator-name} on OpenShift by using the OpenShift web console. .Prerequisites