From 7aa7ec1351ea8713abe017a188c26d3bd68b60f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:39 +0200 Subject: [PATCH 01/30] New attributes --- antora-playbook.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/antora-playbook.yml b/antora-playbook.yml index 6f0ad5cf7f..74fafe2a12 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -55,8 +55,10 @@ asciidoc: image-puller-images: "java11-maven=quay.io/eclipse/che-java11-maven:nightly;che-theia=quay.io/eclipse/che-theia:next;java-plugin-runner=eclipse/che-remote-plugin-runner-java8:latest;" image-puller-operator-name: Kubernetes Image Puller Operator image-puller-operator-id: kubernetes-image-puller-operator + image-puller-operator-repository-name: kubernetes-image-puller-operator image-puller-name: Kubernetes Image Puller image-puller-name-short: Image Puller + image-puller-repository-name: kubernetes-image-puller image-puller-serviceaccount-name: k8s-image-puller kubernetes: Kubernetes link-accessing-a-git-repository-via-https: xref:end-user-guide:version-control.adoc#accessing-a-git-repository-via-https_che[Accessing a Git repository using HTTPS] From e288a41490aeb136cb3beacfe842f6990f8a8fd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:46:21 +0200 Subject: [PATCH 02/30] Vale config --- .vale/styles/Vocab/Che/accept.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 3624e07efd..b7f4d4d003 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -37,7 +37,7 @@ GitHub|github GitLab Gluster Gradle -Grafana +[Gg]rafana GUI HTTPS|https heatmap @@ -49,7 +49,7 @@ item Java [Jj]etbrains jvm|JVM -helm +[Hh]elm hostname kbd Keycloak|keycloak @@ -66,7 +66,7 @@ millicores [Mm]inishift [Mm]ixin [Mm]ixins -multiuser +[Mm]ultiuser MySQL namespace namespaces From 0dfb4e17dbdd93a0d78cdba42eb5c21bf764c999 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:10 +0200 Subject: [PATCH 03/30] Vale config, new attributes --- .vale/styles/Vocab/Che/accept.txt | 9 +++++++-- .vale/styles/Vocab/Che/reject.txt | 4 ---- antora-playbook.yml | 8 +++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index b7f4d4d003..0c0d604baa 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -1,5 +1,6 @@ .NET adoc +[Aa]nsible Antora API AsciiDoc @@ -24,6 +25,7 @@ DaemonSet Developer Perspective [Dd]evfile [Dd]evfiles +Dev Workspace DNS Docker Dockerfile @@ -56,6 +58,7 @@ Keycloak|keycloak Kubernetes Kubespray Java Lombok +Let's Encrypt loopback Mattermost [Mm]aven @@ -68,9 +71,10 @@ millicores [Mm]ixins [Mm]ultiuser MySQL -namespace -namespaces +[Nn]amespace +[Nn]amespaces [Nn]etcoredebug[Oo]utput +[Nn]ginx Node.js npm NuGet @@ -90,6 +94,7 @@ Pods PostgreSQL preconfigured Quarkus +readonly runtime runtimes rollout diff --git a/.vale/styles/Vocab/Che/reject.txt b/.vale/styles/Vocab/Che/reject.txt index ddf8177e22..cf96be889f 100644 --- a/.vale/styles/Vocab/Che/reject.txt +++ b/.vale/styles/Vocab/Che/reject.txt @@ -1,14 +1,10 @@ admin almost clicking -e.g. -etc. grab -i.e. info [Kk]8[Ss] Kube -let's look up maybe mostly diff --git a/antora-playbook.yml b/antora-playbook.yml index 74fafe2a12..838de0a3b1 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -42,6 +42,7 @@ asciidoc: che-devfile-registry-directory: che-devfile-registry che-plugin-registry-container-image: quay.io/eclipse/che-plugin-registry che-plugin-registry-directory: che-plugin-registry + devworkspace: Dev Workspace identity-provider-docs-url: https://www.keycloak.org/docs/ identity-provider-image-url: quay.io/eclipse/che-keycloak identity-provider-url: https://www.keycloak.org/ @@ -83,13 +84,14 @@ asciidoc: ocp4-ver: 4.6 orch-cli: kubectl orch-cli-link: link:https://kubernetes.io/docs/reference/kubectl/overview/[Overview of kubectl] + orch-ingress: Kubernetes Ingress + orch-name: Kubernetes + orch-namespace: namespace # In context: orch-name orch-namespace + osd: OpenShift Dedicated platforms-cli: "`kubectl` or `oc`" platforms-ingress: Kubernetes Ingress or OpenShift Route platforms-name: Kubernetes or OpenShift platforms-namespace: Kubernetes namespace or OpenShift project - orch-name: Kubernetes - orch-namespace: namespace # In context: orch-name orch-namespace - osd: OpenShift Dedicated postgresql-image-url: quay.io/eclipse/che-postgres prod-checluster: eclipse-che prod-cli: chectl From e61e5d5b817164ec17810e763c9ce529b7dd34dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:42 +0200 Subject: [PATCH 04/30] Fix language on modules/installation-guide/pages/configuring-labels-for-ingresses.adoc --- .../pages/configuring-labels-for-ingresses.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/installation-guide/pages/configuring-labels-for-ingresses.adoc b/modules/installation-guide/pages/configuring-labels-for-ingresses.adoc index 26339045cf..d167a94b16 100644 --- a/modules/installation-guide/pages/configuring-labels-for-ingresses.adoc +++ b/modules/installation-guide/pages/configuring-labels-for-ingresses.adoc @@ -1,6 +1,5 @@ [id="configuring-labels-for-ingresses"] -// = Configuring Labels -:navtitle: Configuring labels for Kubernetes Ingress +:navtitle: Configuring labels for {orch-ingress} :keywords: installation-guide, configuring-labels :page-aliases: .:configuring-labels-for-ingresses From 482b9248dbaec70e602e151ec33d12ebcfe3ebc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:42 +0200 Subject: [PATCH 05/30] Fix language on modules/installation-guide/partials/con_security-considerations.adoc --- .../partials/con_security-considerations.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/con_security-considerations.adoc b/modules/installation-guide/partials/con_security-considerations.adoc index 395b9263ca..7762348955 100644 --- a/modules/installation-guide/partials/con_security-considerations.adoc +++ b/modules/installation-guide/partials/con_security-considerations.adoc @@ -24,7 +24,7 @@ The JWT proxy accepts the workspace access token from the following places in th == Secured plug-ins and editors -{prod-short} users do not need to secure workspace plug-ins and workspace editors (such as Che-Theia). This is because the JWT proxy authentication is transparent to the user and is governed by the plug-in or editor definition in their `meta.yaml` descriptors. +{prod-short} users do not need to secure workspace plug-ins and workspace editors (such as Che-Theia). This is because the JWT proxy authentication is indiscernible to the user and is governed by the plug-in or editor definition in their `meta.yaml` descriptors. == Secured container-image components From 2b1acf351e00c4db7c62b2f8c932a5c8f2b8492d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:42 +0200 Subject: [PATCH 06/30] Fix language on modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc --- ...ng-che-server-advanced-configuration-using-the-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc b/modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc index 817f74700d..357b6245c8 100644 --- a/modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc +++ b/modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc @@ -36,7 +36,7 @@ spec: [NOTE] ==== -Previous versions of the {prod-short} Operator had a configMap named `custom` to fulfill this role. If the {prod-short} Operator finds a `configMap` with the name `custom`, it adds the data it contains into the `customCheProperties` field, redeploys {prod-short}, and deletes the `custom` `configMap`. +Previous versions of the {prod-short} Operator had a ConfigMap named `custom` to fulfill this role. If the {prod-short} Operator finds a `configMap` with the name `custom`, it adds the data it contains into the `customCheProperties` field, redeploys {prod-short}, and deletes the `custom` `configMap`. ==== .Additional resources From ed617cf53cae46ebc5ad4ea30153146664efaacd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 07/30] Fix language on modules/installation-guide/partials/con_workspace-exposure-strategies.adoc --- .../partials/con_workspace-exposure-strategies.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/con_workspace-exposure-strategies.adoc b/modules/installation-guide/partials/con_workspace-exposure-strategies.adoc index 74c4c32c8d..243b88acab 100644 --- a/modules/installation-guide/partials/con_workspace-exposure-strategies.adoc +++ b/modules/installation-guide/partials/con_workspace-exposure-strategies.adoc @@ -42,7 +42,7 @@ Single-host strategy have two subtypes with different implementation methods. Fi With `gateway` single-host strategy, cluster network policies has to be configured so that workspace's services are reachable from reverse-proxy Pod (typically in {prod-short} {orch-namespace}). These typically lives in different {orch-namespace}. ==== -There are two ways of exposing the endpoints specified in the devfile. These can be configured using the `++CHE_INFRA_KUBERNETES_SINGLEHOST_WORKSPACE_DEVFILE__ENDPOINT__EXPOSURE++` environment variable of the {prod-short}. This environment variable is only effective with the single-host server strategy and is applicable to all workspaces of all users. +To define how to expose the endpoints specified in the devfile, define the `++CHE_INFRA_KUBERNETES_SINGLEHOST_WORKSPACE_DEVFILE__ENDPOINT__EXPOSURE++` environment variable in the {prod-short} instance. This environment variable is only effective with the single-host server strategy and is applicable to all workspaces of all users. === devfile endpoints: `single-host` From 42221d1b28eb7d01bf5be1d2cd8e5873a06f9e7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 08/30] Fix language on modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc --- .../proc_configuring-dns-on-azure.adoc | 20 ++++++++----------- 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc b/modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc index 7ff448cd22..7e4b8af6e5 100644 --- a/modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc +++ b/modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc @@ -1,7 +1,3 @@ -// Module included in the following assemblies: -// -// installing-{prod-id-short}-on-microsoft-azure - [id="configuring-DNS-on-azure_{context}"] = Configuring DNS on Azure @@ -11,27 +7,27 @@ To configure DNS on Azure: . In the Azure web console, navigate to *Home* -> *DNS zones*. + -image::installation/dns-zone-in-microsoft-azure.png[link="../_images/installation/dns-zone-in-microsoft-azure.png"] +image::installation/dns-zone-in-microsoft-azure.png[DNS zone in Microsoft Azure,link="../_images/installation/dns-zone-in-microsoft-azure.png"] . Create a new zone. + .. In the *Resource group* drop-down list, click *eclipseCheResourceGroup*. + -image::installation/selecting-the-resource-group.png[link="../_images/installation/selecting-the-resource-group.png"] +image::installation/selecting-the-resource-group.png[Selecting the resource group,link="../_images/installation/selecting-the-resource-group.png"] -.. In the *Instance details* section, in the *Name* field, type the name of the domain (*azr.my-ide.cloud*, in this case). +.. In the *Instance details* section, in the *Name* field, type the name of the domain (`azr.my-ide.cloud`, in this case). .. Click the btn:[Review + create] button. + -image::installation/entering-the-name-fo-the-domain.png[link="../_images/installation/entering-the-name-fo-the-domain.png"] +image::installation/entering-the-name-fo-the-domain.png[Entering the name for the domain,link="../_images/installation/entering-the-name-fo-the-domain.png"] . Click the btn:[Create] button. + -image::installation/completing-the-creation-of-the-zone.png[link="../_images/installation/completing-the-creation-of-the-zone.png"] +image::installation/completing-the-creation-of-the-zone.png[Completing the creation of the zone,link="../_images/installation/completing-the-creation-of-the-zone.png"] + The created zone and the list of name servers (NS) are displayed in the *DNS Zones* section. + -image::installation/list-of-created-zones-and-NS.png[link="../_images/installation/list-of-created-zones-and-NS.png"] +image::installation/list-of-created-zones-and-NS.png[List of created zones and name servers,link="../_images/installation/list-of-created-zones-and-NS.png"] + These servers must be configured with the registrar of the domain. @@ -43,8 +39,8 @@ These servers must be configured with the registrar of the domain. .. In the *IP Address* field, select the external IP of Ingress-nginx controller that the user had obtained in the xref:installing-ingress-on-kubernetes_{context}[] section (*40.89.129.194*, in this case). + -image::installation/adding-a-record-set.png[link="../_images/installation/adding-a-record-set.png"] +image::installation/adding-a-record-set.png[Adding a record set,link="../_images/installation/adding-a-record-set.png"] + The following is an example of an added DNS zone: + -image::installation/example-of-an-added-dns-zone.png[link="../_images/installation/example-of-an-added-dns-zone.png"] +image::installation/example-of-an-added-dns-zone.png[Example of an added DNS zone,link="../_images/installation/example-of-an-added-dns-zone.png"] From 594ed43f7fbbaef7183fc7dbc531e31659356987 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 09/30] Fix language on modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc --- .../partials/proc_configuring-labels-for-ingresses.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc b/modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc index 1a06da8df5..55a1c79040 100644 --- a/modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc +++ b/modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc @@ -1,8 +1,8 @@ [id="configuring-labels-for-ingresses_{context}"] -= Configuring labels for Kubernetes Ingress += Configuring labels for {orch-ingress} -This procedure describes how to configure labels for Kubernetes Ingress to organize and categorize (scope and select) objects. +This procedure describes how to configure labels for {orch-ingress} to organize and categorize (scope and select) objects. .Prerequisites @@ -13,7 +13,7 @@ IMPORTANT: Use comma to separate labels: `key1=value1,key2=value2` .Procedure -. To configure labels for Kubernetes Ingress update the Custom Resource with the following commands: +. To configure labels for {orch-ingress}, update the Custom Resource with the following commands: + [subs="+quotes,+attributes"] ---- From 401f44cb02369a15e9de8bf143963fbc28e54233 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 10/30] Fix language on modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc --- .../partials/proc_configuring-namespace-strategies.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc index f3dc4dda4e..436fcd81af 100644 --- a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc +++ b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc @@ -192,7 +192,7 @@ To configure the labels, set the `CHE_INFRA_KUBERNETES_NAMESPACE_LABELS` to desi [WARNING] ==== -We do not recommend to create multiple namespaces for single user. It may lead to undefined behavior. +Avoid creating multiple namespaces for single user. It may lead to undefined behavior. ==== [IMPORTANT] From 1d781840841d2a215748746a1e92eecc6d2abbd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 11/30] Fix language on modules/installation-guide/partials/proc_configuring-storage-types.adoc --- .../partials/proc_configuring-storage-types.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_configuring-storage-types.adoc b/modules/installation-guide/partials/proc_configuring-storage-types.adoc index ef96a8a19c..34ad072a69 100644 --- a/modules/installation-guide/partials/proc_configuring-storage-types.adoc +++ b/modules/installation-guide/partials/proc_configuring-storage-types.adoc @@ -47,7 +47,7 @@ attributes: |=== |Command |Ephemeral -|Persitent +|Persistent |Clone {prod} |0 m 19 s From f5c6b47360aadd4b0a7a115d91affe3c83cc01b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 12/30] Fix language on modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc --- ...g-the-che-operator-checluster-resource-with-kubectl.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc b/modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc index 3fc8becf81..11c62061cc 100644 --- a/modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc @@ -2,12 +2,12 @@ [id="configuring-the-che-operator-checluster-resource-with-kubectl_{context}"] -= Configuring CheCluster Custom Resource with kubectl -Edit the CheCluster custom resource configuration with kubectl: += Configuring CheCluster Custom Resource with {orch-cli} +Edit the CheCluster custom resource configuration with {orch-cli}: [subs="+attributes"] ---- -kubectl edit CheCluster/eclipse-che -n {prod-namespace} +{orch-cli} edit CheCluster/eclipse-che -n {prod-namespace} ---- For more details on configuring CheCluster custom resource, see xref:installation-guide:configuring-the-che-installation.adoc[] From ec2d783d4dfe8e3211881084a7618c420b290e8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 13/30] Fix language on modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc --- .../proc_creating-a-google-kubernetes-engine-instance.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc b/modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc index 7dfa4e4fc1..0c412d8e08 100644 --- a/modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc +++ b/modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc @@ -32,7 +32,7 @@ $ gcloud init $ gcloud projects create eclipse-che-1 ---- -. Check from GCP webconsole that the {kubernetes} engine is available on this project. +. Check from GCP Web Console that the {kubernetes} engine is available on this project. . Configure the different default options (such as using the `europe-west1-b` zone) in the shell: + From 3b347641995be52de6da20bb38938f99f53b0970 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 14/30] Fix language on modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc --- ...port-for-git-repositories-with-self-signed-certificates.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc b/modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc index 7942a615e8..908d36e15d 100644 --- a/modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc +++ b/modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc @@ -20,7 +20,7 @@ ifeval::["{project-context}" == "che"] In the instructions below, substitute `kubectl` for `oc` when running {prod-short} on {kubernetes}. endif::[] -. Create a new *configMap* with details about the Git server: +. Create a new *ConfigMap* with details about the Git server: + [subs="+quotes"] ---- From 31b869652e7dc426d0ae2505467ec1a3772ee6a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 15/30] Fix language on modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc --- .../partials/proc_enabling-dev-workspace-engine.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc b/modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc index e5514832aa..fa41bc2ecf 100644 --- a/modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc +++ b/modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc @@ -1,8 +1,8 @@ [id="enabling-dev-workspace-engine_{context}"] -= Enabling Dev Workspace engine += Enabling {devworkspace} engine -This procedure describes how to enable the Dev Workspace engine to support the Devfile 2.0.0 file format and mentions how to do so on existing instances or those about to be installed. +This procedure describes how to enable the {devworkspace} engine to support the Devfile 2.0.0 file format and mentions how to do so on existing instances or those about to be installed. .Prerequisites From 6cd27a2f977916e002c3691278c65453ae7f278e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 16/30] Fix language on modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc --- .../proc_importing-untrusted-tls-certificates-old.adoc | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc b/modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc index 521c7ef830..1a45ecb51c 100644 --- a/modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc +++ b/modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc @@ -3,15 +3,7 @@ = Importing untrusted TLS certificates to {prod-short} ==== -NOTE: Starting from {prod-short} version -ifeval::["{project-context}" == "che"] -v7.23.0 -endif::[] -ifeval::["{project-context}" != "che"] -2.5.1 -endif::[] -there is xref:importing-untrusted-tls-certificates.adoc[newer way] to apply additional TLS certificates. -This method is kept for backward compatibility. +NOTE: This obsolete method is kept for backward compatibility . See xref:importing-untrusted-tls-certificates.adoc[] ==== Internal communications between {prod-short} components are, by default, encrypted with TLS. Communications of {prod-short} components with external services such as proxies, source code repositories, identity providers may require TLS tool. Those communications require the use of TLS certificates signed by trusted Certificate Authorities. From 264c654d56ab680f4fde7c3b75dc07345cc25b52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 17/30] Fix language on modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc --- .../proc_installing-dns-on-google-cloud-platform.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc b/modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc index 4629193c79..1fa842200c 100644 --- a/modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc +++ b/modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc @@ -9,17 +9,17 @@ . Using the Cloud DNS, create a zone called *eclipse-che* and, for example, a DNS name *gcp.my-ide.cloud*. Click the btn:[Create] button. + -image::installation/creating-dns-zone-on-gcp.png[link="../_images/installation/creating-dns-zone-on-gcp.png"] +image::installation/creating-dns-zone-on-gcp.png[Creating DNS zone on Google Cloud Platform,link="../_images/installation/creating-dns-zone-on-gcp.png"] + The Cloud DNS zone is created. + -image::installation/cloud-dns-zone-on-gcp.png[link="../_images/installation/cloud-dns-zone-on-gcp.png"] +image::installation/cloud-dns-zone-on-gcp.png[Cloud DNS zone on Google Cloud Platform,link="../_images/installation/cloud-dns-zone-on-gcp.png"] . Click the *Registrar Setup* link in the upper right corner of the window. The name servers (NS) to be added to the registrar are displayed. + -image::installation/registrar-setup-gcp.png[link="../_images/installation/registrar-setup-gcp.png"] +image::installation/registrar-setup-gcp.png[Registrar setup on Google Cloud Platform,link="../_images/installation/registrar-setup-gcp.png"] . Update the DNS zone (example: `ovh` domain). . Add the `*.gcp.my-ide.cloud` entry to the external Ingress IP on the cloud DNS. + -image::installation/dns-settings-gcp.png[link="../_images/installation/dns-settings-gcp.png"] +image::installation/dns-settings-gcp.png[DNS settings on Google Cloud Platform,link="../_images/installation/dns-settings-gcp.png"] From 2b68ea6e102bf6bc0c6c2cd8ae5b53a5e194ce17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 18/30] Fix language on modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc --- ...oc_preparing-the-aws-system-for-installing-che.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc b/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc index 346b44c336..687cd2ac9c 100644 --- a/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc +++ b/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc @@ -180,7 +180,7 @@ Run the following command to create the role: $ aws iam create-service-linked-role --aws-service-name "elasticloadbalancing.amazonaws.com" ---- -. Add hosts on route 53 with this given host name ++https://console.aws.amazon.com/route53/home?region=eu-west-1#hosted-zones:++. Ensure that you include the colon (`:`) at the end of this URL. +. Add hosts on route 53 with this given host name `https://console.aws.amazon.com/route53/home?region=eu-west-1#hosted-zones:`. Ensure that you include the colon (`:`) at the end of this URL. . Create the wildcard DNS `*` (for `*.aws-my-ide.cloud`) with the previous host name and ensure to add the dot (`.`) at the end of the host name. In the *Type* drop-down list, select *CNAME*. + image::installation/create-record-set.png[link="../_images/installation/create-record-set.png"] @@ -258,16 +258,16 @@ $ aws route53 list-hosted-zones . In the *EC2 Dashboard*, identify the *IAM role* used by the master node. + -image::installation/aws-lauch-instance.png[link="../_images/installation/aws-lauch-instance.png"] +image::installation/aws-lauch-instance.png[AWS launch instance,link="../_images/installation/aws-lauch-instance.png"] + It is located under the *Description* tab, in the *IAM role* field. + -image::installation/describtion-tab-iam-role.png[link="../_images/installation/describtion-tab-iam-role.png"] +image::installation/describtion-tab-iam-role.png[Description tab IAM role,link="../_images/installation/describtion-tab-iam-role.png"] . Click the *IAM role* link (`masters.eu.aws.my-ide.cloud`, in this case). . Click the *Add inline policy* link at the bottom of the window. + -image::installation/aws-summary-iam-role.png[link="../_images/installation/aws-summary-iam-role.png"] +image::installation/aws-summary-iam-role.png[AWS summary IAM role,link="../_images/installation/aws-summary-iam-role.png"] . In the *Create policy* window, on the *JSON* tab, paste the content of the JSON file created earlier and click the *Review policy* button. + @@ -443,7 +443,7 @@ EOF . Check if the `issuerRef` name is the same as the `ClusterIssuer`. A new DNS challenge is being added to the DNS zone for _Let’s encrypt_. + -image::installation/aws-hosted-zones-dns.png[link="../_images/installation/aws-hosted-zones-dns.png"] +image::installation/aws-hosted-zones-dns.png[AWS hosted zones DNS,link="../_images/installation/aws-hosted-zones-dns.png"] + The cert-manager logs contain information about the DNS challenge. From 6b973d13061f2e3d8b9b4435234fc450f9f796a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 19/30] Fix language on modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc --- ...sername-readonly-theme-for-the-eclipse-che-login-page.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc b/modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc index 087e96ad66..855013d69e 100644 --- a/modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc +++ b/modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc @@ -16,7 +16,7 @@ When a user with pre-created namespaces logs in to {prod} Dashboard for the firs include::partial$proc_logging-in-to-identity-provider.adoc[leveloffset=+1] -== Setting up the {identity-provider} {prod-id-short}-username-readonly theme +== Setting up the {identity-provider} `{prod-id-short}-username-readonly` theme .Prerequisites @@ -28,7 +28,7 @@ include::partial$proc_logging-in-to-identity-provider.adoc[leveloffset=+1] After changing a username, set the *Login Theme* option to `readonly`. . In the main *Configure* menu on the left, select *Realm Settings*: - ++ image::keycloak/{project-context}-keycloak-username-readonly-theme.png[link="../_images/keycloak/{project-context}-keycloak-username-readonly-theme.png"] . Navigate to the *Themes* tab. From 1f54384a547e9ed4d13f29a1b92c74c0d8c2fc9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 20/30] Fix language on modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc --- ...ogle-cloud-node-pools-for-your-eclipse-che-workspaces.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc b/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc index 9567cc15a6..99cfb0cc37 100644 --- a/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc +++ b/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc @@ -11,8 +11,8 @@ One solution is to create a new node pool and delete the existing one afterwards Another solution is to have two node pools with one dedicated to the workspaces by configuring {prod} with a NodeSelector. See xref:configuring-workspaces-nodeselector.adoc[]. -image::installation/gcp-new-nodepool.png[link="../_images/installation/gcp-new-nodepool.png"] +image::installation/gcp-new-nodepool.png[Google Cloud Platform new nodepool,link="../_images/installation/gcp-new-nodepool.png"] -image::installation/gcp-new-nodepool-select-machine-type-standard.png[link="../_images/installation/gcp-new-nodepool-select-machine-type-standard.png"] +image::installation/gcp-new-nodepool-select-machine-type-standard.png[Google Cloud Platform new nodepool select machine type,link="../_images/installation/gcp-new-nodepool-select-machine-type-standard.png"] Preferably choose machine types according the workspaces CPU and memory requirements. From 3e4ceffca1e8cf1a1dfd65234c88da68e366c5c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 21:44:43 +0200 Subject: [PATCH 21/30] Fix language on modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc --- .../partials/proc_using-minishift-to-set-up-openshift-3.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc b/modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc index b558817ca8..72f6a0e797 100644 --- a/modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc +++ b/modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc @@ -3,7 +3,7 @@ // installing-{prod-id-short}-on-minishift [id="using-minishift-to-set-up-openshift-3_{context}"] -= Using Minishift to confgure OpenShift 3 += Using Minishift to configure OpenShift 3 This section describes how to use Minishift to configure OpenShift 3. From 85b23dbf5735a12b428679715351d228195f9228 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:19:58 +0200 Subject: [PATCH 22/30] Fix language on modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc --- ...ogle-cloud-node-pools-for-your-eclipse-che-workspaces.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc b/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc index 99cfb0cc37..d46175f8e7 100644 --- a/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc +++ b/modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc @@ -11,8 +11,8 @@ One solution is to create a new node pool and delete the existing one afterwards Another solution is to have two node pools with one dedicated to the workspaces by configuring {prod} with a NodeSelector. See xref:configuring-workspaces-nodeselector.adoc[]. -image::installation/gcp-new-nodepool.png[Google Cloud Platform new nodepool,link="../_images/installation/gcp-new-nodepool.png"] +image::installation/gcp-new-nodepool.png[Google Cloud Platform new node pool,link="../_images/installation/gcp-new-nodepool.png"] -image::installation/gcp-new-nodepool-select-machine-type-standard.png[Google Cloud Platform new nodepool select machine type,link="../_images/installation/gcp-new-nodepool-select-machine-type-standard.png"] +image::installation/gcp-new-nodepool-select-machine-type-standard.png[Google Cloud Platform new node pool select machine type,link="../_images/installation/gcp-new-nodepool-select-machine-type-standard.png"] Preferably choose machine types according the workspaces CPU and memory requirements. From 8afd974cf2ca30ea03b4c0d52ab70724a38eda3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:29:48 +0200 Subject: [PATCH 23/30] Fix language on .vale/styles/Vocab/Che/accept.txt --- .vale/styles/Vocab/Che/accept.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 0c0d604baa..5d1cbdc68d 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -1,11 +1,11 @@ -.NET +\.NET adoc [Aa]nsible Antora API AsciiDoc autostart -AWS +AWS|aws Bitbucket [Bb]oolean breakpoint @@ -58,7 +58,7 @@ Keycloak|keycloak Kubernetes Kubespray Java Lombok -Let's Encrypt +Let\'s Encrypt loopback Mattermost [Mm]aven From 34f2173515198e0f007941ca3bcddf285dfb14e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:29:48 +0200 Subject: [PATCH 24/30] Fix language on modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc --- ..._preparing-the-aws-system-for-installing-che.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc b/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc index 687cd2ac9c..8dccdd7f87 100644 --- a/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc +++ b/modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc @@ -1,7 +1,3 @@ -// Module included in the following assemblies: -// -// installing-{prod-id-short}-on-aws - [id="preparing-the-aws-system-for-installing-che_{context}"] = Preparing the AWS system for installing {prod-short} @@ -67,7 +63,7 @@ $ aws route53 create-hosted-zone --name aws.my-ide.cloud --caller-reference 1 . Configure the four DNS `nameservers` on the `my-ide.cloud` DNS. Note that when a custom DNS provider, updating the record takes a few hours. + -image::installation/dns-nameservers.png[] +image::installation/dns-nameservers.png[DNS name servers] . Create the Simple Storage Service (s3) storage to store the `kops` configuration. + @@ -203,8 +199,12 @@ The existing {kubernetes} instance is prepare to host an {prod-short} installati == Enabling the TLS and DNS challenge +pass:[] + To use the Cloud DNS and TLS, some service accounts must be enabled to have cert-manager managing the DNS challenge for the _Let's Encrypt_ service. +pass:[] + . Create a new `permission` file. . Use the following command to obtain the zone ID: + @@ -258,7 +258,7 @@ $ aws route53 list-hosted-zones . In the *EC2 Dashboard*, identify the *IAM role* used by the master node. + -image::installation/aws-lauch-instance.png[AWS launch instance,link="../_images/installation/aws-lauch-instance.png"] +image::installation/aws-lauch-instance.png[start AWS instance,link="../_images/installation/aws-lauch-instance.png"] + It is located under the *Description* tab, in the *IAM role* field. + From c97f7df6be97bb8263f18614e699443b8998a762 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:32:46 +0200 Subject: [PATCH 25/30] Fix language on modules/installation-guide/examples/checluster-properties.adoc --- modules/installation-guide/examples/checluster-properties.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/examples/checluster-properties.adoc b/modules/installation-guide/examples/checluster-properties.adoc index a3c1a32944..7f35452832 100644 --- a/modules/installation-guide/examples/checluster-properties.adoc +++ b/modules/installation-guide/examples/checluster-properties.adoc @@ -131,7 +131,7 @@ ingressDomain: Global ingress domain for a Kubernetes cluster. This MUST be expl ingressStrategy: Strategy for ingress creation. Options are\: `multi-host` (host is explicitly provided in ingress), `single-host` (host is provided, path-based rules) and `default-host` (no host is provided, path-based rules). Defaults to `multi-host` Deprecated in favor of `serverExposureStrategy` in the `server` section, which defines this regardless of the cluster type. When both are defined, the `serverExposureStrategy` option takes precedence. securityContextFsGroup: The FSGroup in which the Che Pod and workspace Pods containers runs in. Default value is `1724`. securityContextRunAsUser: ID of the user the Che Pod and workspace Pods containers run as. Default value is `1724`. -singleHostExposureType: When the serverExposureStrategy is set to `single-host`, the way the server, registries and workspaces are exposed is further configured by this property. The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s or `gateway` where the server and workspaces are exposed using a custom gateway based on link\:https\://doc.traefik.io/traefik/[Traefik]. All the endpoints whether backed by the ingress or gateway `route` always point to the subpaths on the same domain. Defaults to `native`. +singleHostExposureType: When the serverExposureStrategy is set to `single-host`, the way the server, registries and workspaces are exposed is further configured by this property. The possible values are `native`, which means that the server and workspaces are exposed using ingresses on {kubernetes} or `gateway` where the server and workspaces are exposed using a custom gateway based on link\:https\://doc.traefik.io/traefik/[Traefik]. All the endpoints whether backed by the ingress or gateway `route` always point to the subpaths on the same domain. Defaults to `native`. tlsSecretName: Name of a secret that will be used to setup ingress TLS termination when TLS is enabled. When the field is empty string, the default cluster certificate will be used. See also the `tlsSupport` field. :=== From 1020beff7e16213b3fc82e15bee60e8b1050b6b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:40:06 +0200 Subject: [PATCH 26/30] Fix language on modules/installation-guide/partials/con_persistent-volume-configuration.adoc --- .../partials/con_persistent-volume-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc index 9ffb1a3ec3..c185625e93 100644 --- a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc +++ b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc @@ -20,7 +20,7 @@ All workspaces inside a {platforms-namespace} use the same Persistent Volume Cla * workspace logs * additional Volumes defined by a use -When the `common` PVC strategy is in use, user-defined PVCs are ignored and volumes that refer to these user-defined PVCs are replaced with a volume that refers to the common PVC. +When the `common` PVC strategy is in use, user-defined PVCs are ignored and volumes that relate to these user-defined PVCs are replaced with a volume that refers to the common PVC. In this strategy, all {prod-short} workspaces use the same PVC. When the user runs one workspace, it only binds to one node in the cluster at a time. The corresponding containers volume mounts link to a common volume, and sub-paths are prefixed with `__` or `____`. For more details, see xref:how-subpaths-are-used-in-pvcs_{context}[]. From e1dd1d8c333df9b00ca4dec359db47f33422a1e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:40:06 +0200 Subject: [PATCH 27/30] Fix language on modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc --- ...roc_using-kubespray-to-set-up-kubernetes.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc b/modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc index db90805085..c25dc503ae 100644 --- a/modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc +++ b/modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc @@ -16,7 +16,7 @@ $ sudo apt-get update $ sudo apt-get upgrade ---- -NOTE: This step is only required on the machine used to run Kubespray. Kubespray will take care of system updates on the cluster nodes. +NOTE: This step is only required on the machine used to run Kubespray. Kubespray will handle system updates on the cluster nodes. .SSH access @@ -52,7 +52,7 @@ You will never be prompted again for password using SSH, the key will be used to .IPv4 forwarding -Kubespray requires to turn on IPv4 forwarding. This should be done automatically by Kubepsray. +Kubespray requires to turn on IPv4 forwarding. This should be done automatically by Kubespray. To do it manually, run the following command: @@ -80,7 +80,7 @@ Start by installing curl. sudo apt-get install curl ---- -Get the latest Kubespray source code from its repo. +Get the latest Kubespray source code from its code repository. WARNING: The latest release when writing this tutorial, v2.12.5, throws error not encountered in the master version. @@ -98,15 +98,15 @@ Kubespray uses Python 3 and several dependencies to be installed. * Install Python 3 + -Install Python 3 but also pip (package installer for Python) and venv to create virtual environnements (see below). +Install Python 3 but also `pip` (package installer for Python) and `venv` to create virtual environments (see below). + ---- sudo apt-get install python3.7 python3-pip python3-venv ---- -* Create a virtual env +* Create a virtual environment + -This is a best isolation pratice using Python to use virtual env (or conda env for conda users). +This is a best isolation practice using Python to use virtual environments (or `conda` environments for `conda` users). + ---- python3 -m venv ~/projects/kubespray-venv @@ -127,7 +127,7 @@ Start creating a copy of the default settings from sample cluster. cp -rfp inventory/sample inventory/mycluster ---- -Be sure you are still in the ~/projects/kubespray/ directory before executing this command! +Be sure you are still in the `~/projects/kubespray/` directory before executing this command! Then customize your new cluster @@ -142,7 +142,7 @@ CONFIG_FILE=inventory/mycluster/hosts.yaml python contrib/inventory_builder/inve + If you skip this step, your cluster host names will be renamed node1, node2, and so on. + -You can either edit the file ~/projects/kubespray/inventory/mycluster/hosts.yaml +You can either edit the file `~/projects/kubespray/inventory/mycluster/hosts.yaml` + ---- sed -e 's/node1/tower/g' -e 's/node2/laptop/g' ... -i inventory/mycluster/hosts.yaml From a5df4ca335408e3b5147b01644b382c9962abb06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:43:50 +0200 Subject: [PATCH 28/30] Fix language on modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc --- ..._che-supported-platforms-and-installation-methods.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc b/modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc index 6abf439d9e..27f547e53e 100644 --- a/modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc +++ b/modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc @@ -17,10 +17,10 @@ The following options are available: |{kubernetes} |Installation method -a|* minikube -* microk8s -* docker-desktop -* kind +a|* `minikube` +* `microk8s` +* `docker-desktop` +* `kind` |`{prod-cli}` using Helm Chart or Operator |=== From 19efb534f2b12c7c6865d4d68c1362dd98587195 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:43:50 +0200 Subject: [PATCH 29/30] Fix language on modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc --- .../partials/proc_installing-che-on-kind-using-chectl.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc b/modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc index c73bb7946a..0e8eb9201f 100644 --- a/modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc +++ b/modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc @@ -20,7 +20,7 @@ Following instruction is a way of configuring Kind cluster to have all needed fo . Install https://github.com/kubernetes-csi/csi-driver-host-path[csi-driver-host-path] in the kind cluster: + -Install snapshotter CRDs as described in the https://github.com/kubernetes-csi/csi-driver-host-path/blob/master/docs/deploy-1.17-and-later.md#user-content-volumesnapshot-crds-and-snapshot-controller-installation[docs]: +Install `snapshotter` CRDs as described in the https://github.com/kubernetes-csi/csi-driver-host-path/blob/master/docs/deploy-1.17-and-later.md#user-content-volumesnapshot-crds-and-snapshot-controller-installation[docs]: + [subs="+quotes"] ---- @@ -132,5 +132,5 @@ $ {prod-cli} server:deploy --installer operator --platform k8s --domain 172.17.2 + [NOTE] ==== -In some cases, after all the steps above, it is still not possible to reach {prod-short} from the host machine. If you encounter such problem, refer to kind cluster documentation or forums on how to make an endpoint available outside the kind cluster for your system and network configuration. +In some cases, after all the steps above, it is still not possible to reach {prod-short} from the host machine. If you encounter such problem, see `kind` cluster documentation or forums on how to make an endpoint available outside the kind cluster for your system and network configuration. ==== From de60550194528b4889bc65839ca054903e58f8e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 1 Apr 2021 21:45:55 +0200 Subject: [PATCH 30/30] Fix language on modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc --- .../partials/proc_installing-cert-manager-on-kubernetes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc b/modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc index b1d7d1ab46..36eec7f71d 100644 --- a/modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc +++ b/modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc @@ -73,7 +73,7 @@ EOF . Check that the `issuerRef` name is the same as the `ClusterIssuer`. A new DNS challenge is added to the DNS zone for _Let’s Encrypt_. + -image::installation/dns-challenge-gcp.png[link="../_images/installation/dns-challenge-gcp.png"] +image::installation/dns-challenge-gcp.png[DNS challenge,link="../_images/installation/dns-challenge-gcp.png"] . The cert-manager logs contain information about the DNS challenge. To get the logs (here, `cert-manager-8d478bb45-2924h` is the name of the cert-manager Pod): +