Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add article about retrieving the list of default images for Im… #2795

Merged
merged 4 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,8 @@ on {prod-short} upgrade.
}
}
}'
----
----

.Additional resources

* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
Original file line number Diff line number Diff line change
@@ -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[]
Original file line number Diff line number Diff line change
@@ -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}

This section contains instructions for installing the {image-puller-name} for different use cases.
tolusha marked this conversation as resolved.
Show resolved Hide resolved

== 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[]
Original file line number Diff line number Diff line change
@@ -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}

This article provides instructions on retrieving 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.
tolusha marked this conversation as resolved.
Show resolved Hide resolved


.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
----
Original file line number Diff line number Diff line change
@@ -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[]

Original file line number Diff line number Diff line change
@@ -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[]

Loading