Skip to content

Commit

Permalink
Add pages about configuring image-puller
Browse files Browse the repository at this point in the history
Signed-off-by: Anatolii Bazko <[email protected]>
  • Loading branch information
tolusha committed Apr 5, 2024
1 parent f63a05c commit 5171849
Show file tree
Hide file tree
Showing 5 changed files with 131 additions and 0 deletions.
3 changes: 3 additions & 0 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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,
}
}
}
}'
----
Original file line number Diff line number Diff line change
@@ -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,
}
}
}
}'
----

0 comments on commit 5171849

Please sign in to comment.