diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 43b6fdc6c1..ade8b2b88b 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -53,12 +53,15 @@ *** xref:configuring-a-user-namespace.adoc[] *** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[] ** xref:caching-images-for-faster-workspace-start.adoc[] -*** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] -*** xref:installing-image-puller-on-openshift-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-pre-pull-custom-images.adoc[] -*** xref:configuring-image-puller-to-pre-pull-additional-images.adoc[] +*** xref:installing-kubernetes-image-puller.adoc[] +**** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] +**** xref:installing-image-puller-on-openshift-using-cli.adoc[] +**** xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] +*** xref:configuring-kubernetes-image-puller.adoc[] +**** xref:configuring-image-puller-to-pre-pull-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:retrieving-default-list-of-images-for-kubernetes-image-puller.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 1e5704edc4..65e999e5ba 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 @@ -1,4 +1,4 @@ -:_content-type: REFERENCE +:_content-type: ASSEMBLY :description: Caching images for faster workspace start :keywords: administration-guide, caching-images-for-faster-workspace-start :navtitle: Caching images for faster workspace start @@ -18,17 +18,8 @@ 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-on-kubernetes-by-using-cli.adoc[] - -* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] - -* xref:installing-image-puller-on-openshift-using-cli.adoc[] - -* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[] - -* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[] - -* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[] +include::partial$snip_installing-kubernetes-image-puller.adoc[] +include::partial$snip_configuring-kubernetes-image-puller.adoc[] .Additional resources 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 f9ccc02dbf..fbbe9ecd9c 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 @@ -37,4 +37,8 @@ on {prod-short} upgrade. } } }' ----- \ No newline at end of file +---- + +.Additional resources + +* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[] diff --git a/modules/administration-guide/pages/configuring-kubernetes-image-puller.adoc b/modules/administration-guide/pages/configuring-kubernetes-image-puller.adoc new file mode 100644 index 0000000000..09937f8e12 --- /dev/null +++ b/modules/administration-guide/pages/configuring-kubernetes-image-puller.adoc @@ -0,0 +1,15 @@ +:_content-type: PROCEDURE +:description: Configuring {image-puller-name} +:keywords: overview, configuring, image-puller +:navtitle: Configuring {image-puller-name} + +[id="configuring-{image-puller-name}"] += Configuring {image-puller-name} + +This section contains instructions for configuring the {image-puller-name} for different use cases. + +== Configuring {image-puller-name} + +* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[] +* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[] +* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/installing-kubernetes-image-puller.adoc b/modules/administration-guide/pages/installing-kubernetes-image-puller.adoc new file mode 100644 index 0000000000..3465dfba4d --- /dev/null +++ b/modules/administration-guide/pages/installing-kubernetes-image-puller.adoc @@ -0,0 +1,15 @@ +:_content-type: PROCEDURE +:description: Installing {image-puller-name} +:keywords: overview, installing, image-puller +:navtitle: Installing {image-puller-name} + +[id="installing-{image-puller-name}"] += Installing {image-puller-name} + +Follow the instructions below to install the {image-puller-name} for different use cases. + +== Installing {image-puller-name} + +* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] +* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] +* xref:installing-image-puller-on-openshift-using-cli.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/retrieving-default-list-of-images-for-kubernetes-image-puller.adoc b/modules/administration-guide/pages/retrieving-default-list-of-images-for-kubernetes-image-puller.adoc new file mode 100644 index 0000000000..7aeb8ab800 --- /dev/null +++ b/modules/administration-guide/pages/retrieving-default-list-of-images-for-kubernetes-image-puller.adoc @@ -0,0 +1,32 @@ +:_content-type: PROCEDURE +:description: Retrieving the default list of images for {image-puller-name} +:keywords: administration-guide, image-puller +:navtitle: Retrieving the default list of images for {image-puller-name} + +[id="retrieving-default-list-of-images-for-kubernetes-image-puller"] += Retrieving the default list of images for {image-puller-name} + +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. + + +.Prerequisites + +* Your organization's instance of {prod-short} is installed and running on {kubernetes} cluster. + +* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}. + +.Procedure + +. Find out the namespace where the {prod-short} Operator is deployed: ++ +[source,subs="+attributes"] +---- +OPERATOR_NAMESPACE=$({orch-cli} get pods -l app.kubernetes.io/component={prod-operator} -o jsonpath={".items[0].metadata.namespace"} --all-namespaces) +---- + +. Find out the images that can be pre-pulled by the {image-puller-name-short}: ++ +[source,subs="+attributes"] +---- +{orch-cli} exec -n $OPERATOR_NAMESPACE deploy/{prod-operator} -- cat /tmp/external_images.txt +---- diff --git a/modules/administration-guide/partials/snip_configuring-kubernetes-image-puller.adoc b/modules/administration-guide/partials/snip_configuring-kubernetes-image-puller.adoc new file mode 100644 index 0000000000..04f88e3a17 --- /dev/null +++ b/modules/administration-guide/partials/snip_configuring-kubernetes-image-puller.adoc @@ -0,0 +1,8 @@ +:_content-type: SNIPPET + +.Configuring {image-puller-name} + +* xref:configuring-image-puller-to-pre-pull-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/partials/snip_installing-kubernetes-image-puller.adoc b/modules/administration-guide/partials/snip_installing-kubernetes-image-puller.adoc new file mode 100644 index 0000000000..35e66c6e4c --- /dev/null +++ b/modules/administration-guide/partials/snip_installing-kubernetes-image-puller.adoc @@ -0,0 +1,8 @@ +:_content-type: SNIPPET + +.Installing {image-puller-name} + +* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] +* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[] +* xref:installing-image-puller-on-openshift-using-cli.adoc[] +