Skip to content

Commit 0e15da4

Browse files
chore: Add article about retrieving the list of default images for Im… (#2795)
* chore: Add article about retrieving the list of default images for Image Puller Signed-off-by: Anatolii Bazko <abazko@redhat.com> * fixup Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Update modules/administration-guide/pages/installing-kubernetes-image-puller.adoc Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> * Update modules/administration-guide/pages/retrieving-default-list-of-images-for-kubernetes-image-puller.adoc Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> --------- Signed-off-by: Anatolii Bazko <abazko@redhat.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
1 parent d810024 commit 0e15da4

8 files changed

+95
-19
lines changed

modules/administration-guide/nav.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@
5353
*** xref:configuring-a-user-namespace.adoc[]
5454
*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
5555
** xref:caching-images-for-faster-workspace-start.adoc[]
56-
*** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
57-
*** xref:installing-image-puller-on-openshift-using-cli.adoc[]
58-
*** xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
59-
*** xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
60-
*** xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
61-
*** xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
56+
*** xref:installing-kubernetes-image-puller.adoc[]
57+
**** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
58+
**** xref:installing-image-puller-on-openshift-using-cli.adoc[]
59+
**** xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
60+
*** xref:configuring-kubernetes-image-puller.adoc[]
61+
**** xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
62+
**** xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
63+
**** xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
64+
*** xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
6265
** xref:configuring-observability.adoc[]
6366
**** xref:the-woopra-telemetry-plugin.adoc[]
6467
**** xref:creating-a-telemetry-plugin.adoc[]

modules/administration-guide/pages/caching-images-for-faster-workspace-start.adoc

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:_content-type: REFERENCE
1+
:_content-type: ASSEMBLY
22
:description: Caching images for faster workspace start
33
:keywords: administration-guide, caching-images-for-faster-workspace-start
44
:navtitle: Caching images for faster workspace start
@@ -18,17 +18,8 @@ configured to pre-pull relevant {prod-short} workspace images on each node.
1818
These images would already be available when a {prod-short} workspace starts,
1919
therefore improving the workspace start time.
2020

21-
* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
22-
23-
* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
24-
25-
* xref:installing-image-puller-on-openshift-using-cli.adoc[]
26-
27-
* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
28-
29-
* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
30-
31-
* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
21+
include::partial$snip_installing-kubernetes-image-puller.adoc[]
22+
include::partial$snip_configuring-kubernetes-image-puller.adoc[]
3223

3324
.Additional resources
3425

modules/administration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,8 @@ on {prod-short} upgrade.
3737
}
3838
}
3939
}'
40-
----
40+
----
41+
42+
.Additional resources
43+
44+
* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_content-type: PROCEDURE
2+
:description: Configuring {image-puller-name}
3+
:keywords: overview, configuring, image-puller
4+
:navtitle: Configuring {image-puller-name}
5+
6+
[id="configuring-{image-puller-name}"]
7+
= Configuring {image-puller-name}
8+
9+
This section contains instructions for configuring the {image-puller-name} for different use cases.
10+
11+
== Configuring {image-puller-name}
12+
13+
* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
14+
* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
15+
* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_content-type: PROCEDURE
2+
:description: Installing {image-puller-name}
3+
:keywords: overview, installing, image-puller
4+
:navtitle: Installing {image-puller-name}
5+
6+
[id="installing-{image-puller-name}"]
7+
= Installing {image-puller-name}
8+
9+
Follow the instructions below to install the {image-puller-name} for different use cases.
10+
11+
== Installing {image-puller-name}
12+
13+
* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
14+
* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
15+
* xref:installing-image-puller-on-openshift-using-cli.adoc[]
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
:_content-type: PROCEDURE
2+
:description: Retrieving the default list of images for {image-puller-name}
3+
:keywords: administration-guide, image-puller
4+
:navtitle: Retrieving the default list of images for {image-puller-name}
5+
6+
[id="retrieving-default-list-of-images-for-kubernetes-image-puller"]
7+
= Retrieving the default list of images for {image-puller-name}
8+
9+
Learn how to retrieve the default list of images used by {image-puller-name}. This can be helpful for administrators who want to review and configure {image-puller-name-short} to use only a subset of these images in advance.
10+
11+
12+
.Prerequisites
13+
14+
* Your organization's instance of {prod-short} is installed and running on {kubernetes} cluster.
15+
16+
* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}.
17+
18+
.Procedure
19+
20+
. Find out the namespace where the {prod-short} Operator is deployed:
21+
+
22+
[source,subs="+attributes"]
23+
----
24+
OPERATOR_NAMESPACE=$({orch-cli} get pods -l app.kubernetes.io/component={prod-operator} -o jsonpath={".items[0].metadata.namespace"} --all-namespaces)
25+
----
26+
27+
. Find out the images that can be pre-pulled by the {image-puller-name-short}:
28+
+
29+
[source,subs="+attributes"]
30+
----
31+
{orch-cli} exec -n $OPERATOR_NAMESPACE deploy/{prod-operator} -- cat /tmp/external_images.txt
32+
----
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:_content-type: SNIPPET
2+
3+
.Configuring {image-puller-name}
4+
5+
* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
6+
* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
7+
* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
8+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:_content-type: SNIPPET
2+
3+
.Installing {image-puller-name}
4+
5+
* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
6+
* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
7+
* xref:installing-image-puller-on-openshift-using-cli.adoc[]
8+

0 commit comments

Comments
 (0)