Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix vale rules in administration guide #1941

Merged
merged 40 commits into from
Apr 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
985c6a8
Fix vale errors. Refresh description from https://docs.openshift.com/…
themr0c Mar 30, 2021
06156eb
Fix language
themr0c Mar 30, 2021
df982c3
Vale config changes
themr0c Mar 31, 2021
c08d685
Vale config changes
themr0c Mar 31, 2021
588d285
Fix language on modules/end-user-guide/partials/proc_importing-certif…
themr0c Mar 31, 2021
8e4a341
Accept Webview
themr0c Mar 31, 2021
bb57df0
Accept Omnisharp
themr0c Mar 31, 2021
107d32b
Use 'OmniSharp'
themr0c Mar 31, 2021
7b882f4
Fix language on modules/end-user-guide/partials/proc_viewing-netcored…
themr0c Mar 31, 2021
ab3ec48
Decreasing the severity of the IBM.Annotations rule, as [NOTE] is a l…
themr0c Mar 31, 2021
9debaf7
More vale config
themr0c Mar 31, 2021
1745486
Fix language on modules/end-user-guide/partials/proc_viewing-netcored…
themr0c Mar 31, 2021
26bbad1
Fix language on modules/end-user-guide/partials/proc_verifying-the-st…
themr0c Mar 31, 2021
ac7d56e
deleted: modules/end-user-guide/partials/proc_verifying-the-state-…
themr0c Mar 31, 2021
c653392
More vale config again
themr0c Mar 31, 2021
7a5a806
Vale config
themr0c Mar 31, 2021
4edddde
Rename example to fix vale errors
themr0c Mar 31, 2021
ce2e47c
Fix language on modules/administration-guide/examples/prometheus-conf…
themr0c Mar 31, 2021
0593d9d
Fix language on modules/administration-guide/examples/snip_che-clonin…
themr0c Mar 31, 2021
0fbfc4e
Fix language on modules/administration-guide/examples/snip_che-devfil…
themr0c Mar 31, 2021
3571232
Fix language on modules/administration-guide/examples/snip_che-plug-i…
themr0c Mar 31, 2021
2bb4326
Fix language on modules/administration-guide/partials/assembly_tracin…
themr0c Mar 31, 2021
6ab0abe
Fix language on modules/administration-guide/partials/con_caching-ima…
themr0c Mar 31, 2021
df09398
Fix language on modules/administration-guide/partials/con_che-user-ru…
themr0c Mar 31, 2021
ba04363
Fix language on modules/administration-guide/partials/con_che-workspa…
themr0c Mar 31, 2021
ac484be
Fix language on modules/administration-guide/partials/con_controller-…
themr0c Mar 31, 2021
e7bd438
Fix language on modules/administration-guide/partials/proc_building-a…
themr0c Mar 31, 2021
76e1937
Fix language on modules/administration-guide/partials/proc_building-a…
themr0c Mar 31, 2021
ddbe2f2
Fix language on modules/administration-guide/partials/proc_collecting…
themr0c Mar 31, 2021
20b4424
Fix language on modules/administration-guide/partials/proc_configurin…
themr0c Mar 31, 2021
0909791
Fix language on modules/administration-guide/partials/proc_installing…
themr0c Mar 31, 2021
b7ee8bc
Fix language on modules/administration-guide/partials/proc_installing…
themr0c Mar 31, 2021
f74027d
Fix language on modules/administration-guide/partials/proc_viewing-ch…
themr0c Mar 31, 2021
fb3d4f4
Fix language on modules/administration-guide/partials/proc_viewing-ch…
themr0c Mar 31, 2021
b49688a
Fix language on modules/administration-guide/partials/proc_viewing-ke…
themr0c Mar 31, 2021
436ddc3
Fix language on modules/administration-guide/partials/proc_viewing-po…
themr0c Mar 31, 2021
f3d874b
Fix language on modules/administration-guide/partials/proc_viewing-th…
themr0c Mar 31, 2021
bf5ecd8
Fix language on modules/administration-guide/partials/prometheus-conf…
themr0c Mar 31, 2021
7ae9f58
Fix language on modules/administration-guide/partials/ref_grafana-das…
themr0c Mar 31, 2021
18aaf20
New attributes
themr0c Mar 31, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .vale/styles/Vocab/Che/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ GitHub|github
GitLab
Gluster
Gradle
Grafana
[Gg]rafana
GUI
HTTPS|https
heatmap
Expand All @@ -49,7 +49,7 @@ item
Java
[Jj]etbrains
jvm|JVM
helm
[Hh]elm
hostname
kbd
Keycloak|keycloak
Expand All @@ -66,7 +66,7 @@ millicores
[Mm]inishift
[Mm]ixin
[Mm]ixins
multiuser
[Mm]ultiuser
MySQL
namespace
namespaces
Expand Down
2 changes: 2 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 4 additions & 0 deletions modules/administration-guide/examples/prometheus-config.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[source,yaml,subs="+attributes"]
----
apiVersion: v1
kind: ConfigMap
metadata:
Expand All @@ -11,3 +13,5 @@ data:
- job_name: 'che'
static_configs:
- targets: ['[che-host]:8087'] <4>
----

Original file line number Diff line number Diff line change
@@ -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
----
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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"
----

Original file line number Diff line number Diff line change
@@ -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
----

Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[subs="+attributes"]
----
$ tree che-plugin-registry/v3/plugins/redhat/java/
che-plugin-registry/v3/plugins/redhat/java/
├── 0.38.0
Expand All @@ -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
----

Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,32 +51,31 @@ endif::[]
|`k8s-image-puller`

|`IMAGES`
pass:[<!-- vale IBM.Ellipses = NO -->]
|Semicolon separated list of images to pull, in the format `__<name>__=__<image>__;...` See xref:defining-the-list-of-images-to-pull.adoc[].
|Semicolon separated list of images to pull, in the format `__<name1>__=__<image1>__;__<name2>__=__<image2>__` See xref:defining-the-list-of-images-to-pull.adoc[].
|
pass:[<!-- vale IBM.Ellipses = YES -->]

|`NODE_SELECTOR`
|Node selector to apply to the Pods created by the DaemonSet
|`'{}'`
|===

.Additional resources

pass:[<!-- vale CheDocs.Attributes = NO -->]
.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:[<!-- vale CheDocs.Attributes = YES -->]
* link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository]

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:[<!-- vale Vale.Spelling = NO -->]
. In the *Deployment Configs* section, click the `keycloak` link to open it.

pass:[<!-- vale Vale.Spelling = YES -->]

. In the *History* tab, click the *View log* link for the active {identity-provider} deployment.

. The {identity-provider} logs are displayed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
====
13 changes: 0 additions & 13 deletions modules/administration-guide/partials/prometheus-config.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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
Expand Down