From 985c6a8479386bdb80d6eab2947d8c1a3f6cd63a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 30 Mar 2021 07:58:10 +0200 Subject: [PATCH 01/40] Fix vale errors. Refresh description from https://docs.openshift.com/container-platform/4.7/web_console/odc-about-developer-perspective.html --- .vale/styles/Vocab/Che/accept.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 3624e07efd..8ecbdb9b5e 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -14,7 +14,7 @@ Btrfs boolean CentOS Ceph -[Cc]he +che|Che Che-Theia [Cc]classloading ConfigMap From 06156ebd3be492fa92d2cf2eb69ec961022a787e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 30 Mar 2021 07:58:52 +0200 Subject: [PATCH 02/40] Fix language --- .../partials/proc_importing-certificates-to-browsers.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc b/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc index a9426bd9e6..adcbe2a31e 100644 --- a/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc +++ b/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc @@ -59,7 +59,7 @@ When a TLS certificate is not trusted, the error message *"Your {prod2} server m .. Click the btn:[>] button next to the *Connection not secure* warning. .. Click the btn:[More information] button. .. Click the btn:[View Certificate] button on the *Security* tab. -.. Select the second certificate tab. The certificate Common Name should start with `ingress-operator` +.. Select the second certificate tab. The certificate Common Name should start with *ingress-operator* .. Click the *PEM (cert)* link and save the certificate. . Navigate to link:about:preferences[about:preferences], search for `certificates`, and click *View Certificates*. . Go to the *Authorities* tab, click the btn:[Import] button, and open the saved certificate file. From df982c39f2865c0b82fb26678e2b199c523bd904 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 14:21:23 +0200 Subject: [PATCH 03/40] Vale config changes --- .vale/styles/Vocab/Che/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 8ecbdb9b5e..6c9657bb79 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -45,7 +45,6 @@ IDE|ide IDEs Intelephense I/O -item Java [Jj]etbrains jvm|JVM From c08d685c0a5fa7408a8a5657d2e5a9852cd2fc27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 14:24:30 +0200 Subject: [PATCH 04/40] Vale config changes --- .vale.ini | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/.vale.ini b/.vale.ini index 716a1dfb05..fe2524a25c 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,10 +4,7 @@ # The relative path to the folder containing linting rules (styles) StylesPath = .vale/styles -# Vocab define the exceptions to use in *all* `BasedOnStyles`. -# accept.txt -> Vale.Terms -# reject.txt -> Vale.Avoid -# See: https://docs.errata.ai/vale/vocab + Vocab = Che # Minimum alert level @@ -19,16 +16,18 @@ MinAlertLevel = suggestion # IgnoredScopes specifies inline-level HTML tags to ignore. In other words, these tags may occur in an active scope (unlike SkippedScopes, which are skipped entirely) but their content still won't raise any alerts. # By default, `code` and `tt` are ignored. -IgnoredScopes = code, tt, img, url, a, body.id +IgnoredScopes = code, tt, img, url, a + # SkippedScopes specifies block-level HTML tags to ignore. Any content in these scopes will be ignored. # By default, `script`, `style`, `pre`, and `figure` are ignored. # For asciidoc: by default, listing blocks and inline literals are ignored. SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock -# Associate an unknown file extension with a supported file format +# associate an unknown file extension with a supported file format [formats] -# To check the comments starting by a dash `#` in the `che.properties` file in `che` repository, associate the `*.properties` files to the `r` format. +# Associate the `*.properties` files to the `r` format: +# Validate only comments starting by a dash `#`. properties = r [*.{properties,r}] @@ -58,8 +57,8 @@ Vale.Spelling = YES # Disabling rules Vale.Repetition = NO +Vale.Avoid = NO # Altering rules severity (error, warning, suggestion) -IBM.Annotations = suggestion -IBM.Slash = warning IBM.Usage = suggestion +IBM.Slash = warning From 588d285ec76f9b1494670eb35dad1bb93cf62abc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 14:39:12 +0200 Subject: [PATCH 05/40] Fix language on modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc --- .../partials/proc_importing-certificates-to-browsers.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc b/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc index adcbe2a31e..a9426bd9e6 100644 --- a/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc +++ b/modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc @@ -59,7 +59,7 @@ When a TLS certificate is not trusted, the error message *"Your {prod2} server m .. Click the btn:[>] button next to the *Connection not secure* warning. .. Click the btn:[More information] button. .. Click the btn:[View Certificate] button on the *Security* tab. -.. Select the second certificate tab. The certificate Common Name should start with *ingress-operator* +.. Select the second certificate tab. The certificate Common Name should start with `ingress-operator` .. Click the *PEM (cert)* link and save the certificate. . Navigate to link:about:preferences[about:preferences], search for `certificates`, and click *View Certificates*. . Go to the *Authorities* tab, click the btn:[Import] button, and open the saved certificate file. From 8e4a341ca8da0fda76ef83f9aa669f94cca2b4ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 14:52:00 +0200 Subject: [PATCH 06/40] Accept Webview --- .vale/styles/Vocab/Che/accept.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 6c9657bb79..47c2b9b785 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -115,8 +115,7 @@ Velero Visual Studio Code VS Code vsix -Webview -Webviews +Webview|Webviews Woopra [Ww]orkspace [Ww]orkspaces From bb57df0921c60dcf4514eaf174a1ae6578e19874 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 14:59:30 +0200 Subject: [PATCH 07/40] Accept Omnisharp --- .vale/styles/Vocab/Che/accept.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 47c2b9b785..d1a8948afe 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -75,8 +75,8 @@ npm NuGet OAuth ocp -OmniSharp -[Oo]nboarding +Omnisharp +onboarding|Onboarding OpenShift OpenTracing Operator From 107d32bd92946237ecd6a876f9ebe958edfafe2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 15:07:04 +0200 Subject: [PATCH 08/40] Use 'OmniSharp' --- .vale/styles/Vocab/Che/accept.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index d1a8948afe..796eb11c65 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -75,7 +75,7 @@ npm NuGet OAuth ocp -Omnisharp +OmniSharp onboarding|Onboarding OpenShift OpenTracing From 7b882f444fc7814ea36887d6af6e462723b7bba9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 15:10:07 +0200 Subject: [PATCH 09/40] Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc --- ...ing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc | 2 ++ 1 file changed, 2 insertions(+) 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..df286af1e3 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 @@ -1,3 +1,5 @@ +// `viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in` + [id="viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel_{context}"] = Viewing `NetcoredebugOutput` plug-in logs in the Output panel From ab3ec48fbb7f0ff926fab5355470d5343abcac09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 15:20:43 +0200 Subject: [PATCH 10/40] Decreasing the severity of the IBM.Annotations rule, as [NOTE] is a legit admonition statement in AsciiDoc --- .vale.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index fe2524a25c..475ee78aae 100644 --- a/.vale.ini +++ b/.vale.ini @@ -60,5 +60,6 @@ Vale.Repetition = NO Vale.Avoid = NO # Altering rules severity (error, warning, suggestion) -IBM.Usage = suggestion +IBM.Annotations = suggestion IBM.Slash = warning +IBM.Usage = suggestion From 9debaf7b1e94d875a59b6faaad9021a6d39e2670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 16:47:06 +0200 Subject: [PATCH 11/40] More vale config --- .vale/styles/Vocab/Che/accept.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 796eb11c65..3624e07efd 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -14,7 +14,7 @@ Btrfs boolean CentOS Ceph -che|Che +[Cc]he Che-Theia [Cc]classloading ConfigMap @@ -45,6 +45,7 @@ IDE|ide IDEs Intelephense I/O +item Java [Jj]etbrains jvm|JVM @@ -76,7 +77,7 @@ NuGet OAuth ocp OmniSharp -onboarding|Onboarding +[Oo]nboarding OpenShift OpenTracing Operator @@ -115,7 +116,8 @@ Velero Visual Studio Code VS Code vsix -Webview|Webviews +Webview +Webviews Woopra [Ww]orkspace [Ww]orkspaces From 1745486fed43ac1d88a3b3e3a544094127db0f2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 16:47:11 +0200 Subject: [PATCH 12/40] Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc --- ...ing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc | 2 -- 1 file changed, 2 deletions(-) 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 df286af1e3..b6c1c2aa0f 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 @@ -1,5 +1,3 @@ -// `viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in` - [id="viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel_{context}"] = Viewing `NetcoredebugOutput` plug-in logs in the Output panel From 26bbad1dbd60bf25dbec9fd2f6bcbdf90624835b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 16:47:11 +0200 Subject: [PATCH 13/40] Fix language on modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html --- ...the-state-of-the-yaml-language-server.html | 479 ++++++++++++++++++ 1 file changed, 479 insertions(+) create mode 100644 modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html diff --git a/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html b/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html new file mode 100644 index 0000000000..049242941d --- /dev/null +++ b/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html @@ -0,0 +1,479 @@ + + + + + + + +Verifying the state of the YAML language server + + + + + +
+
+

This section describes how to verify the state of the YAML language server.

+
+
+
Procedure
+

Check if the container running the YAML plug-in is running the YAML language server.

+
+
+
    +
  1. +

    In the editor, open a terminal in the container that is running the YAML plug-in (an example name of the container: vscode-yaml-<xxx>).

    +
    2. +
  2. +

    In the terminal, run the ps aux | grep node command. This command searches all the node processes running in the current container.

    +
    3. +
  3. +

    Verify that a command node **/server.js is running.

    +
    +
    +verifying the state of the yaml language server +
    +
    +
    4. +
+
+
+

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 Checking important logs.

+
+
+ + + \ No newline at end of file From ac7d56e8a6ecf3d834aee0234d7301d6161256a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 16:50:34 +0200 Subject: [PATCH 14/40] deleted: modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html --- ...the-state-of-the-yaml-language-server.html | 479 ------------------ 1 file changed, 479 deletions(-) delete mode 100644 modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html diff --git a/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html b/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html deleted file mode 100644 index 049242941d..0000000000 --- a/modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html +++ /dev/null @@ -1,479 +0,0 @@ - - - - - - - -Verifying the state of the YAML language server - - - - - -
-
-

This section describes how to verify the state of the YAML language server.

-
-
-
Procedure
-

Check if the container running the YAML plug-in is running the YAML language server.

-
-
-
    -
  1. -

    In the editor, open a terminal in the container that is running the YAML plug-in (an example name of the container: vscode-yaml-<xxx>).

    -
    2. -
  2. -

    In the terminal, run the ps aux | grep node command. This command searches all the node processes running in the current container.

    -
    3. -
  3. -

    Verify that a command node **/server.js is running.

    -
    -
    -verifying the state of the yaml language server -
    -
    -
    4. -
-
-
-

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 Checking important logs.

-
-
- - - \ No newline at end of file From c653392d3e812402b6bfdba35128b0977ce73363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 16:51:04 +0200 Subject: [PATCH 15/40] More vale config again --- .vale.ini | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.vale.ini b/.vale.ini index 475ee78aae..716a1dfb05 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,7 +4,10 @@ # The relative path to the folder containing linting rules (styles) StylesPath = .vale/styles - +# Vocab define the exceptions to use in *all* `BasedOnStyles`. +# accept.txt -> Vale.Terms +# reject.txt -> Vale.Avoid +# See: https://docs.errata.ai/vale/vocab Vocab = Che # Minimum alert level @@ -16,18 +19,16 @@ MinAlertLevel = suggestion # IgnoredScopes specifies inline-level HTML tags to ignore. In other words, these tags may occur in an active scope (unlike SkippedScopes, which are skipped entirely) but their content still won't raise any alerts. # By default, `code` and `tt` are ignored. -IgnoredScopes = code, tt, img, url, a - +IgnoredScopes = code, tt, img, url, a, body.id # SkippedScopes specifies block-level HTML tags to ignore. Any content in these scopes will be ignored. # By default, `script`, `style`, `pre`, and `figure` are ignored. # For asciidoc: by default, listing blocks and inline literals are ignored. SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock -# associate an unknown file extension with a supported file format +# Associate an unknown file extension with a supported file format [formats] -# Associate the `*.properties` files to the `r` format: -# Validate only comments starting by a dash `#`. +# To check the comments starting by a dash `#` in the `che.properties` file in `che` repository, associate the `*.properties` files to the `r` format. properties = r [*.{properties,r}] @@ -57,7 +58,6 @@ Vale.Spelling = YES # Disabling rules Vale.Repetition = NO -Vale.Avoid = NO # Altering rules severity (error, warning, suggestion) IBM.Annotations = suggestion From 7a5a8065275861da8d65ac9fc95e3facd858f692 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:46:21 +0200 Subject: [PATCH 16/40] Vale config --- .vale/styles/Vocab/Che/accept.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Vocab/Che/accept.txt b/.vale/styles/Vocab/Che/accept.txt index 3624e07efd..b7f4d4d003 100644 --- a/.vale/styles/Vocab/Che/accept.txt +++ b/.vale/styles/Vocab/Che/accept.txt @@ -37,7 +37,7 @@ GitHub|github GitLab Gluster Gradle -Grafana +[Gg]rafana GUI HTTPS|https heatmap @@ -49,7 +49,7 @@ item Java [Jj]etbrains jvm|JVM -helm +[Hh]elm hostname kbd Keycloak|keycloak @@ -66,7 +66,7 @@ millicores [Mm]inishift [Mm]ixin [Mm]ixins -multiuser +[Mm]ultiuser MySQL namespace namespaces From 4eddddee852cf7630a18e67cabbca2029f0383ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:05 +0200 Subject: [PATCH 17/40] Rename example to fix vale errors --- ...s.adoc => snip_che-cluster-deployment-openshift-logs.adoc} | 4 ++++ 1 file changed, 4 insertions(+) rename modules/administration-guide/examples/{che-cluster-deployment-openshift-logs.adoc => snip_che-cluster-deployment-openshift-logs.adoc} (91%) diff --git a/modules/administration-guide/examples/che-cluster-deployment-openshift-logs.adoc b/modules/administration-guide/examples/snip_che-cluster-deployment-openshift-logs.adoc similarity index 91% rename from modules/administration-guide/examples/che-cluster-deployment-openshift-logs.adoc rename to modules/administration-guide/examples/snip_che-cluster-deployment-openshift-logs.adoc index be08446d43..26545bd546 100644 --- a/modules/administration-guide/examples/che-cluster-deployment-openshift-logs.adoc +++ b/modules/administration-guide/examples/snip_che-cluster-deployment-openshift-logs.adoc @@ -1,3 +1,5 @@ +[options="nowrap",role="white-space-pre",subs="+quotes,+attributes"] +---- time="2019-07-12T09:48:29Z" level=info msg="Exec successfully completed" time="2019-07-12T09:48:29Z" level=info msg="Updating eclipse-che CR with status: provisioned with OpenShift identity provider: true" time="2019-07-12T09:48:29Z" level=info msg="Custom resource eclipse-che updated" @@ -7,3 +9,5 @@ time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: Deployment, n time="2019-07-12T09:48:30Z" level=info msg="Updating eclipse-che CR with status: {prod-short} API: Unavailable" time="2019-07-12T09:48:30Z" level=info msg="Custom resource eclipse-che updated" time="2019-07-12T09:48:30Z" level=info msg="Waiting for deployment che. Default timeout: 420 seconds" +---- + From ce2e47c9051201b606f261d2eb8c77a256cf7c75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 18/40] Fix language on modules/administration-guide/examples/prometheus-config.adoc --- modules/administration-guide/examples/prometheus-config.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/administration-guide/examples/prometheus-config.adoc b/modules/administration-guide/examples/prometheus-config.adoc index eb3f57039c..1df67b25b1 100644 --- a/modules/administration-guide/examples/prometheus-config.adoc +++ b/modules/administration-guide/examples/prometheus-config.adoc @@ -1,3 +1,5 @@ +[source,yaml,subs="+attributes"] +---- apiVersion: v1 kind: ConfigMap metadata: @@ -11,3 +13,5 @@ data: - job_name: 'che' static_configs: - targets: ['[che-host]:8087'] <4> +---- + From 0593d9d2ae0c32778aec3faa5e78d948637a200d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 19/40] Fix language on modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc --- .../examples/snip_che-cloning-image-puller-project.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc b/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc index d365f5eda4..65194ac26a 100644 --- a/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc +++ b/modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc @@ -1,4 +1,5 @@ +[subs="+attributes"] ---- -$ git clone https://github.com/che-incubator/kubernetes-image-puller -$ cd kubernetes-image-puller/deploy/openshift +$ git clone https://github.com/che-incubator/{image-puller-repository-name} +$ cd {image-puller-repository-name}/deploy/openshift ---- From 0fbfc4ec67719a3c21164d59a0beba54f310c0bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 20/40] Fix language on modules/administration-guide/examples/snip_che-devfile-meta.adoc --- .../administration-guide/examples/snip_che-devfile-meta.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/administration-guide/examples/snip_che-devfile-meta.adoc b/modules/administration-guide/examples/snip_che-devfile-meta.adoc index dcd24ce52d..564eac6298 100644 --- a/modules/administration-guide/examples/snip_che-devfile-meta.adoc +++ b/modules/administration-guide/examples/snip_che-devfile-meta.adoc @@ -1,5 +1,9 @@ +[source,yaml] +---- displayName: Rust description: Rust Stack with Rust 1.39 tags: ["Rust"] icon: https://www.eclipse.org/che/images/logo-eclipseche.svg globalMemoryLimit: 1686Mi +---- + From 3571232cc2efd94ae3d8b906a4f86984128327db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 21/40] Fix language on modules/administration-guide/examples/snip_che-plug-in-tree.adoc --- .../administration-guide/examples/snip_che-plug-in-tree.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/administration-guide/examples/snip_che-plug-in-tree.adoc b/modules/administration-guide/examples/snip_che-plug-in-tree.adoc index e620b7206b..1e89557e2a 100644 --- a/modules/administration-guide/examples/snip_che-plug-in-tree.adoc +++ b/modules/administration-guide/examples/snip_che-plug-in-tree.adoc @@ -1,3 +1,5 @@ +[subs="+attributes"] +---- $ tree che-plugin-registry/v3/plugins/redhat/java/ che-plugin-registry/v3/plugins/redhat/java/ ├── 0.38.0 @@ -13,3 +15,5 @@ che-plugin-registry/v3/plugins/redhat/java/ └── latest.txt $ cat che-plugin-registry/v3/plugins/redhat/java/latest.txt 0.50.0 +---- + From 2bb43262fe488806c057f5148ad9186e5cdb8433 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 22/40] Fix language on modules/administration-guide/partials/assembly_tracing-che.adoc --- .../administration-guide/partials/assembly_tracing-che.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/administration-guide/partials/assembly_tracing-che.adoc b/modules/administration-guide/partials/assembly_tracing-che.adoc index 23df871fb3..ee0178084e 100644 --- a/modules/administration-guide/partials/assembly_tracing-che.adoc +++ b/modules/administration-guide/partials/assembly_tracing-che.adoc @@ -11,11 +11,11 @@ Tracing helps gather timing data to troubleshoot latency problems in microservic Tracing the {prod-short} application may help analyze the execution of various operations, such as workspace creations, workspace startup, breaking down the duration of sub-operations executions, helping finding bottlenecks and improve the overall state of the platform. -Tracers live in applications. They record timing and metadata about operations that take place. They often instrument libraries, so that their use is transparent to users. For example, an instrumented web server records when it received a request and when it sent a response. The trace data collected is called a *span*. A span has a context that contains information such as trace and span identifiers and other kinds of data that can be propagated down the line. +Tracers live in applications. They record timing and metadata about operations that take place. They often instrument libraries, so that their use is indiscernible to users. For example, an instrumented web server records when it received a request and when it sent a response. The trace data collected is called a *span*. A span has a context that contains information such as trace and span identifiers and other kinds of data that can be propagated down the line. == Tracing API -{prod-short} utilizes link:https://opentracing.io/[OpenTracing API] - a vendor-neutral framework for instrumentation. This means that if a developer wants to try a different tracing back end, then instead of repeating the whole instrumentation process for the new distributed tracing system, the developer can simply change the configuration of the tracer back end. +{prod-short} utilizes link:https://opentracing.io/[OpenTracing API] - a vendor-neutral framework for instrumentation. This means that if a developer wants to try a different tracing back end, then rather than repeating the whole instrumentation process for the new distributed tracing system, the developer can simply change the configuration of the tracer back end. == Tracing back end From 6ab0abe019faedd2fd7527dbabc691f558be633f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 23/40] Fix language on modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc --- ...n_caching-images-for-faster-workspace-start.adoc | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc b/modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc index 67272d34f2..f3b4c26cae 100644 --- a/modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc +++ b/modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc @@ -51,32 +51,31 @@ endif::[] |`k8s-image-puller` |`IMAGES` -pass:[] -|Semicolon separated list of images to pull, in the format `____=____;...` See xref:defining-the-list-of-images-to-pull.adoc[]. +|Semicolon separated list of images to pull, in the format `____=____;____=____` See xref:defining-the-list-of-images-to-pull.adoc[]. | -pass:[] |`NODE_SELECTOR` |Node selector to apply to the Pods created by the DaemonSet |`'{}'` |=== -.Additional resources -pass:[] +.Additional resources * xref:defining-the-list-of-images-to-pull.adoc[] * xref:defining-the-memory-parameters-for-the-image-puller.adoc[]. * xref:installing-image-puller-using-che-operator.adoc[] + ifeval::["{project-context}" == "che"] * xref:installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc[] endif::[] + * xref:installing-image-puller-on-openshift-using-operatorhub.adoc[] * xref:installing-image-puller-on-openshift-using-openshift-templates.adoc[] + ifeval::["{project-context}" == "che"] * xref:installing-image-puller-on-kubernetes-using-helm.adoc[] endif::[] -* link:https://github.com/che-incubator/kubernetes-image-puller[{image-puller-name} source code repository] -pass:[] +* link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository] From df09398a1d97ea8a5478bd771de90ef5be76735b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 24/40] Fix language on modules/administration-guide/partials/con_che-user-runtimes.adoc --- .../administration-guide/partials/con_che-user-runtimes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/con_che-user-runtimes.adoc b/modules/administration-guide/partials/con_che-user-runtimes.adoc index 2d60ce465a..63f5087f25 100644 --- a/modules/administration-guide/partials/con_che-user-runtimes.adoc +++ b/modules/administration-guide/partials/con_che-user-runtimes.adoc @@ -7,6 +7,6 @@ Use any non-terminating user container as a user runtime. An application that can be defined as a container image or as a set of {platforms-name} resources can be included in a {prod-short} workspace. This makes it easy to test applications in the {prod-short} workspace. -To test an application in the {prod-short} workspace, include the application YAML definition used in stage or production in the workspace specification. It is a 12-factor app dev/prod parity. +To test an application in the {prod-short} workspace, include the application YAML definition used in stage or production in the workspace specification. It is a 12-factor application development / production parity. Examples of user runtimes are Node.js, SpringBoot or MongoDB, and MySQL. From ba04363d91cb0c122044eb5f94a6b4f9f5b3f300 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 25/40] Fix language on modules/administration-guide/partials/con_che-workspaces-architecture.adoc --- .../partials/con_che-workspaces-architecture.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/con_che-workspaces-architecture.adoc b/modules/administration-guide/partials/con_che-workspaces-architecture.adoc index a4de92d092..57648e68ca 100644 --- a/modules/administration-guide/partials/con_che-workspaces-architecture.adoc +++ b/modules/administration-guide/partials/con_che-workspaces-architecture.adoc @@ -1,7 +1,7 @@ [id="{prod-id-short}-workspaces-architecture_{context}"] = {prod-short} workspaces architecture -A {prod-short} deployment on the cluster consists of the {prod-short} server component, a database for storing user profile and preferences, and a number of additional deployments hosting workspaces. The {prod-short} server orchestrates the creation of workspaces, which consist of a deployment containing the workspace containers and enabled plug-ins, plus related components, such as: +A {prod-short} deployment on the cluster consists of the {prod-short} server component, a database for storing user profile and preferences, and several additional deployments hosting workspaces. The {prod-short} server orchestrates the creation of workspaces, which consist of a deployment containing the workspace containers and enabled plug-ins, plus related components, such as: * ConfigMaps * services From ac484bec81a85228768e8a125b745d93505b143d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 26/40] Fix language on modules/administration-guide/partials/con_controller-requirements.adoc --- .../partials/con_controller-requirements.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/administration-guide/partials/con_controller-requirements.adoc b/modules/administration-guide/partials/con_controller-requirements.adoc index 8eae3fca77..a2db91a43d 100644 --- a/modules/administration-guide/partials/con_controller-requirements.adoc +++ b/modules/administration-guide/partials/con_controller-requirements.adoc @@ -19,22 +19,22 @@ The Workspace Controller consists of a set of five services running in five dist |512 MiB |PostgreSQL -|postgres +|`postgres` |1 GiB |512 MiB |{identity-provider} -|{identity-provider-id} +|`{identity-provider-id}` |2 GiB |512 MiB |Devfile registry -|che-devfile-registry +|`che-devfile-registry` |256 MiB |16 MiB |Plug-in registry -|che-plugin-registry +|`che-plugin-registry` |256 MiB |16 MiB |=== From e7bd4389f86c528196c44f1e4f36f2ea8c0bb38d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 27/40] Fix language on modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc --- .../proc_building-a-custom-devfile-registry-image.adoc | 3 --- 1 file changed, 3 deletions(-) diff --git a/modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc b/modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc index 1e9faf2204..d094fdf47d 100644 --- a/modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc +++ b/modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc @@ -50,10 +50,7 @@ tags, List of tags. Tags typically include the tools included in the stack. + .Example devfile `meta.yaml` ==== -[source,yaml] ----- include::example$snip_{project-context}-devfile-meta.adoc[] ----- ==== . Build a custom devfile registry image: From 76e19370135ab247fd52cb218fa95cf970a01c24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 28/40] Fix language on modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc --- .../proc_building-a-custom-plug-in-registry-image.adoc | 3 --- 1 file changed, 3 deletions(-) diff --git a/modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc b/modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc index ee3f3e5b9a..77c7aef72b 100644 --- a/modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc +++ b/modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc @@ -50,10 +50,7 @@ include::example$snip_{project-context}-clone-the-plug-in-registry-repository.ad + .Example plug-in files tree ==== -[subs="+attributes"] ----- include::example$snip_{project-context}-plug-in-tree.adoc[] ----- ==== . Build a custom plug-ins registry image: From ddbe2f224701d0a89bff02fe206961f4c1045cf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 29/40] Fix language on modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc --- .../proc_collecting-che-metrics-with-prometheus.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc b/modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc index 232d8b2fd6..55354d7ed8 100644 --- a/modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc +++ b/modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc @@ -16,10 +16,9 @@ This section describes how to use the Prometheus monitoring system to collect, s * Configure Prometheus to scrape metrics from the `8087` port: + .Prometheus configuration example -[source,yaml,subs="+attributes"] ----- +==== include::example$prometheus-config.adoc[] ----- +==== ifeval::["{project-context}" == "che"] + Latest version: link:https://github.com/eclipse/che/blob/master/deploy/openshift/templates/monitoring/prometheus-config.yaml[example `prometheus-config.yaml` on GitHub]. From 20b44242d303e8e610c552b2b729496a43f8aebb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 30/40] Fix language on modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc --- .../partials/proc_configuring_bitbucket_servers.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc b/modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc index 79e5d51099..e02f9bf244 100644 --- a/modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc +++ b/modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc @@ -7,7 +7,7 @@ To make it possible to use the Bitbucket server as a project sources supplier, Bitbucket server URL should be registered on {prod} using the `CHE_INTEGRATION_BITBUCKET_SERVER__ENDPOINTS` property. Value of the property must contain the hostname of the server to register. -Examples on how to change configuration options using Helm/Operator can be found here: +Examples on how to change configuration options using Helm or the Operator can be found here: * xref:installation-guide:advanced-configuration-options-for-the-che-server-component.adoc[] From 0909791c11f31d1e93c344d9991d9e8694b4cc20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 31/40] Fix language on modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc --- ...-on-kubernetes-using-the-image-puller-operator.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc b/modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc index 08365fa120..f5219f4cdd 100644 --- a/modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc +++ b/modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc @@ -24,11 +24,11 @@ kubectl create namespace __<{image-puller-deployment-name}>__ [source,shell,subs="+quotes,+attributes"] ---- export NAMESPACE=__<{image-puller-deployment-name}>__ -{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/kubernetes-image-puller-operator/master/deploy/crds/che.eclipse.org_kubernetesimagepullers_crd.yaml -n $NAMESPACE -{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/kubernetes-image-puller-operator/master/deploy/role.yaml -n $NAMESPACE -{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/kubernetes-image-puller-operator/master/deploy/role_binding.yaml -n $NAMESPACE -{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/kubernetes-image-puller-operator/master/deploy/service_account.yaml -n $NAMESPACE -{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/kubernetes-image-puller-operator/master/deploy/operator.yaml -n $NAMESPACE +{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/{image-puller-operator-repository-name}/master/deploy/crds/che.eclipse.org_kubernetesimagepullers_crd.yaml -n $NAMESPACE +{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/{image-puller-operator-repository-name}/master/deploy/role.yaml -n $NAMESPACE +{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/{image-puller-operator-repository-name}r/master/deploy/role_binding.yaml -n $NAMESPACE +{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/{image-puller-operator-repository-name}/master/deploy/service_account.yaml -n $NAMESPACE +{orch-cli} apply -f https://raw.githubusercontent.com/che-incubator/{image-puller-operator-repository-name}/master/deploy/operator.yaml -n $NAMESPACE ---- . Create a `{image-puller-cr-name}` Custom Resource: From b7ee8bcd9c313df85ddbdf4d71b5af014a079f8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 32/40] Fix language on modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc --- .../partials/proc_installing-image-puller-using-helm.adoc | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc b/modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc index e31305a824..f5587821f3 100644 --- a/modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc +++ b/modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc @@ -22,9 +22,10 @@ NOTE: When installing on OpenShift, replace the `{orch-cli}` command by `oc`. . Clone the {image-puller-name} repository: + +[subs="+quotes,+attributes"] ---- -$ git clone https://github.com/che-incubator/kubernetes-image-puller -$ cd kubernetes-image-puller +$ git clone https://github.com/che-incubator/{image-puller-repository-name} +$ cd {image-puller-repository-name} ---- . Create a {orch-namespace} to deploy the puller into: @@ -92,8 +93,9 @@ $ {orch-cli} create namespace k8s-image-puller . Run the `helm` installation command: + +[subs="+attributes"] ---- -$ helm install kubernetes-image-puller --namespace k8s-image-puller deploy/helm +$ helm install {image-puller-deployment-name} --namespace k8s-image-puller deploy/helm ---- + [NOTE] From f74027dfb6bc5a7a43cae733e307b650be156106 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 33/40] Fix language on modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc --- .../proc_viewing-che-metrics-on-grafana-dashboards.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc b/modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc index bc130ac184..38fa40d6df 100644 --- a/modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc +++ b/modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc @@ -18,7 +18,7 @@ This section describes how to view {prod-short} metrics on Grafana dashboards. + Three ConfigMaps are used to configure Grafana: + -* `grafana-datasources` -- configuration for Grafana datasource, a Prometheus endpoint +* `grafana-datasources` -- configuration for Grafana data source, a Prometheus endpoint * `grafana-dashboards` -- configuration of Grafana dashboards and panels * `grafana-dashboard-provider` -- configuration of the Grafana dashboard provider API object, which tells Grafana where to look in the file system for pre-provisioned dashboards From fb3d4f4e9314f937850d63ab5d2c2dfe02a5f977 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 34/40] Fix language on modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc --- .../partials/proc_viewing-che-traces-in-jaeger-ui.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc b/modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc index ac67049ec1..1e874164db 100644 --- a/modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc +++ b/modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc @@ -3,7 +3,7 @@ [id="viewing-{prod-id-short}-traces-in-jaeger-ui_{context}"] = Viewing {prod-short} traces in Jaeger UI -This section demonstrates how to utilize the Jaeger UI to overview traces of {prod-short} operations. +This section demonstrates how to use the Jaeger UI to overview traces of {prod-short} operations. .Procedure From b49688a823d5252b083ec9d9a991758f32cc474b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 35/40] Fix language on modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc --- .../partials/proc_viewing-keycloak-server-logs.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc b/modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc index 2850b8f34d..e89abef0ac 100644 --- a/modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc +++ b/modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc @@ -13,8 +13,11 @@ This section describes how to view the {identity-provider} OpenID provider serve . In the *Filter by label* search field, type `keycloak` to see the {identity-provider} logs. +pass:[] . In the *Deployment Configs* section, click the `keycloak` link to open it. +pass:[] + . In the *History* tab, click the *View log* link for the active {identity-provider} deployment. . The {identity-provider} logs are displayed. From 436ddc30714d24c90f4cc96e459bf6152816c693 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 36/40] Fix language on modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc --- .../partials/proc_viewing-postgresql-server-logs.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc b/modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc index 94af7b9475..66d879aab2 100644 --- a/modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc +++ b/modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc @@ -23,7 +23,7 @@ This section describes how to view the database logs in {prod-short}, such as Po + The OpenShift Web Console is searching base on those two keys and displays PostgreSQL logs. -. Click *postgres* deployment to open it. +. Click *`postgres`* deployment to open it. . Click the *View log* link for the active PostgreSQL deployment. + From f3d874b136adda08af2f7d42804c68097449cc84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 37/40] Fix language on modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc --- ...e-che-cluster-deployment-using-openshift-4-cli-tools.adoc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc b/modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc index c783fc0c30..4830682eb3 100644 --- a/modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc +++ b/modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc @@ -52,8 +52,5 @@ $ oc logs --tail=10 -f `(oc get pods -o name | grep operator)` + .Logs of the Operator: ==== -[options="nowrap",role="white-space-pre",subs="+quotes,+attributes"] ----- -include::example${project-context}-cluster-deployment-openshift-logs.adoc[] ----- +include::example$snip_{project-context}-cluster-deployment-openshift-logs.adoc[] ==== From bf5ecd8171ec4bbf0ac3179f76bb1dd7d533a353 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 38/40] Fix language on modules/administration-guide/partials/prometheus-config.adoc --- .../partials/prometheus-config.adoc | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 modules/administration-guide/partials/prometheus-config.adoc diff --git a/modules/administration-guide/partials/prometheus-config.adoc b/modules/administration-guide/partials/prometheus-config.adoc deleted file mode 100644 index eb3f57039c..0000000000 --- a/modules/administration-guide/partials/prometheus-config.adoc +++ /dev/null @@ -1,13 +0,0 @@ -apiVersion: v1 -kind: ConfigMap -metadata: - name: prometheus-config -data: - prometheus.yml: |- - global: - scrape_interval: 5s <1> - evaluation_interval: 5s <2> - scrape_configs: <3> - - job_name: 'che' - static_configs: - - targets: ['[che-host]:8087'] <4> From 7ae9f5844ce1a90fc52ca290f8e48d1d514ae785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:15 +0200 Subject: [PATCH 39/40] Fix language on modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc --- .../partials/ref_grafana-dashboards-for-che.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 d975a9c279..52a9586fec 100644 --- a/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc +++ b/modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc @@ -125,7 +125,7 @@ image::monitoring/monitoring-che-che-server-dashboard-workspace-detailed-panel-2 == {prod-short} server JVM dashboard -Use case: JVM metrics of the {prod-short} server, such as JVM memory or classloading. +Use case: JVM metrics of the {prod-short} server, such as JVM memory or class loading. .{prod-short} server JVM dashboard image::monitoring/monitoring-che-che-server-jvm-dashboard.png[link="../_images/monitoring/monitoring-che-che-server-jvm-dashboard.png"] @@ -148,7 +148,7 @@ image::monitoring/monitoring-che-che-server-jvm-dashboard-jvm-memory-pools-non-h .Garbage Collection image::monitoring/monitoring-che-che-server-jvm-dashboard-garbage-collection.png[link="../_images/monitoring/monitoring-che-che-server-jvm-dashboard-garbage-collection.png"] -.Classloading +.Class loading image::monitoring/monitoring-che-che-server-jvm-dashboard-classloading.png[link="../_images/monitoring/monitoring-che-che-server-jvm-dashboard-classloading.png"] .Buffer Pools From 18aaf209f0672c1c515e34cad55ab9cc17cb71c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 31 Mar 2021 20:47:39 +0200 Subject: [PATCH 40/40] New attributes --- antora-playbook.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/antora-playbook.yml b/antora-playbook.yml index 6f0ad5cf7f..74fafe2a12 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -55,8 +55,10 @@ asciidoc: image-puller-images: "java11-maven=quay.io/eclipse/che-java11-maven:nightly;che-theia=quay.io/eclipse/che-theia:next;java-plugin-runner=eclipse/che-remote-plugin-runner-java8:latest;" image-puller-operator-name: Kubernetes Image Puller Operator image-puller-operator-id: kubernetes-image-puller-operator + image-puller-operator-repository-name: kubernetes-image-puller-operator image-puller-name: Kubernetes Image Puller image-puller-name-short: Image Puller + image-puller-repository-name: kubernetes-image-puller image-puller-serviceaccount-name: k8s-image-puller kubernetes: Kubernetes link-accessing-a-git-repository-via-https: xref:end-user-guide:version-control.adoc#accessing-a-git-repository-via-https_che[Accessing a Git repository using HTTPS]