From 51718499a5171c7fc3a6858fecaae10f0c01b617 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Fri, 5 Apr 2024 16:50:33 +0200 Subject: [PATCH] Add pages about configuring image-puller Signed-off-by: Anatolii Bazko --- modules/administration-guide/nav.adoc | 3 ++ ...ing-images-for-faster-workspace-start.adoc | 6 +++ ...puller-to-override-default-che-images.adoc | 42 +++++++++++++++++++ ...-puller-to-pre-pull-additional-images.adoc | 40 ++++++++++++++++++ ...puller-to-pre-pull-default-che-images.adoc | 40 ++++++++++++++++++ 5 files changed, 131 insertions(+) create mode 100644 modules/administration-guide/pages/configuring-image-puller-to-override-default-che-images.adoc create mode 100644 modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc create mode 100644 modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 9009767977..528678522c 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -47,6 +47,9 @@ ** 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: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-additional-images.adoc[] ** xref:configuring-observability.adoc[] **** xref:the-woopra-telemetry-plugin.adoc[] **** xref:creating-a-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 73c0ed9e25..e74c2f3fc2 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 @@ -20,6 +20,12 @@ therefore improving the workspace start time. * xref:installing-image-puller-on-openshift-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-additional-images.adoc[] + .Additional resources * link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository] 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 new file mode 100644 index 0000000000..e0c9159b39 --- /dev/null +++ b/modules/administration-guide/pages/configuring-image-puller-to-override-default-che-images.adoc @@ -0,0 +1,42 @@ +:_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 new file mode 100644 index 0000000000..71a1590b7c --- /dev/null +++ b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc @@ -0,0 +1,40 @@ +:_content-type: PROCEDURE +:description: Configuring {image-puller-name-short} to pre-pull additional images +:keywords: administration-guide, image-puller, CLI +:navtitle: Configuring {image-puller-name-short} to pre-pull additional images +:page-aliases: + +[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. + +.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,"] +---- +{orch-cli} patch checluster/{prod-checluster} \ + --namespace {prod-namespace} \ + --type='merge' \ + --patch '{ + "spec": { + "components": { + "imagePuller": { + "enable": true, + } + } + } + }' +---- \ 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 new file mode 100644 index 0000000000..ece9e69be1 --- /dev/null +++ b/modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc @@ -0,0 +1,40 @@ +:_content-type: PROCEDURE +:description: Configuring {image-puller-name-short} to pre-pull default {prod-short} images +:keywords: administration-guide, image-puller, CLI +:navtitle: Configuring {image-puller-name-short} to pre-pull default {prod-short} images +:page-aliases: + +[id="configuring-image-puller-to-pre-pull-default-che-images"] += Configuring {image-puller-name-short} to pre-pull default {prod-short} images + +You can configure {image-puller-name} to pre-pull default {prod-short} images. +{prod} operator will control the list of images to pre-pull and automatically updates them +on {prod-short} upgrade. + +.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,"] +---- +{orch-cli} patch checluster/{prod-checluster} \ + --namespace {prod-namespace} \ + --type='merge' \ + --patch '{ + "spec": { + "components": { + "imagePuller": { + "enable": true, + } + } + } + }' +---- \ No newline at end of file