Add a module on installing with chectl on OCP 4. #1801

yhontyk · 2021-01-20T00:17:43Z

Read our Contribution guide before submitting a PR.

What does this PR do?

What issues does this PR fix or reference?

Specify the version of the product this PR applies to.

PR Checklist

As the author of this Pull Request I made sure that:

vale has been run successfully against the PR branch
Link checker has been run successfully against the PR branch
Documentation describes a scenario that is already covered by QE tests, otherwise an issue has been created and acknowledged by Che QE team
Changed article references are updated where they are used (or a redirect has been set up on the docs side):
- Dashboard branding.json
- Chectl constants.ts

yhontyk · 2021-01-20T00:41:28Z

Hi @tolusha could you take a look when you have time? I used E2E tests as a reference but removed steps like disabling telemetry though - let me know if we should keep it or maybe add a note about it.
I also assume this procedure is the same for upstream and downstream so we can single-source the file.

tolusha · 2021-01-20T07:35:48Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+
+.Prerequisites
+
+* `oc` is installed on the cluster. See link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#installing-the-cli[Installing the CLI].


I wouldn't say that on the cluster is correct since it should be installed on the local machine for user to connect to cluster.

tolusha · 2021-01-20T07:36:14Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+
+* `oc` is installed on the cluster. See link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#installing-the-cli[Installing the CLI].
+
+* `{prod-cli}` is installed on the cluster. See xref:using-the-chectl-management-tool.adoc[].


I wouldn't say that on the cluster is correct since it should be installed on the local machine for user to deploy product on the cluster.

tolusha · 2021-01-20T07:36:42Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+
+* `{prod-cli}` is installed on the cluster. See xref:using-the-chectl-management-tool.adoc[].
+
+* __<namespace>__ represents the project of the target installation.


That's not necessary since {prod-cli} will create namespace if it doesn't exist.

tolusha · 2021-01-20T07:38:23Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+$ oc login
+----
+
+. Run the following command to verify that the version of the `oc` OpenShift CLI management tool is 4.6:


oc version command should be run before oc login

tolusha · 2021-01-20T07:41:12Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+$ oc login
+----
+
+. Run the following command to verify that the version of the `oc` OpenShift CLI management tool is 4.6:


It is better to say '...the version of the oc OpenShift CLI management tool matches OpenShift cluster version:'

tolusha · 2021-01-20T07:43:46Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+.Procedure
+
+. Log in to OpenShift. See link:https://docs.openshift.com/container-platform/4.6/cli_reference/openshift_cli/getting-started-cli.html#cli-logging-in_cli-developer-commands[Logging in to the CLI].
+


Instead of having fixed version of OCP in the link we can use latest, for instance:
https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#cli-logging-in_cli-developer-commands

This step is a prerequisite, it should move in the accurate section. Maybe refine "oc is available." to precise it should have same version as the target OpenShift cluster.

tolusha · 2021-01-20T07:45:36Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+
+[subs="+quotes,+attributes",options="nowrap"]
+----
+$ {prod-cli} server:deploy -n _<namespace>_ 


-n _<namespace>_ isn't mandatory but it is better to use -n {prod-namespace}
Another point: chectl requires --platform openshift flag but crwctl doesn't need that.

@tolusha thanks, I've addressed all comments above, and moved this command to a separate file so in the downstream we can define it with no flag.

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

yhontyk · 2021-01-22T12:27:15Z

@rkratky @themr0c @MichalMaler could smb please review this PR when you have time?

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

themr0c · 2021-01-26T09:14:41Z

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

+Client Version: 4.6.1
+----
+
+. Log in to OpenShift. See link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#cli-logging-in_cli-developer-commands[Logging in to the CLI].


Move to prerequites.

themr0c · 2021-01-26T10:26:45Z

modules/installation-guide/partials/assembly_installing-che-on-openshift-4-using-cli.adoc

@@ -0,0 +1,15 @@
+:parent-context-of-installing-che-on-openshift-4-using-cli: {context}


As the assembly has only one include, can we just omit it and have only the procedure?

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc

themr0c · 2021-01-26T13:35:52Z

We miss an entry in nav.adoc

themr0c · 2021-01-26T15:13:21Z

Too many commits after last push. Can you rebase on upstream master again?

themr0c · 2021-01-26T15:23:03Z

Can you try pass the vale checks using vale scoping? See: https://docs.errata.ai/vale/scoping#markup-based-configuration

* Add a module on installing with chectl on OCP 4. * Put the whole codevlock in examples/ * endif to exceptions * raise redbility grade * change severity * add links to ignore

yhontyk requested review from MichalMaler, rkratky, themr0c and a team as code owners January 20, 2021 00:17

yhontyk requested review from tolusha and removed request for a team January 20, 2021 00:17

che-bot added the status/code-review label Jan 20, 2021

tolusha reviewed Jan 20, 2021

View reviewed changes

yhontyk changed the title ~~[WIP - Do not merge] Add a module on installing with chectl on OCP 4.~~ Add a module on installing with chectl on OCP 4. Jan 20, 2021

tolusha reviewed Jan 20, 2021

View reviewed changes

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc Outdated Show resolved Hide resolved

tolusha approved these changes Jan 20, 2021

View reviewed changes

che-bot added the kind/enhancement label Jan 20, 2021

themr0c reviewed Jan 26, 2021

View reviewed changes

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc Show resolved Hide resolved

themr0c reviewed Jan 26, 2021

View reviewed changes

themr0c self-assigned this Jan 26, 2021

themr0c reviewed Jan 26, 2021

View reviewed changes

modules/installation-guide/partials/proc_installing-che-on-openshift-4-using-the-cli.adoc Outdated Show resolved Hide resolved

themr0c mentioned this pull request Jan 26, 2021

Use the che-docs container for github workflow actions in che-docs eclipse-che/che#18865

Closed

themr0c approved these changes Jan 26, 2021

View reviewed changes

Add a module on installing with chectl on OCP 4.

79cfa6e

Yana Hontyk added 5 commits January 26, 2021 16:29

Put the whole codevlock in examples/

ab67754

endif to exceptions

a1a3b56

raise redbility grade

d38793d

change severity

aea55e2

add links to ignore

49c0b4c

yhontyk merged commit 41e2ef8 into eclipse-che:master Jan 27, 2021

yhontyk deleted the installingOnOpenShift4 branch January 27, 2021 08:35

che-bot removed the status/code-review label Jan 27, 2021

che-bot added this to the 7.26 milestone Jan 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a module on installing with chectl on OCP 4. #1801

Add a module on installing with chectl on OCP 4. #1801

yhontyk commented Jan 20, 2021 •

edited

Loading

yhontyk commented Jan 20, 2021

tolusha Jan 20, 2021

tolusha Jan 20, 2021

tolusha Jan 20, 2021

tolusha Jan 20, 2021

tolusha Jan 20, 2021 •

edited

Loading

tolusha Jan 20, 2021

themr0c Jan 26, 2021

tolusha Jan 20, 2021

yhontyk Jan 20, 2021

yhontyk commented Jan 22, 2021

themr0c Jan 26, 2021

themr0c Jan 26, 2021

themr0c commented Jan 26, 2021

themr0c commented Jan 26, 2021

themr0c commented Jan 26, 2021


		.Prerequisites

		* `oc` is installed on the cluster. See link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#installing-the-cli[Installing the CLI].


		* `oc` is installed on the cluster. See link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#installing-the-cli[Installing the CLI].

		* `{prod-cli}` is installed on the cluster. See xref:using-the-chectl-management-tool.adoc[].


		* `{prod-cli}` is installed on the cluster. See xref:using-the-chectl-management-tool.adoc[].

		* __<namespace>__ represents the project of the target installation.

		@@ -0,0 +1,15 @@
		:parent-context-of-installing-che-on-openshift-4-using-cli: {context}

Add a module on installing with chectl on OCP 4. #1801

Add a module on installing with chectl on OCP 4. #1801

Conversation

yhontyk commented Jan 20, 2021 • edited Loading

What does this PR do?

What issues does this PR fix or reference?

Specify the version of the product this PR applies to.

PR Checklist

yhontyk commented Jan 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tolusha Jan 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yhontyk commented Jan 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

themr0c commented Jan 26, 2021

themr0c commented Jan 26, 2021

themr0c commented Jan 26, 2021

yhontyk commented Jan 20, 2021 •

edited

Loading

tolusha Jan 20, 2021 •

edited

Loading