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 create workspace section using chectl #1698

Merged
merged 5 commits into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ include::partial$proc_logging-in-to-che-on-openshift-for-the-first-time-using-oa

include::partial$proc_logging-in-to-che-on-openshift-for-the-first-time-registering-as-a-new-user.adoc[leveloffset=+1]

include::partial$proc_finding-che-cluster-url-using-openshift-4-cli-tools.adoc[leveloffset=+1]
include::partial$proc_logging-in-to-che-server-using-cli.adoc[leveloffset=+1]

include::partial$proc_finding-che-cluster-url-using-openshift-4-cli-tools.adoc[leveloffset=+1]

:context: {parent-context-of-navigating-che-using-the-dashboard}
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,22 @@ A {prod-short} workspace can be created by pointing the `{prod-cli}` tool to a l
* A running instance of {prod}. To install an instance of {prod}, see xref:installation-guide:installing-che.adoc[].
* The {prod-short} CLI management tool. See xref:overview:using-the-chectl-management-tool.adoc[].
* The devfile is available on the local filesystem in the current working directory. See xref:making-a-workspace-portable-using-a-devfile.adoc[] for detailed information about creating and using devfiles.
* You are logged in to {prod}. See xref:end-user-guide:navigating-{prod-id-short}-using-the-dashboard.adoc#logging-in-to-{prod-id}-using-{prod-cli}_navigating-{prod-id-short}-using-the-dashboard[How to login into {prod-short} using {prod-cli}]

+
.Example
Download the `devfile.yaml` file from the link:https://github.com/eclipse/che/blob/master/devfile.yaml[GitHub repository] to the current working directory.

.Procedure
. Run a workspace from a devfile using the `workspace:start` parameter with the `{prod-cli}` tool as follows:
. Run a workspace from a devfile using the `workspace:create` parameter with the `{prod-cli}` tool as follows:

[subs="+attributes,+quotes"]
----
$ {prod-cli} workspace:start --devfile=devfile.yaml
$ {prod-cli} workspace:create --name=__<WORKSPACE_NAME>__ \ <1>
--devfile=devfile.yaml --start \
-n {prod-namespace}
----
<1> The workspace name to create

NOTE: If `--devfile` flag is omitted then {prod-cli} looks for `devfile.yaml` or `devfile.yml` files in the current directory to create a workspace from.

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[id="logging-in-to-{prod-id}-using-{prod-cli}_{context}"]
= Logging in to {prod-short} using {prod-cli}

This section describes how to log in to {prod-short} using {prod-cli} tool by copying login command from {prod} Dashboard.

.Prerequisites
* A running instance of {prod}. To install an instance of {prod}, see xref:installation-guide:installing-che.adoc[].
* The {prod-short} CLI management tool. See xref:overview:using-the-chectl-management-tool.adoc[].
* {prod} Dashboard is opened in a browser.

.Procedure
. Open the user's context menu in the lower-left corner and select `Copy Login Command`
+
image::loggingin/copy_login_command_menu.png[copy_login_command_menu.png]

. Wait for the notification message:
+
image::loggingin/copy_login_command_notification.png[copy_login_command_notification.png]

. Paste the login command into a terminal and observe a successful login:
+
```
$ chectl auth:login ...
Successfully logged into <server> as <user>
```