From 1a6bd0bcad3a38bafea409e3b78adcec56cf3378 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Mon, 18 Oct 2021 16:41:38 +0300 Subject: [PATCH 01/25] Add readiness init container docs Signed-off-by: Mykola Morhun --- modules/administration-guide/nav.adoc | 2 + .../enabling-readiness-init-containers.adoc | 6 +++ ...ly_enabling-readiness-init-containers.adoc | 20 +++++++++ ...ess-init-containers-for-olm-installer.adoc | 42 +++++++++++++++++++ ...nit-containers-for-operator-installer.adoc | 24 +++++++++++ 5 files changed, 94 insertions(+) create mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers.adoc create mode 100644 modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc create mode 100644 modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index a4aeb35a60..579a9ffe10 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -34,6 +34,8 @@ * xref:migration-from-postgresql-9-to-postgresql-13.adoc[] +* xref:enabling-readiness-init-containers.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[] diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc new file mode 100644 index 0000000000..587fc52dca --- /dev/null +++ b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc @@ -0,0 +1,6 @@ +[id="enabling-readiness-init-containers"] +:navtitle: Enabling readiness init containers +:keywords: init-container, startup +:page-aliases: .:enabling-readiness-init-containers + +include::partial$assembly_enabling-readiness-init-containers.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc new file mode 100644 index 0000000000..b52fa81808 --- /dev/null +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -0,0 +1,20 @@ +:parent-context-of-assembly_enabling-readiness-init-containers: {context} + +[id="assembly_enabling-readiness-init-containers_{context}"] += Enabling readiness init containers + +:context: assembly_enabling-startup-init-containers + +Normally, {prod-short} Operator installs {prod} and starts its containers in the right order. +However, if a node with {prod-short} gets restarted, than all {prod-short} containers start simultaneously and some might fail as dependent component might not be ready yet. +To handle such a case, one should enable readiness init containers for {prod-short} components. + +Choose the procedure depending on installer type: + +* xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] +* xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] + +include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] +include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] + +:context: {arent-context-of-assembly_enabling-startup-init-containers} diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..06f1d69740 --- /dev/null +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,42 @@ +:_module-type: PROCEDURE + +[id="enabling-readiness-init-containers-for-olm-installer_{context}"] += Enabling readiness init containers for OLM installer + +This section describes how to enable (disable) components readiness init containers for {prod-short} in case of OLM installer. + +.Prerequisites + +. {prod} installed with OLM installer. + +.Procedure + +. Find {prod-short} Operator subscription name: ++ +```sh +$ {orch-cli} get subscriptions -n {prod-namespace} +``` + +. Find CSV name in {prod-short} Operator subscription: ++ +```sh +$ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV +``` + +. Edit the CSV ++ +```sh +$ {orch-cli} edit csv -n {prod-namespace} +``` ++ +by adding (removing) the following: ++ +```yaml + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + value: "true" +``` + +. Wait while {prod-short} Operator restarts some components. + +[NOTE] +When {prod} version is updated, OLM will create a new CSV and the procedure above should be repeated. diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..d3d6985322 --- /dev/null +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,24 @@ +:_module-type: PROCEDURE + +[id="enabling-readiness-init-containers-for-operator-installer_{context}"] += Enabling readiness init containers for Operator installer + +This section describes how to enable (disable) components readiness init containers for {prod-short} in case of Operator installer. + +.Prerequisites + +. {prod} installed with Operator installer. + +.Procedure + +. Find {prod-short} Operator deployment name. + +. Edit the deployment by adding `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable. +Insert (remove) the following under `spec.template.spec.containers[0].env` section of the Operator deployment: ++ +```yaml + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + value: "true" +``` + +. Wait while {prod-short} Operator restarts some components. From 357fec3e048d6fa72397d3e85e7acf83d374c466 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Mal=C3=A9=C5=99?= Date: Mon, 1 Nov 2021 09:27:23 +0100 Subject: [PATCH 02/25] MMaler edits MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Maléř --- ...ly_enabling-readiness-init-containers.adoc | 6 ++-- ...ess-init-containers-for-olm-installer.adoc | 35 ++++++++++--------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc index b52fa81808..4c24fb260a 100644 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -5,11 +5,9 @@ :context: assembly_enabling-startup-init-containers -Normally, {prod-short} Operator installs {prod} and starts its containers in the right order. -However, if a node with {prod-short} gets restarted, than all {prod-short} containers start simultaneously and some might fail as dependent component might not be ready yet. -To handle such a case, one should enable readiness init containers for {prod-short} components. +{prod-short} Operator installs {prod-short} and starts its containers in the right order. However, suppose a node with {prod-short} gets restarted. In that case, all {prod-short} containers start simultaneously, causing some containers to fail because of the dependent component that might not be ready yet. To handle such a case, enable readiness init containers for {prod-short} components. -Choose the procedure depending on installer type: +To troubleshoot this situation, enable readiness init containers by following the procedure that matches the used installation method: * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 06f1d69740..339d870572 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -3,40 +3,43 @@ [id="enabling-readiness-init-containers-for-olm-installer_{context}"] = Enabling readiness init containers for OLM installer -This section describes how to enable (disable) components readiness init containers for {prod-short} in case of OLM installer. +The following section describes how to enable and disable readiness init containers components for {prod-short} for the Operator Lifecycle Manager (OLM) installation method. .Prerequisites -. {prod} installed with OLM installer. +* {prod-short} is installed with OLM installer. .Procedure -. Find {prod-short} Operator subscription name: +. Find the {prod-short} Operator subscription name: + -```sh +[subs="+attributes,+quotes"] +---- $ {orch-cli} get subscriptions -n {prod-namespace} -``` +---- -. Find CSV name in {prod-short} Operator subscription: +. Find the CSV name in the {prod-short} Operator subscription: + -```sh +[subs="+attributes,+quotes"] +---- $ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV -``` +---- -. Edit the CSV +. Edit the CSV: + -```sh +[subs="+attributes,+quotes"] +---- $ {orch-cli} edit csv -n {prod-namespace} -``` +---- + by adding (removing) the following: + -```yaml +[subs="+attributes,+quotes"] +---- - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS value: "true" -``` +---- -. Wait while {prod-short} Operator restarts some components. +. Wait for the {prod-short} Operator restart to finish. -[NOTE] -When {prod} version is updated, OLM will create a new CSV and the procedure above should be repeated. +NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. \ No newline at end of file From 7ba31115abe7bc41af1ae9dd0cc7bce34bccd9fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Mal=C3=A9=C5=99?= Date: Mon, 1 Nov 2021 10:11:22 +0100 Subject: [PATCH 03/25] edits MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Maléř --- .../partials/assembly_enabling-readiness-init-containers.adoc | 4 ++-- ..._enabling-readiness-init-containers-for-olm-installer.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc index 4c24fb260a..54ac086e33 100644 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -5,9 +5,9 @@ :context: assembly_enabling-startup-init-containers -{prod-short} Operator installs {prod-short} and starts its containers in the right order. However, suppose a node with {prod-short} gets restarted. In that case, all {prod-short} containers start simultaneously, causing some containers to fail because of the dependent component that might not be ready yet. To handle such a case, enable readiness init containers for {prod-short} components. +{prod-short} Operator installs {prod-short} and starts its containers in the right order. However, suppose a node with {prod-short} gets restarted. In that case, all {prod-short} containers start simultaneously, causing some containers to fail because of the dependent component that might not be ready yet. To handle such a case, enable readiness init containers for {prod-short} components. -To troubleshoot this situation, enable readiness init containers by following the procedure that matches the used installation method: +To prevent this situation from happening, enable readiness init containers by following the procedure that matches the used installation method: * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 339d870572..5f13cc7d89 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -40,6 +40,6 @@ by adding (removing) the following: value: "true" ---- -. Wait for the {prod-short} Operator restart to finish. +. Wait for the {prod-short} Operator restart to finish. The restarted Operator will then continue with restarting some of its components. NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. \ No newline at end of file From 2b130a33dfbed2def60a219883471c48121bfdad Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Mon, 1 Nov 2021 11:31:55 +0200 Subject: [PATCH 04/25] Small corrections Signed-off-by: Mykola Morhun --- ..._enabling-readiness-init-containers-for-olm-installer.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 5f13cc7d89..c2565b0de9 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -32,7 +32,7 @@ $ {orch-cli} get subscription -n {prod-namespace} -o yaml | $ {orch-cli} edit csv -n {prod-namespace} ---- + -by adding (removing) the following: +by adding (removing) the following environment variable to (from) the Operator deployment spec: + [subs="+attributes,+quotes"] ---- @@ -42,4 +42,4 @@ by adding (removing) the following: . Wait for the {prod-short} Operator restart to finish. The restarted Operator will then continue with restarting some of its components. -NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. \ No newline at end of file +NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. From 26119996dcee8500723e642191aa8e05611ba3ce Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Mon, 1 Nov 2021 15:01:07 +0200 Subject: [PATCH 05/25] Add a note about operator upgrade Signed-off-by: Mykola Morhun --- ...abling-readiness-init-containers-for-operator-installer.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index d3d6985322..2c94f317b8 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -22,3 +22,5 @@ Insert (remove) the following under `spec.template.spec.containers[0].env` secti ``` . Wait while {prod-short} Operator restarts some components. + +NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator deployment is created. From 03c39b916cbbffbbadd312f6d4cc9982b4554c9a Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Wed, 3 Nov 2021 09:42:01 +0200 Subject: [PATCH 06/25] Apply suggestions from code review by max-cx Co-authored-by: Max Leonov --- .../enabling-readiness-init-containers.adoc | 2 +- ...embly_enabling-readiness-init-containers.adoc | 4 ++-- ...diness-init-containers-for-olm-installer.adoc | 11 +++++------ ...s-init-containers-for-operator-installer.adoc | 16 ++++++++-------- 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc index 587fc52dca..5cbea4bf54 100644 --- a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc @@ -1,6 +1,6 @@ [id="enabling-readiness-init-containers"] :navtitle: Enabling readiness init containers -:keywords: init-container, startup +:keywords: init-container, queue-init, queue-init-container, startup :page-aliases: .:enabling-readiness-init-containers include::partial$assembly_enabling-readiness-init-containers.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc index 54ac086e33..25dfc6d122 100644 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -5,9 +5,9 @@ :context: assembly_enabling-startup-init-containers -{prod-short} Operator installs {prod-short} and starts its containers in the right order. However, suppose a node with {prod-short} gets restarted. In that case, all {prod-short} containers start simultaneously, causing some containers to fail because of the dependent component that might not be ready yet. To handle such a case, enable readiness init containers for {prod-short} components. +{prod-short} Operator installs {prod-short} and starts its containers in the right order. If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, queue init containers queue the containers for {prod-short} components to start in the right order. -To prevent this situation from happening, enable readiness init containers by following the procedure that matches the used installation method: +Queue init containers are not enabled by default. You can enable and disable them according to the installation method used to install {prod-short}: * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index c2565b0de9..4a77fdfd32 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -3,7 +3,7 @@ [id="enabling-readiness-init-containers-for-olm-installer_{context}"] = Enabling readiness init containers for OLM installer -The following section describes how to enable and disable readiness init containers components for {prod-short} for the Operator Lifecycle Manager (OLM) installation method. +To enable or disable queue init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: .Prerequisites @@ -20,21 +20,20 @@ $ {orch-cli} get subscriptions -n {prod-namespace} . Find the CSV name in the {prod-short} Operator subscription: + -[subs="+attributes,+quotes"] +[source,shell,subs="+quotes,+attributes"] ---- $ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV ---- . Edit the CSV: + -[subs="+attributes,+quotes"] +[source,shell,subs="+quotes,+attributes"] ---- $ {orch-cli} edit csv -n {prod-namespace} ---- +. Add (remove) the following environment variable to (from) the Operator Deployment spec: + -by adding (removing) the following environment variable to (from) the Operator deployment spec: -+ -[subs="+attributes,+quotes"] +[source,yaml,subs="+quotes,+attributes"] ---- - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS value: "true" diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index 2c94f317b8..f30375ddb6 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -3,24 +3,24 @@ [id="enabling-readiness-init-containers-for-operator-installer_{context}"] = Enabling readiness init containers for Operator installer -This section describes how to enable (disable) components readiness init containers for {prod-short} in case of Operator installer. +To enable or disable queue init containers for {prod-short} installed using the Operator installer: .Prerequisites -. {prod} installed with Operator installer. +* {prod} installed with Operator installer. .Procedure -. Find {prod-short} Operator deployment name. +. Find {prod-short} Operator Deployment name. -. Edit the deployment by adding `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable. -Insert (remove) the following under `spec.template.spec.containers[0].env` section of the Operator deployment: +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert (remove) the following lines with the `ADD_QUEUE_INIT_CONTAINERS` environment variable: + -```yaml +[source,yaml,subs="+quotes,+attributes"] +---- - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS value: "true" -``` +---- . Wait while {prod-short} Operator restarts some components. -NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator deployment is created. +NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator Deployment is created. From 7beed5f4d171d8cc5c296bb2fb531f3ee9562ba4 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Wed, 3 Nov 2021 09:47:10 +0200 Subject: [PATCH 07/25] Corrections Signed-off-by: Mykola Morhun --- .../pages/enabling-readiness-init-containers.adoc | 2 +- .../assembly_enabling-readiness-init-containers.adoc | 7 +++++-- ...abling-readiness-init-containers-for-olm-installer.adoc | 2 +- ...g-readiness-init-containers-for-operator-installer.adoc | 4 ++-- 4 files changed, 9 insertions(+), 6 deletions(-) diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc index 5cbea4bf54..cf7da4f4f1 100644 --- a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc @@ -1,6 +1,6 @@ [id="enabling-readiness-init-containers"] :navtitle: Enabling readiness init containers -:keywords: init-container, queue-init, queue-init-container, startup +:keywords: init-container, readiness-init-container, startup :page-aliases: .:enabling-readiness-init-containers include::partial$assembly_enabling-readiness-init-containers.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc index 25dfc6d122..833727a404 100644 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -5,9 +5,12 @@ :context: assembly_enabling-startup-init-containers -{prod-short} Operator installs {prod-short} and starts its containers in the right order. If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, queue init containers queue the containers for {prod-short} components to start in the right order. +{prod-short} Operator installs {prod-short} and starts its containers in the right order. +If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. +To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. -Queue init containers are not enabled by default. You can enable and disable them according to the installation method used to install {prod-short}: +Readiness init containers are not enabled by default. +You can enable and disable them according to the installation method used to install {prod-short}: * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] * xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 4a77fdfd32..6e412642c8 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -3,7 +3,7 @@ [id="enabling-readiness-init-containers-for-olm-installer_{context}"] = Enabling readiness init containers for OLM installer -To enable or disable queue init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: +To enable or disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index f30375ddb6..69e16f4833 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -3,7 +3,7 @@ [id="enabling-readiness-init-containers-for-operator-installer_{context}"] = Enabling readiness init containers for Operator installer -To enable or disable queue init containers for {prod-short} installed using the Operator installer: +To enable or disable readiness init containers for {prod-short} installed using the Operator installer: .Prerequisites @@ -13,7 +13,7 @@ To enable or disable queue init containers for {prod-short} installed using the . Find {prod-short} Operator Deployment name. -. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert (remove) the following lines with the `ADD_QUEUE_INIT_CONTAINERS` environment variable: +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert (remove) the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: + [source,yaml,subs="+quotes,+attributes"] ---- From 024907ad1d7886af149109dfa2e8ae0082148734 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Fri, 5 Nov 2021 09:33:14 +0200 Subject: [PATCH 08/25] Apply suggestions from code review by max-cx Co-authored-by: Max Leonov --- ...-readiness-init-containers-for-olm-installer.adoc | 12 +++++++----- ...iness-init-containers-for-operator-installer.adoc | 6 ++++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 6e412642c8..2f65c3f988 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -1,7 +1,9 @@ :_module-type: PROCEDURE -[id="enabling-readiness-init-containers-for-olm-installer_{context}"] -= Enabling readiness init containers for OLM installer +[id="enabling-and-disabling-readiness-init-containers-for-olm-installer_{context}"] += Enabling and disabling readiness init containers for OLM installer + +Readiness init containers are not enabled by default. To enable or disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: @@ -13,7 +15,7 @@ To enable or disable readiness init containers for {prod-short} installed using . Find the {prod-short} Operator subscription name: + -[subs="+attributes,+quotes"] +[source,shell,subs="+quotes,+attributes"] ---- $ {orch-cli} get subscriptions -n {prod-namespace} ---- @@ -25,11 +27,11 @@ $ {orch-cli} get subscriptions -n {prod-namespace} $ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV ---- -. Edit the CSV: +. Edit the `ClusterServiceVersion` (CSV) YAML manifest: + [source,shell,subs="+quotes,+attributes"] ---- -$ {orch-cli} edit csv -n {prod-namespace} +$ {orch-cli} edit csv __ -n {prod-namespace} ---- . Add (remove) the following environment variable to (from) the Operator Deployment spec: + diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index 69e16f4833..79047bc130 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -1,7 +1,9 @@ :_module-type: PROCEDURE -[id="enabling-readiness-init-containers-for-operator-installer_{context}"] -= Enabling readiness init containers for Operator installer +[id="enabling-and-disabling-readiness-init-containers-for-operator-installer_{context}"] += Enabling and disabling readiness init containers for Operator installer + +Readiness init containers are not enabled by default. To enable or disable readiness init containers for {prod-short} installed using the Operator installer: From 2a9e7df600e5338c79e9b43c140328c2fbf6b7fa Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 11 Nov 2021 18:05:55 +0100 Subject: [PATCH 09/25] draft --- modules/administration-guide/nav.adoc | 2 +- .../enabling-readiness-init-containers.adoc | 6 --- .../pages/readiness-init-containers.adoc | 7 +++ ...ly_enabling-readiness-init-containers.adoc | 17 ++++--- ..._purpose-of-readiness-init-containers.adoc | 8 ++++ ...ess-init-containers-for-olm-installer.adoc | 46 +++++++++++++++++++ ...nit-containers-for-operator-installer.adoc | 28 +++++++++++ ...ess-init-containers-for-olm-installer.adoc | 8 ++-- ...nit-containers-for-operator-installer.adoc | 8 ++-- 9 files changed, 108 insertions(+), 22 deletions(-) delete mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers.adoc create mode 100644 modules/administration-guide/pages/readiness-init-containers.adoc create mode 100644 modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc create mode 100644 modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 579a9ffe10..70beaf2ed9 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -34,7 +34,7 @@ * xref:migration-from-postgresql-9-to-postgresql-13.adoc[] -* xref:enabling-readiness-init-containers.adoc[] +* xref:readiness-init-containers.adoc[] * xref:caching-images-for-faster-workspace-start.adoc[] ** xref:defining-the-list-of-images-to-pull.adoc[] diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers.adoc deleted file mode 100644 index cf7da4f4f1..0000000000 --- a/modules/administration-guide/pages/enabling-readiness-init-containers.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[id="enabling-readiness-init-containers"] -:navtitle: Enabling readiness init containers -:keywords: init-container, readiness-init-container, startup -:page-aliases: .:enabling-readiness-init-containers - -include::partial$assembly_enabling-readiness-init-containers.adoc[] diff --git a/modules/administration-guide/pages/readiness-init-containers.adoc b/modules/administration-guide/pages/readiness-init-containers.adoc new file mode 100644 index 0000000000..ebe24040b8 --- /dev/null +++ b/modules/administration-guide/pages/readiness-init-containers.adoc @@ -0,0 +1,7 @@ +[id="readiness-init-containers"] +:navtitle: Readiness init containers +:keywords: init-container, readiness-init-container, startup +:page-aliases: .:enabling-readiness-init-containers + +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc index 833727a404..650ecdc62e 100644 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc @@ -1,21 +1,24 @@ -:parent-context-of-assembly_enabling-readiness-init-containers: {context} +:parent-context-of-enabling-readiness-init-containers: {context} [id="assembly_enabling-readiness-init-containers_{context}"] -= Enabling readiness init containers += Enabling and disabling readiness init containers -:context: assembly_enabling-startup-init-containers +:context: enabling-and-disabling-readiness-init-containers-for-operator-installer {prod-short} Operator installs {prod-short} and starts its containers in the right order. If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. Readiness init containers are not enabled by default. -You can enable and disable them according to the installation method used to install {prod-short}: -* xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-operator-installer_{context}[] -* xref:enabling-readiness-init-containers.adoc#enabling-readiness-init-containers-for-olm-installer_{context}[] +You can enable or disable readiness init containers for {prod-short} installed using the Operator installer. + +You can enable and disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer. include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] +include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] + include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] +include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] -:context: {arent-context-of-assembly_enabling-startup-init-containers} +:context: {arent-context-of-enabling-startup-init-containers} diff --git a/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc b/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc new file mode 100644 index 0000000000..0c77f02d87 --- /dev/null +++ b/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc @@ -0,0 +1,8 @@ +[id="purpose-of-readiness-init-containers_{context}"] += Purpose of readiness init containers + +{prod-short} Operator installs {prod-short} and starts its containers in the right order. Yet if a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. + +To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. + +Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..4435932155 --- /dev/null +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,46 @@ +:_module-type: PROCEDURE + +[id="disabling-readiness-init-containers-for-olm-installer_{context}"] += Disabling readiness init containers for OLM installer + +Readiness init containers are not enabled by default. + +To disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: + +.Prerequisites + +* {prod-short} is installed with OLM installer. + +.Procedure + +. Find the {prod-short} Operator subscription name: ++ +[source,shell,subs="+quotes,+attributes"] +---- +$ {orch-cli} get subscriptions -n {prod-namespace} +---- + +. Find the CSV name in the {prod-short} Operator subscription: ++ +[source,shell,subs="+quotes,+attributes"] +---- +$ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV +---- + +. Edit the `ClusterServiceVersion` (CSV) YAML manifest: ++ +[source,shell,subs="+quotes,+attributes"] +---- +$ {orch-cli} edit csv __ -n {prod-namespace} +---- +. Remove the following environment variable to (from) the Operator Deployment spec: ++ +[source,yaml,subs="+quotes,+attributes"] +---- + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + value: "true" +---- + +. Wait for the {prod-short} Operator restart to finish. The restarted Operator will then continue with restarting some of its components. + +NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..e41e6dce5e --- /dev/null +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,28 @@ +:_module-type: PROCEDURE + +[id="disabling-readiness-init-containers-for-operator-installer_{context}"] += Disabling readiness init containers for Operator installer + +Readiness init containers are not enabled by default. + +To disable readiness init containers for {prod-short} installed using the Operator installer: + +.Prerequisites + +* {prod} installed with Operator installer. + +.Procedure + +. Find {prod-short} Operator Deployment name. + +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, remove the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: ++ +[source,yaml,subs="+quotes,+attributes"] +---- + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + value: "true" +---- + +. Wait while {prod-short} Operator restarts some components. + +NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator Deployment is created. diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index 2f65c3f988..bf184a2fba 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -1,11 +1,11 @@ :_module-type: PROCEDURE -[id="enabling-and-disabling-readiness-init-containers-for-olm-installer_{context}"] -= Enabling and disabling readiness init containers for OLM installer +[id="enabling-readiness-init-containers-for-olm-installer_{context}"] += Enabling readiness init containers for OLM installer Readiness init containers are not enabled by default. -To enable or disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: +To enable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: .Prerequisites @@ -33,7 +33,7 @@ $ {orch-cli} get subscription -n {prod-namespace} -o yaml | ---- $ {orch-cli} edit csv __ -n {prod-namespace} ---- -. Add (remove) the following environment variable to (from) the Operator Deployment spec: +. Add the following environment variable to the Operator Deployment spec: + [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index 79047bc130..d877690ebe 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -1,11 +1,11 @@ :_module-type: PROCEDURE -[id="enabling-and-disabling-readiness-init-containers-for-operator-installer_{context}"] -= Enabling and disabling readiness init containers for Operator installer +[id="enabling-readiness-init-containers-for-operator-installer_{context}"] += Enabling readiness init containers for Operator installer Readiness init containers are not enabled by default. -To enable or disable readiness init containers for {prod-short} installed using the Operator installer: +To enable readiness init containers for {prod-short} installed using the Operator installer: .Prerequisites @@ -15,7 +15,7 @@ To enable or disable readiness init containers for {prod-short} installed using . Find {prod-short} Operator Deployment name. -. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert (remove) the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: + [source,yaml,subs="+quotes,+attributes"] ---- From 93d1eb35287dd544cc1cb2e12096932edd335fb6 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 12 Nov 2021 00:15:27 +0100 Subject: [PATCH 10/25] draft --- .../pages/readiness-init-containers.adoc | 2 ++ ...ess-init-containers-for-olm-installer.adoc | 15 ++++++++++++ ...nit-containers-for-operator-installer.adoc | 15 ++++++++++++ ...ly_enabling-readiness-init-containers.adoc | 24 ------------------- ..._purpose-of-readiness-init-containers.adoc | 6 +---- ...ess-init-containers-for-olm-installer.adoc | 2 -- ...nit-containers-for-operator-installer.adoc | 2 -- ...ess-init-containers-for-olm-installer.adoc | 2 ++ ...nit-containers-for-operator-installer.adoc | 2 ++ 9 files changed, 37 insertions(+), 33 deletions(-) create mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc delete mode 100644 modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc diff --git a/modules/administration-guide/pages/readiness-init-containers.adoc b/modules/administration-guide/pages/readiness-init-containers.adoc index ebe24040b8..e0b5a7304f 100644 --- a/modules/administration-guide/pages/readiness-init-containers.adoc +++ b/modules/administration-guide/pages/readiness-init-containers.adoc @@ -1,7 +1,9 @@ [id="readiness-init-containers"] += Readiness init containers :navtitle: Readiness init containers :keywords: init-container, readiness-init-container, startup :page-aliases: .:enabling-readiness-init-containers +include::partial$con_purpose-of-readiness-init-containers.adoc[] include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..438216e2e7 --- /dev/null +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,15 @@ +:parent-context-of-enabling-readiness-init-containers-for-olm-installer: {context} + +[id="assembly_enabling-readiness-init-containers-for-olm-installer_{context}"] += Enabling and disabling readiness init containers for OLM installer + +:context: enabling-and-disabling-readiness-init-containers-for-olm-installer + +Readiness init containers are not enabled by default. + +You can enable and disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer. + +include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] +include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] + +:context: {parent-context-of-enabling-readiness-init-containers-for-olm-installer} diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..f58dd0e041 --- /dev/null +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,15 @@ +:parent-context-of-enabling-readiness-init-containers-for-operator-installer: {context} + +[id="assembly_enabling-readiness-init-containers-for-operator-installer_{context}"] += Enabling and disabling readiness init containers for Operator installer + +:context: enabling-and-disabling-readiness-init-containers-for-operator-installer + +Readiness init containers are not enabled by default. + +You can enable or disable readiness init containers for {prod-short} installed using the Operator installer. + +include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] +include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] + +:context: {arent-context-of-enabling-startup-init-containers-for-operator-installer} diff --git a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc deleted file mode 100644 index 650ecdc62e..0000000000 --- a/modules/administration-guide/partials/assembly_enabling-readiness-init-containers.adoc +++ /dev/null @@ -1,24 +0,0 @@ -:parent-context-of-enabling-readiness-init-containers: {context} - -[id="assembly_enabling-readiness-init-containers_{context}"] -= Enabling and disabling readiness init containers - -:context: enabling-and-disabling-readiness-init-containers-for-operator-installer - -{prod-short} Operator installs {prod-short} and starts its containers in the right order. -If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. -To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. - -Readiness init containers are not enabled by default. - -You can enable or disable readiness init containers for {prod-short} installed using the Operator installer. - -You can enable and disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer. - -include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] -include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] - -include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] -include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] - -:context: {arent-context-of-enabling-startup-init-containers} diff --git a/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc b/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc index 0c77f02d87..298f3e1e23 100644 --- a/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc +++ b/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc @@ -1,8 +1,4 @@ [id="purpose-of-readiness-init-containers_{context}"] = Purpose of readiness init containers -{prod-short} Operator installs {prod-short} and starts its containers in the right order. Yet if a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. - -To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. - -Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). \ No newline at end of file +{prod-short} Operator installs {prod-short} and starts its containers in the right order. Yet if a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc index 4435932155..34ee085208 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc @@ -3,8 +3,6 @@ [id="disabling-readiness-init-containers-for-olm-installer_{context}"] = Disabling readiness init containers for OLM installer -Readiness init containers are not enabled by default. - To disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc index e41e6dce5e..8016cb5100 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc @@ -3,8 +3,6 @@ [id="disabling-readiness-init-containers-for-operator-installer_{context}"] = Disabling readiness init containers for Operator installer -Readiness init containers are not enabled by default. - To disable readiness init containers for {prod-short} installed using the Operator installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index bf184a2fba..f744cbcfda 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -5,6 +5,8 @@ Readiness init containers are not enabled by default. +Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). + To enable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index d877690ebe..35439dbff3 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -5,6 +5,8 @@ Readiness init containers are not enabled by default. +Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). + To enable readiness init containers for {prod-short} installed using the Operator installer: .Prerequisites From 636ac739423fb85af0e39c482f15db54786fc3ad Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 12 Nov 2021 16:53:13 +0100 Subject: [PATCH 11/25] draft --- modules/administration-guide/nav.adoc | 6 ++ ...ess-init-containers-for-olm-installer.adoc | 6 ++ ...nit-containers-for-operator-installer.adoc | 6 ++ ...ess-init-containers-for-olm-installer.adoc | 6 ++ ...nit-containers-for-operator-installer.adoc | 6 ++ ...ess-init-containers-for-olm-installer.adoc | 6 ++ ...nit-containers-for-operator-installer.adoc | 6 ++ .../pages/readiness-init-containers.adoc | 5 +- ...ess-init-containers-for-olm-installer.adoc | 16 ++-- ...nit-containers-for-operator-installer.adoc | 16 ++-- .../assembly_readiness-init-containers.adoc | 16 ++++ ..._purpose-of-readiness-init-containers.adoc | 4 - ...ess-init-containers-for-olm-installer.adoc | 6 +- ...nit-containers-for-operator-installer.adoc | 8 +- ...ess-init-containers-for-olm-installer.adoc | 10 +-- ...nit-containers-for-operator-installer.adoc | 12 +-- .../proc_managing-backups-using-chectl.adoc | 77 ------------------- 17 files changed, 85 insertions(+), 127 deletions(-) create mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/partials/assembly_readiness-init-containers.adoc delete mode 100644 modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc delete mode 100644 modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 70beaf2ed9..dfa94fc686 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -35,6 +35,12 @@ * xref:migration-from-postgresql-9-to-postgresql-13.adoc[] * xref:readiness-init-containers.adoc[] +** xref:enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] +*** xref:enabling-readiness-init-containers-for-operator-installer.adoc[] +*** xref:disabling-readiness-init-containers-for-operator-installer.adoc[] +** xref:enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] +*** xref:enabling-readiness-init-containers-for-olm-installer.adoc[] +*** xref:disabling-readiness-init-containers-for-olm-installer.adoc[] * xref:caching-images-for-faster-workspace-start.adoc[] ** xref:defining-the-list-of-images-to-pull.adoc[] diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..5f9cf70efb --- /dev/null +++ b/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,6 @@ +[id="disabling-readiness-init-containers-for-olm-installer"] +:navtitle: Disabling the readiness init containers for the OLM installer +:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, olm +:page-aliases: .:disabling-readiness-init-containers-for-olm-installer + +include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..ae4e753a76 --- /dev/null +++ b/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,6 @@ +[id="disabling-readiness-init-containers-for-operator-installer"] +:navtitle: Disabling the readiness init containers for the Operator installer +:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, operator +:page-aliases: .:disabling-readiness-init-containers-for-operator-installer + +include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..178500d03d --- /dev/null +++ b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-and-disabling-readiness-init-containers-for-olm-installer"] +:navtitle: Enabling and disabling the readiness init containers for the OLM installer +:keywords: enable-readiness-init-containers, disable-readiness-init-containers, enabling-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, olm +:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-olm-installer + +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..d1cf36b10c --- /dev/null +++ b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-and-disabling-readiness-init-containers-for-operator-installer"] +:navtitle: Enabling and disabling the readiness init containers for the Operator installer +:keywords: enable-readiness-init-containers, disable-readiness-init-containers, enabling-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, operator +:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-operator-installer + +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc new file mode 100644 index 0000000000..bae9c002a8 --- /dev/null +++ b/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-readiness-init-containers-for-olm-installer"] +:navtitle: Enabling the readiness init containers for the OLM installer +:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, olm +:page-aliases: .:enabling-readiness-init-containers-for-olm-installer + +include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc new file mode 100644 index 0000000000..8e241003ec --- /dev/null +++ b/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-readiness-init-containers-for-operator-installer"] +:navtitle: Enabling the readiness init containers for the Operator installer +:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, operator +:page-aliases: .:enabling-readiness-init-containers-for-operator-installer + +include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/readiness-init-containers.adoc b/modules/administration-guide/pages/readiness-init-containers.adoc index e0b5a7304f..c4cb1fa590 100644 --- a/modules/administration-guide/pages/readiness-init-containers.adoc +++ b/modules/administration-guide/pages/readiness-init-containers.adoc @@ -1,9 +1,6 @@ [id="readiness-init-containers"] -= Readiness init containers :navtitle: Readiness init containers :keywords: init-container, readiness-init-container, startup :page-aliases: .:enabling-readiness-init-containers -include::partial$con_purpose-of-readiness-init-containers.adoc[] -include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] -include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] +include::partial$assembly_readiness-init-containers.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc index 438216e2e7..2e9b94ef32 100644 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc @@ -1,15 +1,13 @@ -:parent-context-of-enabling-readiness-init-containers-for-olm-installer: {context} +:parent-context-of-enabling-and-disabling-readiness-init-containers-for-olm-installer: {context} -[id="assembly_enabling-readiness-init-containers-for-olm-installer_{context}"] -= Enabling and disabling readiness init containers for OLM installer +[id="enabling-and-disabling-readiness-init-containers-for-olm-installer_{context}"] += Enabling and disabling the readiness init containers for the OLM installer :context: enabling-and-disabling-readiness-init-containers-for-olm-installer -Readiness init containers are not enabled by default. +You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer: -You can enable and disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer. +* xref:enabling-readiness-init-containers-for-olm-installer.adoc[Enabling the readiness init containers for the OLM installer] +* xref:disabling-readiness-init-containers-for-olm-installer.adoc[Disabling the readiness init containers for the OLM installer] -include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] -include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[leveloffset=+1] - -:context: {parent-context-of-enabling-readiness-init-containers-for-olm-installer} +:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-olm-installer} \ No newline at end of file diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc index f58dd0e041..1e9396502f 100644 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc @@ -1,15 +1,13 @@ -:parent-context-of-enabling-readiness-init-containers-for-operator-installer: {context} +:parent-context-of-enabling-and-disabling-readiness-init-containers-for-operator-installer: {context} -[id="assembly_enabling-readiness-init-containers-for-operator-installer_{context}"] -= Enabling and disabling readiness init containers for Operator installer +[id="enabling-and-disabling-readiness-init-containers-for-operator-installer_{context}"] += Enabling and disabling the readiness init containers for the Operator installer :context: enabling-and-disabling-readiness-init-containers-for-operator-installer -Readiness init containers are not enabled by default. +You can enable and disable the readiness init containers for {prod-short} installed by the Operator installer: -You can enable or disable readiness init containers for {prod-short} installed using the Operator installer. +* xref:enabling-readiness-init-containers-for-operator-installer.adoc[Enabling the readiness init containers for the Operator installer] +* xref:disabling-readiness-init-containers-for-operator-installer.adoc[Disabling the readiness init containers for the Operator installer] -include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] -include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[leveloffset=+1] - -:context: {arent-context-of-enabling-startup-init-containers-for-operator-installer} +:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-operator-installer} diff --git a/modules/administration-guide/partials/assembly_readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_readiness-init-containers.adoc new file mode 100644 index 0000000000..da8c565082 --- /dev/null +++ b/modules/administration-guide/partials/assembly_readiness-init-containers.adoc @@ -0,0 +1,16 @@ +:parent-context-of-readiness-init-containers: {context} + +[id="readiness-init-containers_{context}"] += Readiness init containers + +:context: readiness-init-containers + +{prod-short} Operator installs {prod-short} and starts its containers in the correct order. If a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, the readiness init containers queue the containers for {prod-short} components to start in the correct order. + +The readiness init containers are disabled by default. If you choose to enable them, proceed according to the installation method used to install {prod-short}: + +* xref:enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] + +* xref:enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] + +:context: {parent-context-of-readiness-init-containers} \ No newline at end of file diff --git a/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc b/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc deleted file mode 100644 index 298f3e1e23..0000000000 --- a/modules/administration-guide/partials/con_purpose-of-readiness-init-containers.adoc +++ /dev/null @@ -1,4 +0,0 @@ -[id="purpose-of-readiness-init-containers_{context}"] -= Purpose of readiness init containers - -{prod-short} Operator installs {prod-short} and starts its containers in the right order. Yet if a node with {prod-short} is restarted and all {prod-short} containers start simultaneously, some containers may fail because some other component they depend on is not ready. To avoid such failures, readiness init containers queue the containers for {prod-short} components to start in the right order. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc index 34ee085208..2a77b5e7cc 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc @@ -1,13 +1,13 @@ :_module-type: PROCEDURE [id="disabling-readiness-init-containers-for-olm-installer_{context}"] -= Disabling readiness init containers for OLM installer += Disabling the readiness init containers for the OLM installer -To disable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: +To disable the previously enabled readiness init containers for {prod-short} installed by the Operator Lifecycle Manager (OLM) installer: .Prerequisites -* {prod-short} is installed with OLM installer. +* {prod-short} is installed by the OLM installer. .Procedure diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc index 8016cb5100..e7f161fbf2 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc @@ -1,13 +1,11 @@ -:_module-type: PROCEDURE - [id="disabling-readiness-init-containers-for-operator-installer_{context}"] -= Disabling readiness init containers for Operator installer += Disabling the readiness init containers for the Operator installer -To disable readiness init containers for {prod-short} installed using the Operator installer: +To disable the previously enabled readiness init containers for {prod-short} installed by the Operator installer: .Prerequisites -* {prod} installed with Operator installer. +* {prod} installed by the Operator installer. .Procedure diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc index f744cbcfda..0c1698c76b 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc @@ -1,17 +1,13 @@ :_module-type: PROCEDURE [id="enabling-readiness-init-containers-for-olm-installer_{context}"] -= Enabling readiness init containers for OLM installer += Enabling the readiness init containers for the OLM installer -Readiness init containers are not enabled by default. - -Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). - -To enable readiness init containers for {prod-short} installed using the Operator Lifecycle Manager (OLM) installer: +The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the Operator Lifecycle Manager (OLM) installer: .Prerequisites -* {prod-short} is installed with OLM installer. +* {prod-short} is installed by the OLM installer. .Procedure diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc index 35439dbff3..45af4061c2 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc @@ -1,17 +1,11 @@ -:_module-type: PROCEDURE - [id="enabling-readiness-init-containers-for-operator-installer_{context}"] -= Enabling readiness init containers for Operator installer - -Readiness init containers are not enabled by default. - -Readiness init containers are not enabled by default, so to use them you first have to enable them according to the installation method used to install {prod-short} (Operator installer or OLM installer). += Enabling the readiness init containers for the Operator installer -To enable readiness init containers for {prod-short} installed using the Operator installer: +The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the Operator installer: .Prerequisites -* {prod} installed with Operator installer. +* {prod} installed by the Operator installer. .Procedure diff --git a/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc b/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc deleted file mode 100644 index 4cb42f9a9e..0000000000 --- a/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc +++ /dev/null @@ -1,77 +0,0 @@ -[id="managing-backups-using-chectl_{context}"] -= Managing backups using {prod-cli} - -The following section describes how to create and use backups of a {prod-short} installation to perform a recovery or a rollback to a previous version using `{prod-cli}`. - -include::partial$snip_internal-backup-server-warning.adoc[] - -.Prerequisites - -* xref:setup-backup-server.adoc[Set up a backup server]. - -* xref:configuring-chectl-to-use-backup-server.adoc[Configure {prod-cli} to use the backup server]. - -.Procedure - -* xref:creating-a-new-backup-using-{prod-cli}_{context}[] - -* xref:restoring-from-a-backup-using-{prod-cli}_{context}[] - - -[id="creating-a-new-backup-using-{prod-cli}_{context}"] -== Creating a {prod-short} backup - -. To create a backup snapshot and send it to a pre-configured backup server: -+ -[source,shell,subs="+quotes,+attributes"] ----- -$ {prod-cli} server:backup --repository-url=____ --repository-password=____ ----- -+ -* You can create other backups to the same backup server using the `server:backup` command with no arguments. -* Using the `server:backup` command with no arguments for the first time will configure and use an internal backup server. - - -[id="restoring-from-a-backup-using-{prod-cli}_{context}"] -== Restoring {prod-short} from a backup - -A {prod-short} admin can use an existing snapshot of a particular {prod-short} version to restore a desired state or version. The following instructions describe several variations of the restoration command. Adjust the command arguments according to your use case. - -* To restore the previous functional state of the same version of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --repository-url=____ --repository-password=____ --snapshot-id=____ ----- - - -* To roll back to a version different from the current version of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --version=____ --snapshot-id=____ --repository-url=____ --repository-password=____ ----- -+ -This performs a version rollback and restores a snapshot made from a previous version of {prod-short}. The provided snapshot must be created from the version of {prod-short} to which you want to roll back. -+ -NOTE: If you have a dedicated backup repository for each {prod-short} version and want to use the most recent backup for the version, you can provide the `latest` argument as a snapshot ID. By doing so, the `latest` argument will be converted to the latest known ID in the given repository, which will be then used by the {prod-short} Operator to recover. - - -* To restore a state described by an existing backup Custom Resource: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --backup-cr-name=____ ----- - - -* To roll back a version upgrade of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --rollback ----- -+ -This recovers the version that {prod-short} was using before upgrading to a later version. -+ -NOTE: {prod-short} Operator automatically creates a backup before every upgrade. From 1ff5501f1efbb4e7cedf56373e054f7114e16b76 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Mon, 15 Nov 2021 10:01:40 +0100 Subject: [PATCH 12/25] update antora.yml to pass checks before updating PR-destination branch --- antora.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/antora.yml b/antora.yml index 7acf81317b..be73499f7f 100644 --- a/antora.yml +++ b/antora.yml @@ -31,7 +31,7 @@ asciidoc: identity-provider-id: keycloak identity-provider-image-url: quay.io/eclipse/che-keycloak identity-provider-url: https://www.keycloak.org/ - identity-provider-version: "6.0" + identity-provider-version: "15.0" identity-provider: Keycloak image-puller-cr-name: KubernetesImagePuller image-puller-deployment-id: kubernetes-image-puller-operator @@ -55,9 +55,9 @@ asciidoc: link-cli-github: https://github.com/che-incubator/chectl link-identity-provider-documentation-openshift-3: https://www.keycloak.org/docs/latest/server_admin/#openshift-3 link-identity-provider-documentation-openshift-4: https://www.keycloak.org/docs/latest/server_admin/#openshift-4 - link-identity-provider-github: "https://www.keycloak.org/docs/6.0//server_admin/#github" - link-identity-provider-oidc: "https://www.keycloak.org/docs/6.0/server_admin/#_oidc" - link-identity-provider-saml: "https://www.keycloak.org/docs/6.0/server_admin/#saml-v2-0-identity-providers" + link-identity-provider-github: "https://www.keycloak.org/docs/15.0//server_admin/#github" + link-identity-provider-oidc: "https://www.keycloak.org/docs/15.0/server_admin/#_oidc" + link-identity-provider-saml: "https://www.keycloak.org/docs/15.0/server_admin/#saml-v2-0-identity-providers" link-installing-an-instance: xref:installation-guide:installing-che.adoc[] link-postgres-dockerfile-location: https://github.com/eclipse-che/che-server/tree/main/dockerfiles/postgres link-server-identity-provider-dockerfile-location: https://github.com/eclipse-che/che-server/tree/main/dockerfiles/keycloak @@ -96,7 +96,7 @@ asciidoc: prod-upstream: Eclipse{nbsp}Che prod-url: https://che-host:che-port prod-ver-major: "7" - prod-ver-patch: "7.38.1" + prod-ver-patch: "7.38.2" prod-ver: "7.38" prod-workspace: che-ws prod: Eclipse Che From 613a4d893196172354bcbe8bd6ec7527ba3399bc Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 18 Nov 2021 09:54:27 +0100 Subject: [PATCH 13/25] Update modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc Thank you. Co-authored-by: Mykola Morhun --- ...c_disabling-readiness-init-containers-for-olm-installer.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc index 2a77b5e7cc..f61b580abe 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc @@ -31,7 +31,7 @@ $ {orch-cli} get subscription -n {prod-namespace} -o yaml | ---- $ {orch-cli} edit csv __ -n {prod-namespace} ---- -. Remove the following environment variable to (from) the Operator Deployment spec: +. Remove the following environment variable from the Operator Deployment spec: + [source,yaml,subs="+quotes,+attributes"] ---- From f5e9c7489bb83707fd8f932e760cdcd9c518ad7f Mon Sep 17 00:00:00 2001 From: tstastna <78429689+tstastna@users.noreply.github.com> Date: Thu, 4 Nov 2021 18:34:42 +0100 Subject: [PATCH 14/25] fix: Fix outdated links (#2154) * Fix broken links * Remove changes * Remove changes * Fix conversion to lowercase --- tools/environment_docs_gen.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/environment_docs_gen.sh b/tools/environment_docs_gen.sh index 04282b7044..1732c81dcc 100755 --- a/tools/environment_docs_gen.sh +++ b/tools/environment_docs_gen.sh @@ -61,9 +61,10 @@ parse_content() { TOPIC="${LINE//#}" # read topic, stripping #s TOPIC="${TOPIC/ }" # trim first space TOPICID="${TOPIC// /-}" # create topic ID - TOPICID="$(sed 's|-\{2,\}|-|g; s|[\"\/=,.<>?!;:()*]||g; s|\(.*\)|[id="\L\1"]|;s|prod-short|prod-id-short|' <<< $TOPICID)" + TOPICID="$(sed 's|-\{2,\}|-|g; s|[\"\/=,.<>?!;:()*]||g; s|\(.*\)|[id="\1"]|;s|prod-short|prod-id-short|' <<< $TOPICID)" # replace spaces with dashes, create topic ID, convert to lowercase chars # remove non alpha-num, wrap in AsciiDoc ID markup + TOPICID=${TOPICID,,} echo " Found begin of topic: $TOPIC" >&2 BUFF="${BUFF}${TOPICID}$NEWLINE= ${TOPIC}$NEWLINEx2.${TOPIC} $TABLE_HEADER $NEWLINE" # new topic and table header elif [[ $LINE == '#'* ]] && [[ -n $TOPIC ]]; then # line starting with single # means property description (can be multiline) From 409b94837f6ebe3635e1a4541496810f6da311d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 8 Nov 2021 16:35:22 +0100 Subject: [PATCH 15/25] Fix xref. (#2158) Remove duplicate pages and partials that are unused in the navigation. --- .../pages/managing-backups-using-chectl.adoc | 7 -- .../pages/managing-backups-using-chectl.adoc | 7 -- .../pages/managing-backups-using-cli.adoc | 2 +- ...ging-backups-through-custom-resources.adoc | 2 +- .../proc_managing-backups-using-chectl.adoc | 77 ------------------- 5 files changed, 2 insertions(+), 93 deletions(-) delete mode 100644 modules/administration-guide/pages/managing-backups-using-chectl.adoc delete mode 100644 modules/administration-guide/pages/managing-backups-using-chectl.adoc delete mode 100644 modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc diff --git a/modules/administration-guide/pages/managing-backups-using-chectl.adoc b/modules/administration-guide/pages/managing-backups-using-chectl.adoc deleted file mode 100644 index 1085a4f1b9..0000000000 --- a/modules/administration-guide/pages/managing-backups-using-chectl.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[id="managing-backups-using-chectl"] -// = Managing backups using chectl -:navtitle: Managing backups using chectl -:keywords: administration-guide, backup, recovery -:page-aliases: .:managing-backups-using-chectl - -include::partial$proc_managing-backups-using-chectl.adoc[] diff --git a/modules/administration-guide/pages/managing-backups-using-chectl.adoc b/modules/administration-guide/pages/managing-backups-using-chectl.adoc deleted file mode 100644 index 1085a4f1b9..0000000000 --- a/modules/administration-guide/pages/managing-backups-using-chectl.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[id="managing-backups-using-chectl"] -// = Managing backups using chectl -:navtitle: Managing backups using chectl -:keywords: administration-guide, backup, recovery -:page-aliases: .:managing-backups-using-chectl - -include::partial$proc_managing-backups-using-chectl.adoc[] diff --git a/modules/administration-guide/pages/managing-backups-using-cli.adoc b/modules/administration-guide/pages/managing-backups-using-cli.adoc index 39b4ba304a..dba9d41e7a 100644 --- a/modules/administration-guide/pages/managing-backups-using-cli.adoc +++ b/modules/administration-guide/pages/managing-backups-using-cli.adoc @@ -2,6 +2,6 @@ // = Managing backups through cli :navtitle: Managing backups using CLI :keywords: administration-guide, backup, recovery -:page-aliases: .:managing-backups-through-cli +:page-aliases: .:managing-backups-through-cli, managing-backups-using-chectl include::partial$proc_managing-backups-through-cli.adoc[] diff --git a/modules/administration-guide/partials/proc_managing-backups-through-custom-resources.adoc b/modules/administration-guide/partials/proc_managing-backups-through-custom-resources.adoc index 5836d952f6..f480bfb75f 100644 --- a/modules/administration-guide/partials/proc_managing-backups-through-custom-resources.adoc +++ b/modules/administration-guide/partials/proc_managing-backups-through-custom-resources.adoc @@ -69,7 +69,7 @@ spec: [NOTE] ==== -The approach described in this chapter can not be used to recover to a different version of {prod-short}. To recover {prod-short} to another version, use the `{prod-cli}` tool. See the xref:managing-backups-using-chectl.adoc[] chapter for more information. +The approach described in this chapter can not be used to recover to a different version of {prod-short}. To recover {prod-short} to another version, use the `{prod-cli}` tool. See the xref:managing-backups-using-cli.adoc[] chapter for more information. ==== . Create a new object of `CheClusterRestore` to recover a {prod-short} installation from a backup: diff --git a/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc b/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc deleted file mode 100644 index 2662534d75..0000000000 --- a/modules/administration-guide/partials/proc_managing-backups-using-chectl.adoc +++ /dev/null @@ -1,77 +0,0 @@ -[id="managing-backups-using-chectl_{context}"] -= Managing backups using {prod-cli} - -The following section describes how to create and use backups of a {prod-short} installation to perform a recovery or a rollback to a previous version using `{prod-cli}`. - -include::partial$snip_internal-backup-server-warning.adoc[] - -.Prerequisites - -* xref:setup-backup-server.adoc[Set up a backup server]. - -* xref:configuring-chectl-to-use-backup-server.adoc[Configure {prod-cli} to use the backup server]. - -.Procedure - -* xref:creating-a-new-backup-using-{prod-cli}_{context}[] - -* xref:restoring-from-a-backup-using-{prod-cli}_{context}[] - - -[id="creating-a-new-backup-using-{prod-cli}_{context}"] -== Creating a {prod-short} backup - -. To create a backup snapshot and send it to a pre-configured backup server: -+ -[source,shell,subs="+quotes,+attributes"] ----- -$ {prod-cli} server:backup --repository-url=____ --repository-password=____ ----- -+ -* You can create other backups to the same backup server using the `server:backup` command with no arguments. -* Using the `server:backup` command with no arguments for the first time will configure and use an internal backup server. - - -[id="restoring-from-a-backup-using-{prod-cli}_{context}"] -== Restoring {prod-short} from a backup - -A {prod-short} administrator can use an existing snapshot of a particular {prod-short} version to restore a desired state or version. The following instructions describe several variations of the restoration command. Adjust the command arguments according to your use case. - -* To restore the previous functional state of the same version of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --repository-url=____ --repository-password=____ --snapshot-id=____ ----- - - -* To roll back to a version different from the current version of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --version=____ --snapshot-id=____ --repository-url=____ --repository-password=____ ----- -+ -This performs a version rollback and restores a snapshot made from a previous version of {prod-short}. The provided snapshot must be created from the version of {prod-short} to which you want to roll back. -+ -NOTE: If you have a dedicated backup repository for each {prod-short} version and want to use the most recent backup for the version, you can provide the `latest` argument as a snapshot ID. By doing so, the `latest` argument will be converted to the latest known ID in the given repository, which will be then used by the {prod-short} Operator to recover. - - -* To restore a state described by an existing backup Custom Resource: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --backup-cr-name=____ ----- - - -* To roll back a version upgrade of {prod-short}: -+ -[subs="+quotes,+attributes"] ----- -$ {prod-cli} server:restore --rollback ----- -+ -This recovers the version that {prod-short} was using before upgrading to a later version. -+ -NOTE: {prod-short} Operator automatically creates a backup before every upgrade. From 17fb18ccccff0f33d1b7f16cbe44a107208afd47 Mon Sep 17 00:00:00 2001 From: tstastna <78429689+tstastna@users.noreply.github.com> Date: Tue, 9 Nov 2021 14:08:04 +0100 Subject: [PATCH 16/25] fix: Mounting secrets defined in a devfile (#2144) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- ...-secrets-as-file-or-env-variable-in-workspace-container.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/end-user-guide/partials/assembly_mounting-secrets-as-file-or-env-variable-in-workspace-container.adoc b/modules/end-user-guide/partials/assembly_mounting-secrets-as-file-or-env-variable-in-workspace-container.adoc index af3e8146f8..c0ff2b5896 100644 --- a/modules/end-user-guide/partials/assembly_mounting-secrets-as-file-or-env-variable-in-workspace-container.adoc +++ b/modules/end-user-guide/partials/assembly_mounting-secrets-as-file-or-env-variable-in-workspace-container.adoc @@ -11,6 +11,8 @@ Secrets are {platforms-name} objects that store sensitive data such as user name Users can mount a secret that contains sensitive data in a workspace container. This reapplies the stored data from the secret automatically for every newly created workspace. As a result, the user does not have to provide these credentials and configuration settings manually. +Do not mount secrets that you define in a devfile. + The following section describes how to automatically mount a {platforms-name} secret in a workspace container and create permanent mount points for components such as: * Maven configuration, the `settings.xml` file From aa7d75fd49c09a3c46ebb50116628383408a1246 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Nov 2021 14:37:56 +0100 Subject: [PATCH 17/25] fix: vale errors and warnings (#2151) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký Co-authored-by: Nick Boldt --- .vale/styles/IBM/README-proselint.md | 1 + .vale/styles/IBM/README-write-good.md | 1 + .vale/styles/IBM/README.md | 5 ++-- CONTRIBUTING.adoc | 4 ++- .../partials/con_a-workspace-example.adoc | 16 ++++-------- ...con_define-backup-server-for-operator.adoc | 6 ++--- .../partials/con_super-privileged-mode.adoc | 6 ++--- ...-che-to-work-with-external-PostgreSQL.adoc | 2 +- .../proc_configuring-gitlab-servers.adoc | 2 +- .../ref_grafana-dashboards-for-che.adoc | 6 ++--- .../partials/ref_managesystem-permission.adoc | 26 +++++++++---------- ...-from-openshift-developer-perspective.adoc | 2 +- ...oc_accessing-a-git-repository-via-ssh.adoc | 2 +- ...ion-using-the-workspace-configuration.adoc | 2 +- ...j-idea-community-or-pycharm-community.adoc | 2 +- .../proc_troubleshooting-slow-workspaces.adoc | 1 - ...the-state-of-the-yaml-language-server.adoc | 2 +- ...tput-plug-in-logs-in-the-output-panel.adoc | 2 +- .../ref_che-theia-plug-in-metadata.adoc | 4 +-- .../partials/ref_devfile-reference.adoc | 18 ++----------- .../proc_creating-a-telemetry-plugin.adoc | 2 +- .../extensions/partials/proc_java-lombok.adoc | 2 +- .../partials/ref_about-hosted-che.adoc | 2 +- ...ef_hosted-che-faq-and-troubleshooting.adoc | 2 +- .../proc_configuring-che-hostname.adoc | 8 +++--- ...stalling-dns-on-google-cloud-platform.adoc | 2 +- ..._using-kubespray-to-set-up-kubernetes.adoc | 2 +- 27 files changed, 57 insertions(+), 73 deletions(-) diff --git a/.vale/styles/IBM/README-proselint.md b/.vale/styles/IBM/README-proselint.md index 402076869f..b08cef98d5 100644 --- a/.vale/styles/IBM/README-proselint.md +++ b/.vale/styles/IBM/README-proselint.md @@ -1,3 +1,4 @@ + Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross All rights reserved. diff --git a/.vale/styles/IBM/README-write-good.md b/.vale/styles/IBM/README-write-good.md index 3edcc9b376..ba919b6fe1 100644 --- a/.vale/styles/IBM/README-write-good.md +++ b/.vale/styles/IBM/README-write-good.md @@ -1,3 +1,4 @@ + Based on [write-good](https://github.com/btford/write-good). > Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. diff --git a/.vale/styles/IBM/README.md b/.vale/styles/IBM/README.md index 8756d3453e..35f651fa41 100644 --- a/.vale/styles/IBM/README.md +++ b/.vale/styles/IBM/README.md @@ -1,4 +1,5 @@ -IBM styleguide was created by the IBM : https://www.ibm.com/developerworks/library/styleguidelines/index.html -All rights for the styleguide belong to IBM. + +IBM style guide was created by IBM: https://www.ibm.com/developerworks/library/styleguidelines/index.html +All rights for the style guide belong to IBM. Rules were compiled at: https://github.com/errata-ai/IBM diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 267af61628..bb01d2551e 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -122,6 +122,8 @@ To build the Eclipse Che documentation from a Che workspace, follow the steps be .Procedure +pass:[] + . To build the documentation and start the preview server: open _My Workspace / User Runtimes / che-docs / Start preview server_. . To navigate to the preview, open _Preview_. @@ -143,7 +145,6 @@ To build the Eclipse Che documentation from a Che workspace, follow the steps be .. The tool `+test-adoc+` tests the file and produces some output. - [id="creating-a-new-topic-using-che"] == Creating a new topic using Che @@ -180,6 +181,7 @@ Eclipse Che4z, OpenShift Connector. . The file is generated in the `+src/main/pages-che-7//+` directory and the script displays related information. +pass:[] == Adding images diff --git a/modules/administration-guide/partials/con_a-workspace-example.adoc b/modules/administration-guide/partials/con_a-workspace-example.adoc index 3bcf47ad29..7acccd1352 100644 --- a/modules/administration-guide/partials/con_a-workspace-example.adoc +++ b/modules/administration-guide/partials/con_a-workspace-example.adoc @@ -9,9 +9,6 @@ The following devfile defines the {prod-short} workspace: include::example$snip_a-{project-context}-workspace-example.adoc[] -pass:[] - -pass:[] This table provides the memory requirements for each workspace component: @@ -24,22 +21,22 @@ This table provides the memory requirements for each workspace component: |Default memory request |Workspace -|theia-ide (default `cheEditor`) +|`theia-ide` (default `cheEditor`) |512 MiB |512 MiB |Workspace -|machine-exec (default `chePlugin`) +|`machine-exec` (default `chePlugin`) |128 MiB |32 MiB |Workspace -|vscode-typescript (`chePlugin`) +|`vscode-typescript` (`chePlugin`) |512 MiB |512 MiB |Workspace -|nodejs (`dockerimage`) +|`nodejs` (`dockerimage`) |1 GiB |512 MiB @@ -53,15 +50,12 @@ This table provides the memory requirements for each workspace component: >s|1.38 GiB |=== -pass:[] - -pass:[] * The `theia-ide` and `machine-exec` components are implicitly added to the workspace, even when not included in the devfile. * The resources required by `machine-exec` are the default for `chePlugin`. * The resources for `theia-ide` are specifically set in the `cheEditor` `meta.yaml` to *512 MiB* as `memoryLimit`. * The Typescript VS Code extension has also overridden the default memory limits. In its `meta.yaml` file, the limits are explicitly specified to *512 MiB*. -* {prod-short} is applying the defaults for the dockerimage component type: a memory limit of *1 GiB* and a memory request of *512 MiB*. +* {prod-short} is applying the defaults for the `dockerimage` component type: a memory limit of *1 GiB* and a memory request of *512 MiB*. * The JWT container requires *128 MiB* of memory. Adding all together results in *1.38 GiB* of memory requests with a *2.25 GiB* limit. diff --git a/modules/administration-guide/partials/con_define-backup-server-for-operator.adoc b/modules/administration-guide/partials/con_define-backup-server-for-operator.adoc index 5d0ce79818..a5fa4110eb 100644 --- a/modules/administration-guide/partials/con_define-backup-server-for-operator.adoc +++ b/modules/administration-guide/partials/con_define-backup-server-for-operator.adoc @@ -37,7 +37,7 @@ spec: ---- <1> Optional property that specifies the protocol to be used. The default value is `https` with `http` as the second allowed option. -<2> Backup server hostname. +<2> Backup server host name. <3> Optional property that specifies the port on which the backup server is running. The default value is `8000`. <4> Path on the backup server where the backup snapshots are stored. <5> Secret name containing a repository password, stored in the `repo-password` field. If the secret contains only one field, its name is arbitrary. The password is used to encrypt and decrypt backup snapshots data. @@ -64,7 +64,7 @@ spec: ---- <1> Optional property that specifies the protocol to be used. The default value is `https` with `http` as the second allowed option. -<2> Optional property that specifies the S3 hostname. The default value is `s3.amazonaws.com`. +<2> Optional property that specifies the S3 host name. The default value is `s3.amazonaws.com`. <3> Optional property that specifies the port on which the backup server is running. <4> The name of the bucket resource where the backup snapshots are stored. The bucket resource must be manually pre-created. <5> The name of the secret containing a repository password, stored in the `repo-password` field. If the secret contains only one field, this name is arbitrary. The password is used to encrypt and decrypt backup snapshots data. @@ -91,7 +91,7 @@ spec: ---- <1> User name on the remote server to login with using the SSH protocol. -<2> Remote server hostname. +<2> Remote server host name. <3> Optional property that specifies the port on which an SFTP server is running. The default value is `22`. <4> Absolute or relative path on the server where backup snapshots are stored. <5> The name of the secret containing a repository password, stored in the `repo-password` field. If the secret contains only one field, this name is arbitrary. The password is used to encrypt and decrypt backup snapshots data. diff --git a/modules/administration-guide/partials/con_super-privileged-mode.adoc b/modules/administration-guide/partials/con_super-privileged-mode.adoc index ac41b644a8..1207c1fea4 100644 --- a/modules/administration-guide/partials/con_super-privileged-mode.adoc +++ b/modules/administration-guide/partials/con_super-privileged-mode.adoc @@ -10,7 +10,7 @@ The *super-privileged* mode is disabled by default. To change to the *super-priv [options="header"] |==== |Path|HTTP Method|Description -|/workspace/namespace/{namespace:.*}|GET|Get all workspaces for the given {orch-namespace}. -|/workspace/\{id}|DELETE|Stop a workspace. -|/workspace/\{key:.*}|GET|Get a workspace by key. +|`/workspace/namespace/{namespace:.*}`|GET|Get all workspaces for the given {orch-namespace}. +|`/workspace/\{id}`|DELETE|Stop a workspace. +|`/workspace/\{key:.*}`|GET|Get a workspace by key. |==== diff --git a/modules/administration-guide/partials/proc_configuring-che-to-work-with-external-PostgreSQL.adoc b/modules/administration-guide/partials/proc_configuring-che-to-work-with-external-PostgreSQL.adoc index 0b09a6ad48..bed1b1e451 100644 --- a/modules/administration-guide/partials/proc_configuring-che-to-work-with-external-PostgreSQL.adoc +++ b/modules/administration-guide/partials/proc_configuring-che-to-work-with-external-PostgreSQL.adoc @@ -62,7 +62,7 @@ spec: auth: identityProviderPostgresSecret: <5> ---- -<1> External database hostname +<1> External database host name <2> External database port <3> Secret name with {prod-short} server database credentials <4> {prod-short} server database name diff --git a/modules/administration-guide/partials/proc_configuring-gitlab-servers.adoc b/modules/administration-guide/partials/proc_configuring-gitlab-servers.adoc index 73a76cb2a4..da248795f5 100644 --- a/modules/administration-guide/partials/proc_configuring-gitlab-servers.adoc +++ b/modules/administration-guide/partials/proc_configuring-gitlab-servers.adoc @@ -2,7 +2,7 @@ [id="configuring_gitlab_servers_{context}"] = Configuring GitLab servers -To use a GitLab server as a project sources supplier, register the GitLab server URL with {prod-short} using the `CHE_INTEGRATION_GITLAB_SERVER__ENDPOINTS` property and specify the hostname of the server to register. +To use a GitLab server as a project sources supplier, register the GitLab server URL with {prod-short} using the `CHE_INTEGRATION_GITLAB_SERVER__ENDPOINTS` property and specify the host name of the server to register. .Example ---- diff --git a/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc b/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc index 6df1c59477..a896df75dc 100644 --- a/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc +++ b/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc @@ -52,7 +52,7 @@ image::monitoring/monitoring-che-che-server-dashboard-executors-panel-1.png[The * *Threads running* - the number of threads that are not terminated aka alive. May include threads that are in a waiting or blocked state. * *Threads terminated* - the number of threads that was finished its execution. * *Threads created* - number of threads created by thread factory for given executor service. -* *Created thread/minute* - Speed of thread creating for the given executor service. +* *Created thread per minute* - Speed of thread creating for the given executor service. .The *Executors* panel, part 2 image::monitoring/monitoring-che-che-server-dashboard-executors-panel-2.png[The *Executors* panel part 2, link="../_images/monitoring/monitoring-che-che-server-dashboard-executors-panel-2.png"] @@ -66,9 +66,9 @@ image::monitoring/monitoring-che-che-server-dashboard-executors-panel-2.png[The image::monitoring/monitoring-che-che-server-dashboard-executors-panel-3.png[link="../_images/monitoring/monitoring-che-che-server-dashboard-executors-panel-3.png"] * *Rejected task* - the number of tasks that were rejected from execution. -* *Rejected task/minute* - the speed of task rejections +* *Rejected task per minute* - the speed of task rejections * *Completed tasks* - the number of completed tasks -* *Completed tasks/minute* - the speed of task execution +* *Completed tasks per minute* - the speed of task execution .The *Executors* panel, part 4 image::monitoring/monitoring-che-che-server-dashboard-executors-panel-4.png[link="../_images/monitoring/monitoring-che-che-server-dashboard-executors-panel-4.png"] diff --git a/modules/administration-guide/partials/ref_managesystem-permission.adoc b/modules/administration-guide/partials/ref_managesystem-permission.adoc index e0b6ac1e48..efc4cb8ba1 100644 --- a/modules/administration-guide/partials/ref_managesystem-permission.adoc +++ b/modules/administration-guide/partials/ref_managesystem-permission.adoc @@ -8,17 +8,17 @@ Users with the *manageSystem* permission have access to the following services: [options="header"] |==== |Path|HTTP Method|Description -|/resource/free/|GET|Get free resource limits. -|/resource/free/\{accountId}|GET|Get free resource limits for the given account. -|/resource/free/\{accountId}|POST|Edit free resource limit for the given account. -|/resource/free/\{accountId}|DELETE|Remove free resource limit for the given account. -|/installer/|POST|Add installer to the registry. -|/installer/\{key}|PUT|Update installer in the registry. -|/installer/\{key}|DELETE|Remove installer from the registry. -|/logger/|GET|Get logging configurations in the {prod-short} server. -|/logger/\{name}|GET|Get configurations of logger by its name in the {prod-short} server. -|/logger/\{name}|PUT|Create logger in the {prod-short} server. -|/logger/\{name}|POST|Edit logger in the {prod-short} server. -|/resource/\{accountId}/details|GET|Get detailed information about resources for the given account. -|/system/stop|POST|Shutdown all system services, prepare {prod-short} to stop. +|`/resource/free/`|GET|Get free resource limits. +|`/resource/free/\{accountId}`|GET|Get free resource limits for the given account. +|`/resource/free/\{accountId}`|POST|Edit free resource limit for the given account. +|`/resource/free/\{accountId}`|DELETE|Remove free resource limit for the given account. +|`/installer/`|POST|Add installer to the registry. +|`/installer/\{key}`|PUT|Update installer in the registry. +|`/installer/\{key}`|DELETE|Remove installer from the registry. +|`/logger/`|GET|Get logging configurations in the {prod-short} server. +|`/logger/\{name}`|GET|Get configurations of logger by its name in the {prod-short} server. +|`/logger/\{name}`|PUT|Create logger in the {prod-short} server. +|`/logger/\{name}`|POST|Edit logger in the {prod-short} server. +|`/resource/\{accountId}/details`|GET|Get detailed information about resources for the given account. +|`/system/stop`|POST|Shutdown all system services, prepare {prod-short} to stop. |==== diff --git a/modules/end-user-guide/partials/assembly_accessing-che-from-openshift-developer-perspective.adoc b/modules/end-user-guide/partials/assembly_accessing-che-from-openshift-developer-perspective.adoc index 2c4bb8f14a..a49baa5469 100644 --- a/modules/end-user-guide/partials/assembly_accessing-che-from-openshift-developer-perspective.adoc +++ b/modules/end-user-guide/partials/assembly_accessing-che-from-openshift-developer-perspective.adoc @@ -12,7 +12,7 @@ The OpenShift Container Platform web console provides two perspectives; the *Adm The Developer perspective provides workflows specific to developer use cases, such as the ability to: -* Create and deploy applications on OpenShift Container Platform by importing existing codebases, images, and dockerfiles. +* Create and deploy applications on OpenShift Container Platform by importing existing codebases, images, and Dockerfiles. * Visually interact with applications, components, and services associated with them within a project and monitor their deployment and build status. diff --git a/modules/end-user-guide/partials/proc_accessing-a-git-repository-via-ssh.adoc b/modules/end-user-guide/partials/proc_accessing-a-git-repository-via-ssh.adoc index bc6b84e35a..d5e337e67f 100644 --- a/modules/end-user-guide/partials/proc_accessing-a-git-repository-via-ssh.adoc +++ b/modules/end-user-guide/partials/proc_accessing-a-git-repository-via-ssh.adoc @@ -28,7 +28,7 @@ The *command palette* can be also activated by pressing kbd:[Ctrl+Shift+p] (or k ** Search for *SSH: generate key pair for particular host* by entering `generate` into the search box and pressing kbd:[Enter] once filled. -** Provide the hostname for the SSH key pair such as, for example, `github.com`. +** Provide the host name for the SSH key pair such as, for example, `github.com`. + The SSH key pair is generated. diff --git a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc index d1c3d9f33c..2709d54c7e 100644 --- a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc +++ b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc @@ -30,7 +30,7 @@ The *Workspace ____* window is opened showing the details of the - type: chePlugin id: <1> ---- -<1> ID format: _//_ +<1> ID format: `_//_` + {prod-short} automatically adds the other fields to the new component. + diff --git a/modules/end-user-guide/partials/proc_building-an-image-for-intellij-idea-community-or-pycharm-community.adoc b/modules/end-user-guide/partials/proc_building-an-image-for-intellij-idea-community-or-pycharm-community.adoc index 43fd5ba0b2..feb6042bb5 100644 --- a/modules/end-user-guide/partials/proc_building-an-image-for-intellij-idea-community-or-pycharm-community.adoc +++ b/modules/end-user-guide/partials/proc_building-an-image-for-intellij-idea-community-or-pycharm-community.adoc @@ -50,7 +50,7 @@ $ ./projector.sh build $ ./projector.sh run ---- -. Publish the image to a registry accessible by {prod-short}, and remember the location: __/:__. +. Publish the image to a registry accessible by {prod-short}, and remember the location: `__/:__`. . Create a `+meta.yaml+` file with the following content: + diff --git a/modules/end-user-guide/partials/proc_troubleshooting-slow-workspaces.adoc b/modules/end-user-guide/partials/proc_troubleshooting-slow-workspaces.adoc index e64adbbeb2..7139d8c92f 100644 --- a/modules/end-user-guide/partials/proc_troubleshooting-slow-workspaces.adoc +++ b/modules/end-user-guide/partials/proc_troubleshooting-slow-workspaces.adoc @@ -10,7 +10,6 @@ Sometimes, workspaces can take a long time to start. Tuning can reduce this star This section includes several tuning options for starting workspaces faster or improving workspace runtime performance. - [id="improving-workspace-start-time_{context}"] == Improving workspace start time diff --git a/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.adoc b/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.adoc index 447f031570..2cb3e5f23c 100644 --- a/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.adoc +++ b/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.adoc @@ -13,6 +13,6 @@ Check if the container running the YAML plug-in is running the YAML language ser . Verify that a command `node ********/server.js` is running. + -image::logs/verifying-the-state-of-the-yaml-language-server.png[] +image::logs/verifying-the-state-of-the-yaml-language-server.png[Verifying the state of the YAML language server] The `node ********/server.js` running in the container indicates that the language server is running. If it is not running, the language server has not started inside the container. In this case, see xref:viewing-che-workspaces-logs.adoc#checking-important-logs_{context}[Checking important logs]. diff --git a/modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc b/modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc index b6c1c2aa0f..a4c8f23d12 100644 --- a/modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc +++ b/modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc @@ -7,4 +7,4 @@ This section describes how to view `NetcoredebugOutput` plug-in logs in the *Out * Open the *Debug* console. + -image::logs/viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.png[] +image::logs/viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.png[Viewing NetcoredebugOutput plug-in logs in the *Output* panel] diff --git a/modules/end-user-guide/partials/ref_che-theia-plug-in-metadata.adoc b/modules/end-user-guide/partials/ref_che-theia-plug-in-metadata.adoc index 8ebfaee776..f4be37edbf 100644 --- a/modules/end-user-guide/partials/ref_che-theia-plug-in-metadata.adoc +++ b/modules/end-user-guide/partials/ref_che-theia-plug-in-metadata.adoc @@ -36,8 +36,8 @@ endif::[] * autoMigrate - boolean * migrateTo - new `org/plugin-id/version`, for example `redhat/vscode-apache-camel/latest` -|`firstPublicationDate`| Not required to be in YAML; if it is not included, the plug-in registry dockerimage build generates it -|`latestUpdateDate`| Not required to be in YAML; if it is not included, the plug-in registry dockerimage build generates it +|`firstPublicationDate`| Not required to be in YAML; if it is not included, the plug-in registry `dockerimage` build generates it +|`latestUpdateDate`| Not required to be in YAML; if it is not included, the plug-in registry `dockerimage` build generates it |`icon`| URL of an SVG or PNG icon |`name`| Name (no spaces allowed), must match [-a-z0-9] |`publisher`| Name of the publisher, must match [-a-z0-9] diff --git a/modules/end-user-guide/partials/ref_devfile-reference.adoc b/modules/end-user-guide/partials/ref_devfile-reference.adoc index 8de4fbd56a..4941ab99d4 100644 --- a/modules/end-user-guide/partials/ref_devfile-reference.adoc +++ b/modules/end-user-guide/partials/ref_devfile-reference.adoc @@ -1,9 +1,3 @@ -pass:[] - -pass:[] - -pass:[] - // Module included in the following assemblies: // // configuring-a-workspace-using-a-devfile @@ -83,7 +77,7 @@ Project source consists of two mandatory values: `type` and `location`. `github`:: Same as `git` but for projects hosted on link:https://github.com/[GitHub] only. Use `git` for projects that do not use GitHub-specific features. -`zip`:: Projects with sources in a ZIP archive. Location points to a ZIP file. +`zip`:: Projects with sources in a `.zip` archive. Location points to a `.zip` file. === Project-source type: git @@ -240,10 +234,6 @@ Preferences may also be specified as an array: go.lintFlags: ["--enable-all", "--new"] ---- -pass:[] - -pass:[] - === Component type: `kubernetes` A complex component type that allows to apply configuration from a list of {orch-name} components. @@ -346,15 +336,11 @@ To specify a project sources directory mount into container(s), use the `mountSo mountSources: true ---- -pass:[] - -pass:[] - If enabled, project sources mounts will be applied to every container of the given component. This parameter is also applicable for `chePlugin` type components. [id="component-type-dockerimage_{context}"] -=== Component type: dockerimage +=== Component type: `dockerimage` A component type that allows to define a container image-based configuration of a container in a workspace. The `dockerimage` type of component brings in custom tools into the workspace. The component is identified by its image. diff --git a/modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc b/modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc index 5e30f28bf0..6c50eacb79 100644 --- a/modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc +++ b/modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc @@ -51,7 +51,7 @@ $ docker build -t registry/organization/che-workspace-telemetry-example:latest $ docker push registry/organization/che-workspace-telemetry-example:latest ---- -In `manifest.yaml`, replace the `image` and `host` fields to match the image you pushed, and the public hostname of your {platforms-name} cluster. Then run: +In `manifest.yaml`, replace the `image` and `host` fields to match the image you pushed, and the public host name of your {platforms-name} cluster. Then run: [subs="+quotes"] ---- diff --git a/modules/extensions/partials/proc_java-lombok.adoc b/modules/extensions/partials/proc_java-lombok.adoc index ec11afeb12..019c9a784e 100644 --- a/modules/extensions/partials/proc_java-lombok.adoc +++ b/modules/extensions/partials/proc_java-lombok.adoc @@ -34,7 +34,7 @@ To enable Lombok in a {prod-short} workspace, see the instructions below. . Verify that the Class outline contains the Lombok generated methods. + -image::lombok/lombok.png[] +image::lombok/lombok.png[Lombok] .Additional resources diff --git a/modules/hosted-che/partials/ref_about-hosted-che.adoc b/modules/hosted-che/partials/ref_about-hosted-che.adoc index c7a5ccbd22..80d8b06824 100644 --- a/modules/hosted-che/partials/ref_about-hosted-che.adoc +++ b/modules/hosted-che/partials/ref_about-hosted-che.adoc @@ -19,7 +19,7 @@ image::hosted-che/get-started-product-and-community-devfiles.png[] [IMPORTANT] ==== -Eclipse Che and Red Hat CodeReady Workspaces share all of the features - all the product's functionality is available in the project and vice versa. However, not all the upstream plugins are available in the CodeReady Workspaces. To use an unsupported plugin inside the CodeReady Workspaces, one must explicitly point to the raw `meta.yaml` of the plugin from the devfile. The procedure is described in the xref:end-user-guide:adding-a-vs-code-extension-to-a-workspace.adoc#adding-the-vs-code-extension-using-the-workspace-configuration_che[Adding a VS Code extension using the workspace configuration] section. +Eclipse Che and Red Hat CodeReady Workspaces share all the features - all the product's functionality is available in the project and vice versa. However, not all the upstream plugins are available in the CodeReady Workspaces. To use an unsupported plugin inside the CodeReady Workspaces, one must explicitly point to the raw `meta.yaml` of the plugin from the devfile. The procedure is described in the xref:end-user-guide:adding-a-vs-code-extension-to-a-workspace.adoc#adding-the-vs-code-extension-using-the-workspace-configuration_che[Adding a VS Code extension using the workspace configuration] section. ==== [id="terms-of-service_{context}"] diff --git a/modules/hosted-che/partials/ref_hosted-che-faq-and-troubleshooting.adoc b/modules/hosted-che/partials/ref_hosted-che-faq-and-troubleshooting.adoc index db223a1fdf..aca719e2fb 100644 --- a/modules/hosted-che/partials/ref_hosted-che-faq-and-troubleshooting.adoc +++ b/modules/hosted-che/partials/ref_hosted-che-faq-and-troubleshooting.adoc @@ -19,7 +19,7 @@ To authenticate to link:https://workspaces.openshift.com[Red Hat Developer Sandb .Telemetry -Telemetry is enabled in Eclipse Che hosted by Red Hat, so Woopra / Segment tracking scripts must be explicitly allowed in case being blocked by a browser extension: +Telemetry is enabled in Eclipse Che hosted by Red Hat, so Woopra or Segment tracking scripts must be explicitly allowed in case being blocked by a browser extension: - https://api.segment.io/v1/t - https://static.woopra.com/js/w.js diff --git a/modules/installation-guide/partials/proc_configuring-che-hostname.adoc b/modules/installation-guide/partials/proc_configuring-che-hostname.adoc index 543e7ad6dc..41014574e0 100644 --- a/modules/installation-guide/partials/proc_configuring-che-hostname.adoc +++ b/modules/installation-guide/partials/proc_configuring-che-hostname.adoc @@ -1,11 +1,11 @@ :parent-context-of-customize-chehost: {context} [id="customize-chehost_{context}"] -= Configuring {prod} server hostname += Configuring {prod} server host name :context: customize-chehost -This procedure describes how to configure {prod-short} to use custom hostname. +This procedure describes how to configure {prod-short} to use custom host name. .Prerequisites @@ -14,7 +14,7 @@ This procedure describes how to configure {prod-short} to use custom hostname. IMPORTANT: To generate the pair of a private key and certificate, the same certification authority (CA) must be used as for other {prod-short} hosts. -IMPORTANT: Ask a DNS provider to point the custom hostname to the cluster ingress. +IMPORTANT: Ask a DNS provider to point the custom host name to the cluster ingress. .Procedure @@ -48,7 +48,7 @@ spec: cheHost: <1> cheHostTLSSecret: <2> ---- -<1> Custom {prod} server hostname +<1> Custom {prod} server host name <2> The TLS secret name . If {prod-short} has been already deployed, wait until the rollout of all {prod-short} components finishes. 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 1fa842200c..db0a3a85aa 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 @@ -7,7 +7,7 @@ .Procedure -. 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. +. 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[Creating DNS zone on Google Cloud Platform,link="../_images/installation/creating-dns-zone-on-gcp.png"] + 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 162ccffbfb..a7b452f9f6 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 @@ -38,7 +38,7 @@ $ ssh-keygen -b 2048 -t rsa -f /home//.ssh/id_rsa -q -N "" * Copy your public key(s) on nodes + -Copy your public key(s) in the ~/.ssh/authorized_keys file of the user accounts you will use on each node for deployment. +Copy your public key(s) in the `~/.ssh/authorized_keys` file of the user accounts you will use on each node for deployment. You will be prompted twice for the password corresponding to account, the first time for the public key upload using SSH and the second time for adding the public key in the authorized_keys file. + ---- From 4035f97b8da3a585a72f0276a694084237edfbe9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 10 Nov 2021 13:43:01 +0100 Subject: [PATCH 18/25] fix: abort previous build on Jenkins (#2162) --- Jenkinsfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index 4079f1154d..3e101c13eb 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -86,7 +86,7 @@ spec: options { buildDiscarder(logRotator(numToKeepStr: '5')) checkoutToSubdirectory('che-docs') - disableConcurrentBuilds() + disableConcurrentBuilds(abortPrevious: true) timeout(time: 15, unit: 'MINUTES') } From 44cf4b50530103bbe55ae086232db8dd0412381e Mon Sep 17 00:00:00 2001 From: che-bot <39771996+che-bot@users.noreply.github.com> Date: Tue, 16 Nov 2021 09:41:35 +0100 Subject: [PATCH 19/25] release: Bump version to 7.39.0 (#2164) Co-authored-by: Mykhailo Kuznietsov --- antora-playbook-for-publication.yml | 4 ++-- antora.yml | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/antora-playbook-for-publication.yml b/antora-playbook-for-publication.yml index 0dd4006d58..cd3413a931 100644 --- a/antora-playbook-for-publication.yml +++ b/antora-playbook-for-publication.yml @@ -11,8 +11,8 @@ site: content: sources: - url: ./ - branches: "7.38.x" - edit_url: "https://github.com/eclipse/che-docs/edit/7.38.x/{path}" + branches: "7.39.x" + edit_url: "https://github.com/eclipse/che-docs/edit/7.39.x/{path}" output: destinations: - provider: fs diff --git a/antora.yml b/antora.yml index be73499f7f..38ac56b9d5 100644 --- a/antora.yml +++ b/antora.yml @@ -91,13 +91,13 @@ asciidoc: prod-operator-image-name: che-operator prod-operator: che-operator prod-prev-ver-major: "6" - prod-prev-ver: "7.37" + prod-prev-ver: "7.38" prod-short: Che prod-upstream: Eclipse{nbsp}Che prod-url: https://che-host:che-port prod-ver-major: "7" - prod-ver-patch: "7.38.2" - prod-ver: "7.38" + prod-ver-patch: "7.39.0" + prod-ver: "7.39" prod-workspace: che-ws prod: Eclipse Che prod2: Eclipse Che From 61329bac4fe3ed0942234defae6262c973e23d30 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 18 Nov 2021 16:28:21 +0100 Subject: [PATCH 20/25] draft --- modules/administration-guide/nav.adoc | 12 ++++++------ ...readiness-init-containers-for-olm-installer.adoc | 6 ------ ...ness-init-containers-for-operator-installer.adoc | 6 ------ ...iness-init-containers-for-the-olm-installer.adoc | 6 ++++++ ...-init-containers-for-the-operator-installer.adoc | 6 ++++++ ...ness-init-containers-for-the-olm-installer.adoc} | 6 +++--- ...init-containers-for-the-operator-installer.adoc} | 6 +++--- ...readiness-init-containers-for-olm-installer.adoc | 6 ------ ...ness-init-containers-for-operator-installer.adoc | 6 ------ ...iness-init-containers-for-the-olm-installer.adoc | 6 ++++++ ...-init-containers-for-the-operator-installer.adoc | 6 ++++++ .../pages/readiness-init-containers.adoc | 2 +- ...readiness-init-containers-for-olm-installer.adoc | 13 ------------- ...ness-init-containers-for-operator-installer.adoc | 13 ------------- ...iness-init-containers-for-the-olm-installer.adoc | 13 +++++++++++++ ...-init-containers-for-the-operator-installer.adoc | 13 +++++++++++++ .../assembly_readiness-init-containers.adoc | 4 ++-- ...ness-init-containers-for-the-olm-installer.adoc} | 8 ++++---- ...init-containers-for-the-operator-installer.adoc} | 9 +++++---- ...ness-init-containers-for-the-olm-installer.adoc} | 8 ++++---- ...init-containers-for-the-operator-installer.adoc} | 7 ++++--- 21 files changed, 82 insertions(+), 80 deletions(-) delete mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc delete mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-the-olm-installer.adoc create mode 100644 modules/administration-guide/pages/disabling-readiness-init-containers-for-the-operator-installer.adoc rename modules/administration-guide/pages/{enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc => enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc} (75%) rename modules/administration-guide/pages/{enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc => enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc} (73%) delete mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc delete mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-the-olm-installer.adoc create mode 100644 modules/administration-guide/pages/enabling-readiness-init-containers-for-the-operator-installer.adoc delete mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc delete mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc create mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc create mode 100644 modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc rename modules/administration-guide/partials/{proc_disabling-readiness-init-containers-for-olm-installer.adoc => proc_disabling-readiness-init-containers-for-the-olm-installer.adoc} (80%) rename modules/administration-guide/partials/{proc_disabling-readiness-init-containers-for-operator-installer.adoc => proc_disabling-readiness-init-containers-for-the-operator-installer.adoc} (71%) rename modules/administration-guide/partials/{proc_enabling-readiness-init-containers-for-olm-installer.adoc => proc_enabling-readiness-init-containers-for-the-olm-installer.adoc} (80%) rename modules/administration-guide/partials/{proc_enabling-readiness-init-containers-for-operator-installer.adoc => proc_enabling-readiness-init-containers-for-the-operator-installer.adoc} (77%) diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index dfa94fc686..8eb686292e 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -35,12 +35,12 @@ * xref:migration-from-postgresql-9-to-postgresql-13.adoc[] * xref:readiness-init-containers.adoc[] -** xref:enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] -*** xref:enabling-readiness-init-containers-for-operator-installer.adoc[] -*** xref:disabling-readiness-init-containers-for-operator-installer.adoc[] -** xref:enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] -*** xref:enabling-readiness-init-containers-for-olm-installer.adoc[] -*** xref:disabling-readiness-init-containers-for-olm-installer.adoc[] +** xref:enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc[] +*** xref:enabling-readiness-init-containers-for-the-operator-installer.adoc[] +*** xref:disabling-readiness-init-containers-for-the-operator-installer.adoc[] +** xref:enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc[] +*** xref:enabling-readiness-init-containers-for-the-olm-installer.adoc[] +*** xref:disabling-readiness-init-containers-for-the-olm-installer.adoc[] * xref:caching-images-for-faster-workspace-start.adoc[] ** xref:defining-the-list-of-images-to-pull.adoc[] diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc deleted file mode 100644 index 5f9cf70efb..0000000000 --- a/modules/administration-guide/pages/disabling-readiness-init-containers-for-olm-installer.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[id="disabling-readiness-init-containers-for-olm-installer"] -:navtitle: Disabling the readiness init containers for the OLM installer -:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, olm -:page-aliases: .:disabling-readiness-init-containers-for-olm-installer - -include::partial$proc_disabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc deleted file mode 100644 index ae4e753a76..0000000000 --- a/modules/administration-guide/pages/disabling-readiness-init-containers-for-operator-installer.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[id="disabling-readiness-init-containers-for-operator-installer"] -:navtitle: Disabling the readiness init containers for the Operator installer -:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, operator -:page-aliases: .:disabling-readiness-init-containers-for-operator-installer - -include::partial$proc_disabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-olm-installer.adoc new file mode 100644 index 0000000000..38570f22e0 --- /dev/null +++ b/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -0,0 +1,6 @@ +[id="disabling-readiness-init-containers-for-the-olm-installer"] +:navtitle: Disabling the readiness init containers for the OLM installer +:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, olm +:page-aliases: .:disabling-readiness-init-containers-for-the-olm-installer + +include::partial$proc_disabling-readiness-init-containers-for-the-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-operator-installer.adoc new file mode 100644 index 0000000000..6c715efe5c --- /dev/null +++ b/modules/administration-guide/pages/disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -0,0 +1,6 @@ +[id="disabling-readiness-init-containers-for-the-operator-installer"] +:navtitle: Disabling the readiness init containers for the Operator installer +:keywords: disable-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, operator +:page-aliases: .:disabling-readiness-init-containers-for-the-operator-installer + +include::partial$proc_disabling-readiness-init-containers-for-the-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc similarity index 75% rename from modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc rename to modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc index 178500d03d..997c539a59 100644 --- a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -1,6 +1,6 @@ -[id="enabling-and-disabling-readiness-init-containers-for-olm-installer"] +[id="enabling-and-disabling-readiness-init-containers-for-the-olm-installer"] :navtitle: Enabling and disabling the readiness init containers for the OLM installer :keywords: enable-readiness-init-containers, disable-readiness-init-containers, enabling-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, olm -:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-olm-installer +:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-the-olm-installer -include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc similarity index 73% rename from modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc rename to modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc index d1cf36b10c..2971a5ac29 100644 --- a/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/pages/enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -1,6 +1,6 @@ -[id="enabling-and-disabling-readiness-init-containers-for-operator-installer"] +[id="enabling-and-disabling-readiness-init-containers-for-the-operator-installer"] :navtitle: Enabling and disabling the readiness init containers for the Operator installer :keywords: enable-readiness-init-containers, disable-readiness-init-containers, enabling-readiness-init-containers, disabling-readiness-init-containers, init-container, readiness-init-container, startup, operator -:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-operator-installer +:page-aliases: .:enabling-and-disabling-readiness-init-containers-for-the-operator-installer -include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file +include::partial$assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc deleted file mode 100644 index bae9c002a8..0000000000 --- a/modules/administration-guide/pages/enabling-readiness-init-containers-for-olm-installer.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[id="enabling-readiness-init-containers-for-olm-installer"] -:navtitle: Enabling the readiness init containers for the OLM installer -:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, olm -:page-aliases: .:enabling-readiness-init-containers-for-olm-installer - -include::partial$proc_enabling-readiness-init-containers-for-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc deleted file mode 100644 index 8e241003ec..0000000000 --- a/modules/administration-guide/pages/enabling-readiness-init-containers-for-operator-installer.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[id="enabling-readiness-init-containers-for-operator-installer"] -:navtitle: Enabling the readiness init containers for the Operator installer -:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, operator -:page-aliases: .:enabling-readiness-init-containers-for-operator-installer - -include::partial$proc_enabling-readiness-init-containers-for-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-olm-installer.adoc new file mode 100644 index 0000000000..7ecef17f45 --- /dev/null +++ b/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-olm-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-readiness-init-containers-for-the-olm-installer"] +:navtitle: Enabling the readiness init containers for the OLM installer +:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, olm +:page-aliases: .:enabling-readiness-init-containers-for-the-olm-installer + +include::partial$proc_enabling-readiness-init-containers-for-the-olm-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-operator-installer.adoc new file mode 100644 index 0000000000..0ca06760f5 --- /dev/null +++ b/modules/administration-guide/pages/enabling-readiness-init-containers-for-the-operator-installer.adoc @@ -0,0 +1,6 @@ +[id="enabling-readiness-init-containers-for-the-operator-installer"] +:navtitle: Enabling the readiness init containers for the Operator installer +:keywords: enable-readiness-init-containers, enabling-readiness-init-containers, init-container, readiness-init-container, startup, operator +:page-aliases: .:enabling-readiness-init-containers-for-the-operator-installer + +include::partial$proc_enabling-readiness-init-containers-for-the-operator-installer.adoc[] \ No newline at end of file diff --git a/modules/administration-guide/pages/readiness-init-containers.adoc b/modules/administration-guide/pages/readiness-init-containers.adoc index c4cb1fa590..a22565c85a 100644 --- a/modules/administration-guide/pages/readiness-init-containers.adoc +++ b/modules/administration-guide/pages/readiness-init-containers.adoc @@ -1,6 +1,6 @@ [id="readiness-init-containers"] :navtitle: Readiness init containers :keywords: init-container, readiness-init-container, startup -:page-aliases: .:enabling-readiness-init-containers +:page-aliases: .:readiness-init-containers include::partial$assembly_readiness-init-containers.adoc[] diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc deleted file mode 100644 index 2e9b94ef32..0000000000 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:parent-context-of-enabling-and-disabling-readiness-init-containers-for-olm-installer: {context} - -[id="enabling-and-disabling-readiness-init-containers-for-olm-installer_{context}"] -= Enabling and disabling the readiness init containers for the OLM installer - -:context: enabling-and-disabling-readiness-init-containers-for-olm-installer - -You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer: - -* xref:enabling-readiness-init-containers-for-olm-installer.adoc[Enabling the readiness init containers for the OLM installer] -* xref:disabling-readiness-init-containers-for-olm-installer.adoc[Disabling the readiness init containers for the OLM installer] - -:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-olm-installer} \ No newline at end of file diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc deleted file mode 100644 index 1e9396502f..0000000000 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:parent-context-of-enabling-and-disabling-readiness-init-containers-for-operator-installer: {context} - -[id="enabling-and-disabling-readiness-init-containers-for-operator-installer_{context}"] -= Enabling and disabling the readiness init containers for the Operator installer - -:context: enabling-and-disabling-readiness-init-containers-for-operator-installer - -You can enable and disable the readiness init containers for {prod-short} installed by the Operator installer: - -* xref:enabling-readiness-init-containers-for-operator-installer.adoc[Enabling the readiness init containers for the Operator installer] -* xref:disabling-readiness-init-containers-for-operator-installer.adoc[Disabling the readiness init containers for the Operator installer] - -:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-operator-installer} diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc new file mode 100644 index 0000000000..2ec5d4b4d0 --- /dev/null +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -0,0 +1,13 @@ +:parent-context-of-enabling-and-disabling-readiness-init-containers-for-the-olm-installer: {context} + +[id="enabling-and-disabling-readiness-init-containers-for-the-olm-installer_{context}"] += Enabling and disabling the readiness init containers for the OLM installer + +:context: enabling-and-disabling-readiness-init-containers-for-the-olm-installer + +You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer, which is a {prod-short} installer that uses the Operator Lifecycle Manager: + +* xref:enabling-readiness-init-containers-for-the-olm-installer.adoc[Enabling the readiness init containers for the OLM installer] +* xref:disabling-readiness-init-containers-for-the-olm-installer.adoc[Disabling the readiness init containers for the OLM installer] + +:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-the-olm-installer} \ No newline at end of file diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc new file mode 100644 index 0000000000..fa3a17210e --- /dev/null +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -0,0 +1,13 @@ +:parent-context-of-enabling-and-disabling-readiness-init-containers-for-the-operator-installer: {context} + +[id="enabling-and-disabling-readiness-init-containers-for-the-operator-installer_{context}"] += Enabling and disabling the readiness init containers for the Operator installer + +:context: enabling-and-disabling-readiness-init-containers-for-the-operator-installer + +You can enable and disable the readiness init containers for {prod-short} installed by the Operator installer: + +* xref:enabling-readiness-init-containers-for-the-operator-installer.adoc[Enabling the readiness init containers for the Operator installer] +* xref:disabling-readiness-init-containers-for-the-operator-installer.adoc[Disabling the readiness init containers for the Operator installer] + +:context: {parent-context-of-enabling-and-disabling-readiness-init-containers-for-the-operator-installer} diff --git a/modules/administration-guide/partials/assembly_readiness-init-containers.adoc b/modules/administration-guide/partials/assembly_readiness-init-containers.adoc index da8c565082..9f7f08a419 100644 --- a/modules/administration-guide/partials/assembly_readiness-init-containers.adoc +++ b/modules/administration-guide/partials/assembly_readiness-init-containers.adoc @@ -9,8 +9,8 @@ The readiness init containers are disabled by default. If you choose to enable them, proceed according to the installation method used to install {prod-short}: -* xref:enabling-and-disabling-readiness-init-containers-for-operator-installer.adoc[] +* xref:enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc[] -* xref:enabling-and-disabling-readiness-init-containers-for-olm-installer.adoc[] +* xref:enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc[] :context: {parent-context-of-readiness-init-containers} \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc similarity index 80% rename from modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc rename to modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc index f61b580abe..518396f7e5 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -1,9 +1,9 @@ :_module-type: PROCEDURE -[id="disabling-readiness-init-containers-for-olm-installer_{context}"] +[id="disabling-readiness-init-containers-for-the-olm-installer_{context}"] = Disabling the readiness init containers for the OLM installer -To disable the previously enabled readiness init containers for {prod-short} installed by the Operator Lifecycle Manager (OLM) installer: +To disable the previously enabled readiness init containers for {prod-short} installed by the OLM installer: .Prerequisites @@ -18,14 +18,14 @@ To disable the previously enabled readiness init containers for {prod-short} ins $ {orch-cli} get subscriptions -n {prod-namespace} ---- -. Find the CSV name in the {prod-short} Operator subscription: +. Get the CSV (Cluster Service Version) name from the {prod-short} Operator subscription: + [source,shell,subs="+quotes,+attributes"] ---- $ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV ---- -. Edit the `ClusterServiceVersion` (CSV) YAML manifest: +. Edit the `ClusterServiceVersion` YAML manifest: + [source,shell,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc similarity index 71% rename from modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc rename to modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc index e7f161fbf2..df6ca2af73 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -1,4 +1,4 @@ -[id="disabling-readiness-init-containers-for-operator-installer_{context}"] +[id="disabling-readiness-init-containers-for-the-operator-installer_{context}"] = Disabling the readiness init containers for the Operator installer To disable the previously enabled readiness init containers for {prod-short} installed by the Operator installer: @@ -11,14 +11,15 @@ To disable the previously enabled readiness init containers for {prod-short} ins . Find {prod-short} Operator Deployment name. -. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, remove the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, remove the following lines: + [source,yaml,subs="+quotes,+attributes"] ---- - - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS <1> value: "true" ---- +<1> `ADD_COMPONENT_READINESS_INIT_CONTAINERS` is an environment variable. . Wait while {prod-short} Operator restarts some components. -NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator Deployment is created. +NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator Deployment is created. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc similarity index 80% rename from modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc rename to modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc index 0c1698c76b..3a8498712b 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc @@ -1,9 +1,9 @@ :_module-type: PROCEDURE -[id="enabling-readiness-init-containers-for-olm-installer_{context}"] +[id="enabling-readiness-init-containers-for-the-olm-installer_{context}"] = Enabling the readiness init containers for the OLM installer -The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the Operator Lifecycle Manager (OLM) installer: +The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the OLM installer: .Prerequisites @@ -18,14 +18,14 @@ The readiness init containers are not enabled by default, so to use them you fir $ {orch-cli} get subscriptions -n {prod-namespace} ---- -. Find the CSV name in the {prod-short} Operator subscription: +. Get the CSV (Cluster Service Version) name from the {prod-short} Operator subscription: + [source,shell,subs="+quotes,+attributes"] ---- $ {orch-cli} get subscription -n {prod-namespace} -o yaml | grep installedCSV ---- -. Edit the `ClusterServiceVersion` (CSV) YAML manifest: +. Edit the `ClusterServiceVersion` YAML manifest: + [source,shell,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc similarity index 77% rename from modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc rename to modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc index 45af4061c2..216751300e 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc @@ -1,4 +1,4 @@ -[id="enabling-readiness-init-containers-for-operator-installer_{context}"] +[id="enabling-readiness-init-containers-for-the-operator-installer_{context}"] = Enabling the readiness init containers for the Operator installer The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the Operator installer: @@ -11,13 +11,14 @@ The readiness init containers are not enabled by default, so to use them you fir . Find {prod-short} Operator Deployment name. -. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert the following lines with the `ADD_COMPONENT_READINESS_INIT_CONTAINERS` environment variable: +. Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert the following lines: + [source,yaml,subs="+quotes,+attributes"] ---- - - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS + - name: ADD_COMPONENT_READINESS_INIT_CONTAINERS <1> value: "true" ---- +<1> `ADD_COMPONENT_READINESS_INIT_CONTAINERS` is an environment variable. . Wait while {prod-short} Operator restarts some components. From 5acb202600312519d19f36e43bf02bffa10d3810 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Fri, 19 Nov 2021 16:01:45 +0200 Subject: [PATCH 21/25] Fixes Signed-off-by: Mykola Morhun --- ...ng-readiness-init-containers-for-the-olm-installer.adoc | 2 -- ...adiness-init-containers-for-the-operator-installer.adoc | 7 +++++-- ...adiness-init-containers-for-the-operator-installer.adoc | 5 +++++ 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc index 518396f7e5..d19526c8d6 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -40,5 +40,3 @@ $ {orch-cli} edit csv __ -n {prod-namespace} ---- . Wait for the {prod-short} Operator restart to finish. The restarted Operator will then continue with restarting some of its components. - -NOTE: Repeat these steps after each {prod-short} upgrade when a new CSV is created by OLM. diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc index df6ca2af73..5ae7727f91 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -10,6 +10,11 @@ To disable the previously enabled readiness init containers for {prod-short} ins .Procedure . Find {prod-short} Operator Deployment name. ++ +[source,yaml,subs="+quotes,+attributes"] +---- +$ {orch-cli} get deployments -n {prod-namespace} +---- . Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, remove the following lines: + @@ -21,5 +26,3 @@ To disable the previously enabled readiness init containers for {prod-short} ins <1> `ADD_COMPONENT_READINESS_INIT_CONTAINERS` is an environment variable. . Wait while {prod-short} Operator restarts some components. - -NOTE: Repeat these steps after each {prod-short} upgrade when a new Operator Deployment is created. \ No newline at end of file diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc index 216751300e..ed2802417b 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc @@ -10,6 +10,11 @@ The readiness init containers are not enabled by default, so to use them you fir .Procedure . Find {prod-short} Operator Deployment name. ++ +[source,yaml,subs="+quotes,+attributes"] +---- +$ {orch-cli} get deployments -n {prod-namespace} +---- . Edit the Deployment as follows: Under `spec.template.spec.containers[0].env` of the Operator Deployment, insert the following lines: + From f94f272ab27a8eefea394570a8a4cf5f5533f2f4 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Thu, 25 Nov 2021 10:38:06 +0200 Subject: [PATCH 22/25] Fix message Signed-off-by: Mykola Morhun --- ...ng-readiness-init-containers-for-the-operator-installer.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc index ed2802417b..eda938eac6 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc @@ -9,7 +9,7 @@ The readiness init containers are not enabled by default, so to use them you fir .Procedure -. Find {prod-short} Operator Deployment name. +. Find the name of the {prod-short} Operator Deployment. Usually it is `{prod-id-short}-operator`: + [source,yaml,subs="+quotes,+attributes"] ---- From 15977a17357507ec2df5751c8bc7add97235744d Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Thu, 25 Nov 2021 15:37:55 +0200 Subject: [PATCH 23/25] Update modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc Co-authored-by: Max Leonov --- ...sabling-readiness-init-containers-for-the-olm-installer.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc index 2ec5d4b4d0..44df46ebe9 100644 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -5,7 +5,7 @@ :context: enabling-and-disabling-readiness-init-containers-for-the-olm-installer -You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer, which is a {prod-short} installer that uses the Operator Lifecycle Manager: +You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer. (Available through `{prod-cli}`, the OLM installer uses the Operator Lifecycle Manager to install {prod-short}.) * xref:enabling-readiness-init-containers-for-the-olm-installer.adoc[Enabling the readiness init containers for the OLM installer] * xref:disabling-readiness-init-containers-for-the-olm-installer.adoc[Disabling the readiness init containers for the OLM installer] From 561930ed457ca504a7adabdd9c2f0693495c69ba Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Thu, 25 Nov 2021 15:59:28 +0200 Subject: [PATCH 24/25] Apply suggestions from code review Co-authored-by: Max Leonov --- ...bling-readiness-init-containers-for-the-olm-installer.adoc | 2 +- ...-readiness-init-containers-for-the-operator-installer.adoc | 4 ++-- ...bling-readiness-init-containers-for-the-olm-installer.adoc | 2 +- ...-readiness-init-containers-for-the-operator-installer.adoc | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc index d19526c8d6..e7ce32bcdf 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -3,7 +3,7 @@ [id="disabling-readiness-init-containers-for-the-olm-installer_{context}"] = Disabling the readiness init containers for the OLM installer -To disable the previously enabled readiness init containers for {prod-short} installed by the OLM installer: +To disable the previously enabled readiness init containers for the {prod-short} installed by the OLM installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc index 5ae7727f91..7dd93a5393 100644 --- a/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -1,7 +1,7 @@ [id="disabling-readiness-init-containers-for-the-operator-installer_{context}"] = Disabling the readiness init containers for the Operator installer -To disable the previously enabled readiness init containers for {prod-short} installed by the Operator installer: +To disable the previously enabled readiness init containers for the {prod-short} installed by the Operator installer: .Prerequisites @@ -9,7 +9,7 @@ To disable the previously enabled readiness init containers for {prod-short} ins .Procedure -. Find {prod-short} Operator Deployment name. +. Find the name of the {prod-short} Operator Deployment. Usually it is `{prod-id-short}-operator`: + [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc index 3a8498712b..6badd9eee1 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-olm-installer.adoc @@ -3,7 +3,7 @@ [id="enabling-readiness-init-containers-for-the-olm-installer_{context}"] = Enabling the readiness init containers for the OLM installer -The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the OLM installer: +The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for the {prod-short} installed by the OLM installer: .Prerequisites diff --git a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc index eda938eac6..59ea5c8df6 100644 --- a/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/proc_enabling-readiness-init-containers-for-the-operator-installer.adoc @@ -1,7 +1,7 @@ [id="enabling-readiness-init-containers-for-the-operator-installer_{context}"] = Enabling the readiness init containers for the Operator installer -The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for {prod-short} installed by the Operator installer: +The readiness init containers are not enabled by default, so to use them you first have to enable them. To enable the readiness init containers for the {prod-short} installed by the Operator installer: .Prerequisites From 9cc35719bfc67c8534afded0eafaa564d3d54db6 Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Thu, 25 Nov 2021 16:06:58 +0200 Subject: [PATCH 25/25] Apply suggestions from code review Co-authored-by: Max Leonov --- ...sabling-readiness-init-containers-for-the-olm-installer.adoc | 2 +- ...ng-readiness-init-containers-for-the-operator-installer.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc index 44df46ebe9..e9698f73e8 100644 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc @@ -5,7 +5,7 @@ :context: enabling-and-disabling-readiness-init-containers-for-the-olm-installer -You can enable and disable the readiness init containers for {prod-short} installed by the OLM installer. (Available through `{prod-cli}`, the OLM installer uses the Operator Lifecycle Manager to install {prod-short}.) +You can enable and disable the readiness init containers for the {prod-short} installed by the OLM installer. (Available through `{prod-cli}`, the OLM installer uses the Operator Lifecycle Manager to install {prod-short}.) * xref:enabling-readiness-init-containers-for-the-olm-installer.adoc[Enabling the readiness init containers for the OLM installer] * xref:disabling-readiness-init-containers-for-the-olm-installer.adoc[Disabling the readiness init containers for the OLM installer] diff --git a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc index fa3a17210e..c2c5f217da 100644 --- a/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc +++ b/modules/administration-guide/partials/assembly_enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc @@ -5,7 +5,7 @@ :context: enabling-and-disabling-readiness-init-containers-for-the-operator-installer -You can enable and disable the readiness init containers for {prod-short} installed by the Operator installer: +You can enable and disable the readiness init containers for the {prod-short} installed by the Operator installer: * xref:enabling-readiness-init-containers-for-the-operator-installer.adoc[Enabling the readiness init containers for the Operator installer] * xref:disabling-readiness-init-containers-for-the-operator-installer.adoc[Disabling the readiness init containers for the Operator installer]