Simplify KIP doc (#2711)

* Simplify KIP doc Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Add pages about configuring image-puller Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Fixes Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Update modules/administration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.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>
eclipse-che · Apr 9, 2024 · da122d5 · da122d5
1 parent f49093f
commit da122d5
Show file tree

Hide file tree

Showing 11 changed files with 178 additions and 274 deletions.
diff --git a/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc b/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc
diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc
@@ -45,10 +45,11 @@
 *** xref:configuring-the-open-vsx-registry-url.adoc[]
 *** xref:configuring-a-user-namespace.adoc[]
 ** xref:caching-images-for-faster-workspace-start.adoc[]
-*** xref:defining-the-list-of-images-to-pull.adoc[]
-*** xref:defining-the-memory-parameters-for-the-image-puller.adoc[]
-*** xref:installing-image-puller-on-openshift-using-the-web-console.adoc[]
-*** xref:installing-image-puller-on-openshift-using-cli.adoc[]
+*** xref:installing-image-puller-on-kubernetes-by-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: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
@@ -8,72 +8,26 @@
 [id="caching-images-for-faster-workspace-start"]
 = Caching images for faster workspace start
 
-To improve the start time performance of {prod-short} workspaces, use the {image-puller-name-short}, a {prod-short}-agnostic component that can be used to pre-pull images for {platforms-name} clusters. The {image-puller-name-short} is an additional {platforms-name} deployment which creates a _DaemonSet_ that can be 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.
+To improve the start time performance of {prod-short} workspaces,
+use the {image-puller-name-short}, a {prod-short}-agnostic component that can be used
+to pre-pull images for {platforms-name} clusters.
 
-The {image-puller-name-short} provides the following parameters for configuration.
+The {image-puller-name-short} is an
+additional {platforms-name} deployment which creates a _DaemonSet_ that can be
+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.
 
-[id="image-puller-configuration"]
-.{image-puller-name-short} parameters
-[options="header"]
-|===
-|Parameter |Usage |Default
+* xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
 
-|`CACHING_INTERVAL_HOURS`
+* xref:installing-image-puller-on-openshift-by-using-the-web-console.adoc[]
 
-|DaemonSets health checks interval in hours
-|`"1"`
+* xref:configuring-image-puller-to-pre-pull-default-che-images.adoc[]
 
-|`CACHING_MEMORY_REQUEST`
-|The memory request for each cached image while the puller is running. See xref:defining-the-memory-parameters-for-the-image-puller.adoc[].
-|`10Mi`
-
-|`CACHING_MEMORY_LIMIT`
-|The memory limit for each cached image while the puller is running. See xref:defining-the-memory-parameters-for-the-image-puller.adoc[].
-|`20Mi`
-
-|`CACHING_CPU_REQUEST`
-|The processor request for each cached image while the puller is running
-|`.05` or 50 millicores
-
-|`CACHING_CPU_LIMIT`
-|The processor limit for each cached image while the puller is running
-|`.2` or 200 millicores
-
-|`DAEMONSET_NAME`
-|Name of DaemonSet to create
-|`{image-puller-deployment-name}`
-
-|`DEPLOYMENT_NAME`
-|Name of the Deployment to create
-|`{image-puller-deployment-name}`
-
-|`NAMESPACE`
-|{platforms-namespace} containing DaemonSet to create
-|`k8s-image-puller`
-
-|`IMAGES`
-|Semicolon-separated list of images to pull, in the format `__<name1>__=__<image1>__;__<name2>__=__<image2>__`. See xref:defining-the-list-of-images-to-pull.adoc[].
-|
-
-|`NODE_SELECTOR`
-|Node selector to apply to the pods created by the DaemonSet
-|`'{}'`
-
-| `AFFINITY`
-| Affinity applied to pods created by the DaemonSet
-| `'{}'`
-
-|`IMAGE_PULL_SECRETS`
-| List of image pull secrets, in the format `pullsecret1;...` to add to pods created by the DaemonSet. Those secrets need to be in the image puller's namespace and a cluster administrator must create them.
-| `""`
-|===
+* xref:configuring-image-puller-to-pre-pull-custom-images.adoc[]
 
+* xref:configuring-image-puller-to-pre-pull-additional-images.adoc[]
 
 .Additional resources
 
-* xref:defining-the-list-of-images-to-pull.adoc[]
-* xref:defining-the-memory-parameters-for-the-image-puller.adoc[].
-* xref:installing-image-puller-on-openshift-using-the-web-console.adoc[]
-* xref:installing-image-puller-on-openshift-using-cli.adoc[]
-
 * link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository]
diff --git a/...tration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc b/...tration-guide/pages/configuring-image-puller-to-pre-pull-additional-images.adoc
@@ -0,0 +1,50 @@
+:_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 additional {prod-short} images.
+
+.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
+
+. Create `{image-puller-namespace}` namespace:
++
+[source,shell,subs="+attributes,"]
+----
+{orch-cli} create namespace {image-puller-namespace}
+----
+
+. Create `{image-puller-cr-name}` Custom Resource:
++
+[source,shell,subs="+attributes,"]
+----
+{orch-cli} apply -f - <<EOF
+apiVersion: che.eclipse.org/v1alpha1
+kind: KubernetesImagePuller
+metadata:
+  name: k8s-image-puller-images
+  namespace: {image-puller-namespace}
+spec:
+  images: "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__" <1>
+EOF
+----
+<1> The semicolon separated list of images
+
+.Addition resources
+
+* https://github.com/che-incubator/kubernetes-image-puller[{image-puller-name} source code repository]
+
+* https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository]
+
diff --git a/...inistration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.adoc b/...inistration-guide/pages/configuring-image-puller-to-pre-pull-custom-images.adoc
@@ -0,0 +1,42 @@
+:_content-type: PROCEDURE
+:description: Configuring {image-puller-name-short} to pre-pull custom images
+:keywords: administration-guide, image-puller, CLI
+:navtitle: Configuring {image-puller-name-short} to pre-pull custom images
+:page-aliases:
+
+[id="configuring-image-puller-to-pre-pull-custom-images"]
+= Configuring {image-puller-name-short} to pre-pull custom images
+
+You can configure {image-puller-name} to pre-pull custom images.
+
+.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 custom 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
diff --git a/...ration-guide/pages/configuring-image-puller-to-pre-pull-default-che-images.adoc b/...ration-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
+                  }
+                }
+              }
+            }'
+----
diff --git a/modules/administration-guide/pages/defining-the-list-of-images-to-pull.adoc b/modules/administration-guide/pages/defining-the-list-of-images-to-pull.adoc
diff --git a/...nistration-guide/pages/defining-the-memory-parameters-for-the-image-puller.adoc b/...nistration-guide/pages/defining-the-memory-parameters-for-the-image-puller.adoc
diff --git a/...inistration-guide/pages/installing-image-puller-on-kubernetes-by-using-cli.adoc b/...inistration-guide/pages/installing-image-puller-on-kubernetes-by-using-cli.adoc
@@ -0,0 +1,24 @@
+:_content-type: PROCEDURE
+:description: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI
+:keywords: administration-guide, image-puller, operator, CLI
+:navtitle: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI
+:page-aliases: .:installing-image-puller-on-openshift-using-openshift-templates.adoc,installing-image-puller-on-openshift-using-openshift-templates.adoc
+
+[id="installing-image-puller-on-kubernetes-cluster-by-using-the-cli"]
+= Installing {image-puller-name-short} operator on {kubernetes} cluster by using CLI
+
+You can install the {image-puller-name} operator on {kubernetes} cluster by using CLI.
+
+.Prerequisites
+
+* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}.
+
+.Procedure
+
+. Visit link:https://operatorhub.io/operator/kubernetes-imagepuller-operator[{image-puller-operator-name}] page.
+
+. Click the `Install` button and follow the instruction.
+
+.Addition resources
+
+* https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository]
diff --git a/...r-on-openshift-using-the-web-console.adoc → ...n-openshift-by-using-the-web-console.adoc b/...r-on-openshift-using-the-web-console.adoc → ...n-openshift-by-using-the-web-console.adoc
@@ -1,20 +1,16 @@
 :_content-type: PROCEDURE
-:description: Installing {image-puller-name-short} on OpenShift using the web console
+:description: Installing {image-puller-name-short} on OpenShift by using the web console
 :keywords: administration-guide, image-puller, openshift, operator, operatorhub
-:navtitle: Installing {image-puller-name-short} on OpenShift using the web console
-:page-aliases: .:installing-image-puller-on-openshift-using-operatorhub.adoc, installing-image-puller-on-openshift-using-operatorhub.adoc
+:navtitle: Installing {image-puller-name-short} on OpenShift by using the web console
+:page-aliases: .:installing-image-puller-on-openshift-by-using-operatorhub.adoc, installing-image-puller-on-openshift-using-operatorhub.adoc
 
 [id="installing-image-puller-on-openshift-by-using-the-web-console"]
 = Installing {image-puller-name-short} on OpenShift by using the web console
 
-You can install the {image-puller-operator-name} on OpenShift using the OpenShift web console.
+You can install the {image-puller-operator-name} on OpenShift by using the OpenShift web console.
 
 .Prerequisites
 
-* xref:defining-the-list-of-images-to-pull.adoc[]
-
-* xref:defining-the-memory-parameters-for-the-image-puller.adoc[].
-
 * An OpenShift web console session by a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console].
 
 .Procedure