Skip to content

Commit

Permalink
Fixing typos in multiple docs and enhancing the oc procedure (#1073)
Browse files Browse the repository at this point in the history
* Fixing typos in multiple docs and enhancing the oc procedure

Signed-off-by: Michal Maléř <mmaler@redhat.com>

* Update src/main/pages/che-7/administration-guide/proc_enabling-che-metrics-collections.adoc

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
  • Loading branch information
MichalMaler and themr0c authored Feb 17, 2020
1 parent c2d9f34 commit a8985c9
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ The requested value is included in the service name that contains the `collector


.Additional resources
* For additional information about custom environment properties and how to define them in CheCluster Customer Resource, see link:https://www.eclipse.org/che/docs/che-7/advanced-configuration-options/[Advanced configuration options].
* For additional information about custom environment properties and how to define them in CheCluster Custom Resource, see link:{site-baseurl}/che-7/advanced-configuration-options/[Advanced configuration options].
* For custom configuration of Jaeger, see the list of link:https://github.com/jaegertracing/jaeger-client-go#environment-variables[Jaeger client environment variables].
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This section describes how to upgrade from {prod-short} {prod-prev-ver} to {prod

. Shut down all workspaces in the {prod-short} {prod-prev-ver} instance.

. Run following command:
. Run the following command:
+
[subs="+attributes,+quotes"]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,35 +1,30 @@
[id="finding-{prod-id-short}-cluster-url-using-openshift-4-cli-tools_{context}"]
= Finding {prod-short} cluster URL using the OpenShift 4 CLI

This section describes how to obtain the {prod-short} cluster URL using the OpenShift 4 CLI (command line interface). The URL can be retrieved from the OpenShift logs or from the `checluster` Customer Resource.

This section describes how to obtain the {prod-short} cluster URL using the OpenShift 4 CLI (command line interface). The URL can be retrieved from the OpenShift logs or from the `checluster` Custom Resource.
.Prerequisites
* {prod-short} is deployed in a OpenShift cluster. Verify the state of the deployment, see xref:viewing-the-state-of-the-{prod-id-short}-cluster-deployment-using-openshift-4-cli-tools_{context}[].
* {prod-short} is deployed in an OpenShift cluster. To verify the state of the deployment, see xref:viewing-the-state-of-the-{prod-id-short}-cluster-deployment-using-openshift-4-cli-tools_{context}[].
* User is located in a {prod-short} installation namespace.

.Procedure

. To retrieve a {prod-short} cluster URL from the `checluster` CR, run:
. To retrieve a {prod-short} cluster URL from the `checluster` CR (Custom Resource), run:
+
[options="nowrap",role=white-space-pre]
----
$ oc get checluster --output jsonpath='{.items[0].status.cheURL}'
----

. The {prod-short} cluster URL is displayed.
////
+
Alternatively, wait for the logs to show the message `{prod} is now available at:` followed by the {prod-short} cluster URL:

Alternatively, wait for the deployment logs as mentioned in the Prerequisites section to display the message: `{prod} is now available at:` followed by the {prod-short} cluster URL:
+
[subs="+attributes",options="nowrap",role=white-space-pre]
----
include::examples/{project-context}-cluster-url-logs.log[]
----
+
After the deployment is finished, click the {prod-short} cluster URL in the log output or use the following command to filter it out:
After the deployment is finished, in the log output, click the {prod-short} cluster URL to start the {prod-shor} instance, or use the following command to isolate it:
+
[options="nowrap",role=white-space-pre]
----
$ oc logs --tail=10 `oc get pods --output name | grep operator` | grep "available at" | awk -F'available at: ' '{print $2}' | sed 's/"//'
$ oc logs --tail=10 `oc get pods -o name | grep operator` | \
grep "available at" | \
awk -F'available at: ' '{print $2}' | sed 's/"//'
----
////
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section describes how to install {prod-short} on CodeReady Containers using
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section describes how to install {prod-short} on Minikube using chectl.
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section describes how to install {prod-short} on Minishift using chectl.
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section describes how to install {prod} in multi-user mode on CodeReady Con
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section describes how to install {prod} in multi-user mode on Minikube usin
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section describes how to install {prod} in multi-user mode on Minishift usi
[discrete]
== Procedure

* Run following command:
* Run the following command:
+
[subs="+attributes"]
----
Expand Down

0 comments on commit a8985c9

Please sign in to comment.