Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
17 changes: 9 additions & 8 deletions modules/optimize/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
.Optimize performance
* xref:what-you-can-optimize.adoc[]
* xref:caching-images-for-faster-workspace-start.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:how-image-caching-speeds-up-workspace-starts.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:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
* xref:configuring-autoscaling.adoc[]
** xref:configuring-number-of-replicas.adoc[]
** xref:configuring-machine-autoscaling.adoc[]
* xref:verify-optimization-impact.adoc[]
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
:_content-type: ASSEMBLY
:description: Caching images for faster workspace start
:description: Speed up workspace starts with image caching
:keywords: administration-guide, caching-images-for-faster-workspace-start
:navtitle: Caching images for faster workspace start
:navtitle: Speed up workspace starts with image caching
:page-aliases: administration-guide:caching-images-for-faster-workspace-start.adoc, .:caching-images-for-faster-workspace-start.adoc


[id="caching-images-for-faster-workspace-start"]
= Caching images for faster workspace start
= Speed up workspace starts with image caching

To improve the start time performance of {prod-short} workspaces,
use the {image-puller-name-short}, a community-supported {prod-short}-agnostic component that can be used
to pre-pull images for {platforms-name} clusters.
Speed up workspace starts by deploying the {image-puller-name} to pre-cache container images on cluster nodes so that workspaces start in seconds instead of minutes.

include::partial$snip_persona-admin.adoc[]

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.

include::partial$snip_installing-kubernetes-image-puller.adoc[]
include::partial$snip_configuring-kubernetes-image-puller.adoc[]
For an explanation of how image caching works and for deploy and configure procedures, see Additional resources.

[role="_additional-resources"]
.Additional resources

* xref:how-image-caching-speeds-up-workspace-starts.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:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
* link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository]
13 changes: 8 additions & 5 deletions modules/optimize/pages/configuring-autoscaling.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
:_content-type: ASSEMBLY
:description: Configuring autoscaling
:description: Scale the platform automatically
:keywords: administration-guide, configuring, autoscaling, autoscale, horizontal, scaling, machine
:navtitle: Configuring autoscaling
:navtitle: Scale the platform automatically
:page-aliases: administration-guide:configuring-autoscaling.adoc

[id="configuring-autoscaling"]
= Configuring autoscaling
= Scale the platform automatically

Learn about different aspects of autoscaling for {prod}.
Scale {prod-short} container replicas and cluster nodes automatically so that the platform grows and shrinks with developer demand.

include::partial$snip_persona-admin.adoc[]
For instructions on scaling replicas and preventing workspace failures during node scaling, see Additional resources.

[role="_additional-resources"]
.Additional resources

* xref:configuring-number-of-replicas.adoc[]
* xref:configuring-machine-autoscaling.adoc[]
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Configuring {image-puller-name-short} to pre-pull additional images
:description: Cache additional images for faster starts
:keywords: administration-guide, image-puller, CLI
:navtitle: Configuring {image-puller-name-short} to pre-pull additional images
:navtitle: Cache additional images for faster starts
:page-aliases: administration-guide:configuring-image-puller-to-pre-pull-additional-images.adoc

[id="configuring-image-puller-to-pre-pull-additional-images"]
= Configuring {image-puller-name-short} to pre-pull additional images
= Cache additional images for faster starts

You can configure {image-puller-name} to pre-pull additional {prod-short} images.

include::partial$snip_persona-admin.adoc[]
Cache additional images with {image-puller-name} to reduce workspace startup time by ensuring that required images are already cached on each node.

.Prerequisites

Expand Down Expand Up @@ -39,12 +37,24 @@ metadata:
name: k8s-image-puller-images
namespace: {image-puller-namespace}
spec:
images: "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__" <1>
images: "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__"
EOF
----
<1> The semicolon separated list of images
+
where:
+
`images`:: The semicolon-separated list of images in `name=image` format.

.Verification

* Verify that the image puller `DaemonSet` is running in the `{image-puller-namespace}` namespace:
+
[source,shell,subs="+attributes"]
----
{orch-cli} get daemonset -n {image-puller-namespace}
----

.Addition resources
.Additional resources

* https://github.com/che-incubator/kubernetes-image-puller[{image-puller-name} source code repository]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Configuring {image-puller-name-short} to pre-pull custom images
:description: Cache your organization's custom images
:keywords: administration-guide, image-puller, CLI
:navtitle: Configuring {image-puller-name-short} to pre-pull custom images
:navtitle: Cache your organization's custom images
:page-aliases: administration-guide:configuring-image-puller-to-pre-pull-custom-images.adoc

[id="configuring-image-puller-to-pre-pull-custom-images"]
= Configuring {image-puller-name-short} to pre-pull custom images
= Cache your organization's custom images

You can configure {image-puller-name} to pre-pull custom images.

include::partial$snip_persona-admin.adoc[]
Cache your organization's custom images with {image-puller-name} so that workspaces using organization-specific container images start without waiting for large image downloads.

.Prerequisites

Expand All @@ -34,11 +32,23 @@ include::partial$snip_persona-admin.adoc[]
"imagePuller": {
"enable": true,
"spec": {
"images": "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__" <1>
"images": "__NAME-1__=__IMAGE-1__;__NAME-2__=__IMAGE-2__"
}
}
}
}
}'
----
<1> The semicolon separated list of images
+
where:
+
`images`:: The semicolon-separated list of images in `name=image` format.

.Verification

* Verify that the image puller is configured with the custom images:
+
[source,shell,subs="+attributes"]
----
{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.spec.components.imagePuller.spec.images}'
----
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
:_content-type: PROCEDURE
:description: Configuring {image-puller-name-short} to pre-pull default {prod-short} images
:description: Cache default {prod-short} images on all nodes
:keywords: administration-guide, image-puller, CLI
:navtitle: Configuring {image-puller-name-short} to pre-pull default {prod-short} images
:navtitle: Cache default {prod-short} images on all nodes
:page-aliases: administration-guide:configuring-image-puller-to-pre-pull-default-che-images.adoc

[id="configuring-image-puller-to-pre-pull-default-che-images"]
= Configuring {image-puller-name-short} to pre-pull default {prod-short} images
= Cache default {prod-short} images on all nodes

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
Cache default {prod-short} images on all nodes by enabling {image-puller-name}.
The {prod} Operator controls the list of images to pre-pull and automatically updates them
on {prod-short} upgrade.

include::partial$snip_persona-admin.adoc[]

.Prerequisites

* Your organization's instance of {prod-short} is installed and running on {kubernetes} cluster.
Expand Down Expand Up @@ -41,6 +39,15 @@ include::partial$snip_persona-admin.adoc[]
}'
----

.Verification

* Verify that the image puller is enabled:
+
[source,shell,subs="+attributes"]
----
{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.spec.components.imagePuller.enable}'
----

.Additional resources

* xref:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
17 changes: 0 additions & 17 deletions modules/optimize/pages/configuring-kubernetes-image-puller.adoc

This file was deleted.

10 changes: 4 additions & 6 deletions modules/optimize/pages/configuring-machine-autoscaling.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Configuring machine autoscaling
:description: Prevent workspace failures during node scaling
:keywords: administration guide, machine, autoscaling, scaling
:navtitle: Configuring machine autoscaling
:navtitle: Prevent workspace failures during node scaling
:page-aliases: administration-guide:configuring-machine-autoscaling.adoc

[id="configuring-machine-autoscaling"]
= Configuring machine autoscaling
= Prevent workspace failures during node scaling

If you configured the cluster to adjust the number of nodes depending on resource needs, you need additional configuration to maintain the uninterrupted operation of {prod-short} workspaces.

include::partial$snip_persona-admin.adoc[]
Prevent workspace failures during node scaling by configuring {prod-short} startup timeouts and pod annotations to work with the cluster autoscaler.

Workspaces need special consideration when the autoscaler adds and removes nodes.

Expand Down
4 changes: 2 additions & 2 deletions modules/optimize/pages/configuring-number-of-replicas.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_content-type: ASSEMBLY
:description: Configuring number of replicas for a {prod} container
:description: Scale {prod-short} for high availability
:keywords: administration guide, configuring-number-of-replicas
:navtitle: Configuring number of replicas for a {prod} container
:navtitle: Scale {prod-short} for high availability
:page-aliases: administration-guide:configuring-number-of-replicas.adoc

include::partial$proc_configuring-number-of-replicas.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:_content-type: CONCEPT
:description: How image caching speeds up workspace starts
:navtitle: How image caching speeds up workspace starts

[id="how-image-caching-speeds-up-workspace-starts"]
= How image caching speeds up workspace starts

To improve workspace start time, use the {image-puller-name-short}, a community-supported {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.

For instructions on deploying, configuring, and reviewing cached images, see Additional resources.

[role="_additional-resources"]
.Additional resources

* 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:retrieving-default-list-of-images-for-kubernetes-image-puller.adoc[]
* 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
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI
:description: Deploy {image-puller-name-short} on a {kubernetes} cluster
:keywords: administration-guide, image-puller, operator, CLI
:navtitle: Installing the {image-puller-name} operator on {kubernetes} cluster by using CLI
:navtitle: Deploy {image-puller-name-short} on a {kubernetes} cluster
:page-aliases: administration-guide:installing-image-puller-on-kubernetes-by-using-cli.adoc, .: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
= Deploy {image-puller-name-short} on a {kubernetes} cluster

You can install the {image-puller-name} operator on {kubernetes} cluster by using CLI.

include::partial$snip_persona-admin.adoc[]
Deploy the {image-puller-name} operator on a {kubernetes} cluster by using CLI.

.Prerequisites

Expand All @@ -21,6 +19,6 @@ include::partial$snip_persona-admin.adoc[]

. Click the `Install` button and follow the instruction.

.Addition resources
.Additional resources

* https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository]
* link:https://github.com/che-incubator/kubernetes-image-puller-operator[{image-puller-operator-name} source code repository]
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Installing {image-puller-name-short} on OpenShift by using the web console
:description: Deploy {image-puller-name-short} from the web console
:keywords: administration-guide, image-puller, openshift, operator, operatorhub
:navtitle: Installing {image-puller-name-short} on OpenShift by using the web console
:navtitle: Deploy {image-puller-name-short} from the web console
:page-aliases: administration-guide:installing-image-puller-on-openshift-by-using-the-web-console.adoc, .: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
= Deploy {image-puller-name-short} from the web console

You can install the {image-puller-operator-name} on OpenShift by using the OpenShift web console.

include::partial$snip_persona-admin.adoc[]
Deploy the {image-puller-operator-name} on OpenShift by using the OpenShift web console.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
:_content-type: PROCEDURE
:description: Installing {image-puller-name-short} on OpenShift using CLI
:description: Deploy {image-puller-name-short} from the command line
:keywords: administration-guide, image-puller, openshift, openshift-templates, CLI
:navtitle: Installing {image-puller-name-short} on OpenShift using CLI
:navtitle: Deploy {image-puller-name-short} from the command line
// :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-openshift-using-the-cli"]
= Installing {image-puller-name-short} on OpenShift by using the CLI
= Deploy {image-puller-name-short} from the command line

You can install the {image-puller-name} on OpenShift by using OpenShift `oc` management tool.

include::partial$snip_persona-admin.adoc[]
Deploy the {image-puller-name} on OpenShift by using the OpenShift `oc` management tool.

[IMPORTANT]
====
Expand Down
17 changes: 0 additions & 17 deletions modules/optimize/pages/installing-kubernetes-image-puller.adoc

This file was deleted.

Loading
Loading