You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dlab.apache.org by dg...@apache.org on 2020/02/27 08:44:44 UTC
[incubator-dlab] 01/01: Updated user guide
This is an automated email from the ASF dual-hosted git repository.
dgnatyshyn pushed a commit to branch user_guide
in repository https://gitbox.apache.org/repos/asf/incubator-dlab.git
commit bf7126bf9c0a9709237fc17b0958a18533d91abd
Author: Dmytro Gnatyshyn <di...@ukr.net>
AuthorDate: Tue Feb 11 12:34:46 2020 +0200
Updated user guide
---
USER_GUIDE.md | 183 +++++++++------------------------
doc/billing_filter.png | Bin 18705 -> 41447 bytes
doc/computational_scheduler.png | Bin 33900 -> 35577 bytes
doc/computational_scheduler_create.png | Bin 3893 -> 3277 bytes
doc/delete_group.png | Bin 34704 -> 45914 bytes
doc/emr_creating.png | Bin 37126 -> 43196 bytes
doc/emr_terminate_confirm.png | Bin 1760535 -> 14257 bytes
doc/environment_management.png | Bin 66404 -> 90301 bytes
doc/git_creds_window.png | Bin 7190623 -> 25654 bytes
doc/git_creds_window2.png | Bin 5946035 -> 26511 bytes
doc/main_page.png | Bin 4746590 -> 35533 bytes
doc/main_page2.png | Bin 8157879 -> 49611 bytes
doc/main_page3.png | Bin 8157879 -> 48735 bytes
doc/main_page_filter.png | Bin 62679 -> 79991 bytes
doc/manage_env_confirm.png | Bin 10464 -> 14049 bytes
doc/manage_environment.png | Bin 21334 -> 17936 bytes
doc/manage_role.png | Bin 108456 -> 28068 bytes
doc/managemanage_resource_actions.png | Bin 4997 -> 4976 bytes
doc/notebook_create.png | Bin 41323 -> 35451 bytes
doc/notebook_libs_status.png | Bin 50720 -> 59233 bytes
doc/notebook_scheduler.png | Bin 36928 -> 39368 bytes
doc/notebook_terminated.png | Bin 38113 -> 56038 bytes
doc/notebook_terminating.png | Bin 39506 -> 56292 bytes
doc/spark_stop_confirm.png | Bin 10920 -> 12767 bytes
doc/upload_or_generate_user_key.png | Bin 17078 -> 37302 bytes
25 files changed, 46 insertions(+), 137 deletions(-)
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index d821a93..d8a5393 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -10,7 +10,7 @@ DLab is an essential toolset for analytics. It is a self-service Web Console, us
[Login](#login)
-[Setup a Gateway/Edge node](#setup_edge_node)
+[Create project](#setup_edge_node)
[Setting up analytical environment and managing computational power](#setup_environmen)
@@ -36,19 +36,17 @@ DLab is an essential toolset for analytics. It is a self-service Web Console, us
[Git UI tool (ungit)](#git_ui)
-[DLab Health Status Page](#health_page)
+[Administration](#administration)
- [Backup](#backup)
+ [Manage roles](#manage_roles)
- [Manage environment](#manage_environment)
+ [Environment Management Page](#environment_management)
- [Manage roles](#manage_roles)
-
- [SSN monitor](#ssn_monitor)
+ [Manage environment](#manage_environment)
[DLab billing report](#billing_page)
-[DLab Environment Management Page](#environment_management)
+
[Web UI filters](#filter)
@@ -87,38 +85,33 @@ After login user will see warning in case of exceeding quota or close to this li
</p>
----------------------------------
-# Setup a Gateway/Edge node <a name="setup_edge_node"></a>
+# Create project <a name="setup_edge_node"></a>
-When you log into DLab Web Application, the first thing you will have to setup is a Gateway Node, or an “Edge” Node.
+When you log into DLab Web Application, the first thing you will have to create new project.
-To do this click on “Upload” button on “Create initial infrastructure”, select your personal public key and hit “Create” button or click on "Generate" button on “Create initial infrastructure” and save your private key.
+To do this click on “Upload” button on “Projects” page, select your personal public key and hit “Create” button or click on "Generate" button on “Projects” and save your private key.
<p align="center" class="facebox-popup">
- <img src="doc/upload_or_generate_user_key.png" alt="Upload or generate user key" width="400">
+ <img src="doc/upload_or_generate_user_key.png" alt="Upload or generate user key" width="100%">
</p>
-Please note that you need to have a key pair combination (public and private key) to work with DLab. To figure out how to create public and private key, please click on “Where can I get public key?” on “Create initial infrastructure” dialog. DLab build-in wiki page will guide Windows, MasOS and Linux on how to generate SSH key pairs quickly.
+Please note that you need to have a key pair combination (public and private key) to work with DLab. To figure out how to create public and private key, please click on “Where can I get public key?” on “Projects” page. DLab build-in wiki page will guide Windows, MasOS and Linux on how to generate SSH key pairs quickly.
-After you hit "Create" or "Generate" button, creation of Edge node will start. This process is a one-time operation for each Data Scientist and it might take up-to 10 minutes for DLab to setup initial infrastructure for you. During this process, you will see following popup in your browser:
+After you hit "Create" or "Generate" button, creation of Project will start. This process is a one-time operation for each Data Scientist and it might take up-to 10 minutes for DLab to setup initial infrastructure for you. During this process, project will have status creating.
-<p align="center">
- <img src="doc/loading_key.png" alt="Loading user key" width="350">
-</p>
-
-As soon as an Edge node is created, Data Scientist will see a blank “List of Resources” page. The message “To start working, please create new environment” will be displayed:
+As soon as an Project is created, Data Scientist can create notebook server on “List of Resources” page. The message “To start working, please create new environment” will be displayed:
---------------------------------------------------------------------------------------
# Setting up analytical environment and managing computational power <a name="setup_environmen"></a>
-----------------------
+
## Create notebook server <a name="notebook_create"></a>
To create new analytical environment from “List of Resources” page click on "Create new" button.
-“Create analytical tool” popup will show-up. Data Scientist can choose a preferable analytical tool to be setup. Adding new analytical tools is supported by architecture, so you can expect new templates to show up in upcoming releases.
-
+The "Create analytical tool" popup will show-up. Data Scientist can choose the preferred project, endpoint and analytical tool to be setup. Adding new analytical tools is supported by architecture, so you can expect new templates to show up in upcoming releases.
Currently by means of DLab, Data Scientists can select between any of the following templates:
- Jupyter
@@ -410,7 +403,7 @@ Clicking on "Apply changes" button, your credentials will be sent to all running
On this tab you can also edit your credentials (click on pen icon) or delete (click on bin icon).
### Git UI tool (ungit) <a name="git_ui"></a>
-
+Confirm you want to do backup by clicking "Apply".
On every analytical tool instance you can see Git UI tool (ungit):
<p align="center">
@@ -448,110 +441,76 @@ After commit you will see your local version and remote repository. To push you
Also clicking on "circle" button you can uncommit or revert changes.
--------------------------------
-# DLab Health Status Page <a name="health_page"></a>
-
-Health Status page is an administration page allowing users to start/stop/recreate gateway node. This might be useful in cases when someone manually deleted corresponding Edge node instance from cloud. This would have made DLab as an application corrupted in general. If any actions are manually done to Edge node instance directly via Cloud Web Console – those changes will be synchronized with DLab automatically and shortly Edge Node status will be updated in DLab.
-
-To access Health status page either navigate to it via main menu:
-
-<p align="center">
- <img src="doc/main_menu.png" alt="Main menu" width="250">
-</p>
-
-or by clicking on an icon close to logged in user name in the top right
-corner of the DLab:
+# Administration <a name="administration"></a>
-- green , if Edge node status is Running;
-- red ,if Edge node is Stopped or Terminated;
-
+## Manage roles <a name="manage_roles"></a>
-To Stop Edge Node please click on actions icon on Health Status page and hit "Stop".
-
-<p align="center">
- <img src="doc/edge_stop.png" alt="EDGE stop" width="150">
-</p>
-
-Confirm you want to stop Edge node by clicking "Yes":
+Administrator can choose what instance shape(s) and notebook(s) can be allowed for certain group(s) or user(s).
+To do it click on "Manage roles" button. "Manage roles" popup will show-up:
<p align="center">
- <img src="doc/edge_stop_confirm.png" alt="EDGE stop confirm" width="400">
+ <img src="doc/manage_role.png" alt="Manage roles" width="780">
</p>
-In case you Edge node is Stopped or Terminated – you will have to Start or Recreate it correspondingly to proceed working with DLab. This can done as well via context actions menu.
-
-### Backup <a name="backup"></a>
+To add group enter group name, choose certain action which should be allowed for group and also you can add discrete user(s) (not mandatory) and then click "Create" button.
+New group will be added and appears on "Manage roles" popup.
-Administrator can use backup functionality. In order to do it click Backup button. "Backup options" popup will show-up. You can choose a preferable option to be backed up.
+Administrator can remove group or user. For that you should only click on "Delete group" button for certain group or click on delete icon <img src="doc/delete_btn.png" alt="delete" width="16"> for particular user. After that Hit "Yes" in confirmation popup.
<p align="center">
- <img src="doc/backup_options.png" alt="Backup options" width="400">
+ <img src="doc/delete_group.png" alt="Delete group" width="780">
</p>
-Confirm you want to do backup by clicking "Apply".
+--------------------------------
-### Manage environment <a name="manage_environment"></a>
+## Environment Management Page <a name="environment_management"></a>
-Administrator can manage users environment clicking on Manage environment button. "Manage environment" popup will show-up. All users environments will be shown which at least one instance has Running status:
+DLab Environment Management page is an administration page allowing admins to show the list of all users` environments and to stop/terminate all of them of separate specific resource.
+
+To access Environment management page either navigate to it via main menu:
<p align="center">
- <img src="doc/manage_environment.png" alt="Manage environment" width="520">
+ <img src="doc/environment_management.png" alt="Environment management">
</p>
-If Administrator hit "Stop" icon <img src="doc/stop_icon_env.png" alt="stop" width="22"> all running instances except for dataengine service will be stopped and dataengine service will be terminated. User will be able to Start instances again except for dataengine service after a while and proceed with his analytics.
-
-If Administrator hit "Terminate" icon <img src="doc/terminate_icon_env.png" alt="terminate" width="22"> all running and stopped instances will be terminated. User will not be able to Start the inctance which has been Terminated. Instead, user will have to Upload his personal public key or Generate ssh key pairs.
-
-Administrator should confirm user environment stopping or termination by clicking Yes:
-
+To Stop or Terminate the Notebook click on a gear icon gear in the Actions column for a needed Notebook and hit Stop or Terminate action:
<p align="center">
- <img src="doc/manage_env_confirm.png" alt="Manage environment confirm" width="550">
+ <img src="doc/manage_env_actions.png" alt="Manage environment actions" width="160">
</p>
-Administrator can manage total billing quota for DLab as well as billing quota per user(s).To do this enter appropriate number in text box(es) per user(s) or/and total budget. Hit "Apply" button.
-
-### Manage roles <a name="manage_roles"></a>
+Any Computational resources except for Spark clusters will be automatically terminated and Spark clusters will be stopped in case of Stop action hitting, and all resources will be killed in case of Terminate action hitting.
-Administrator can choose what instance shape(s) and notebook(s) can be allowed for certain group(s) or user(s).
-To do it click on "Manage roles" button. "Manage roles" popup will show-up:
+To stop or release specific cluster click an appropriate button close to cluster alias.
<p align="center">
- <img src="doc/manage_role.png" alt="Manage roles" width="780">
+ <img src="doc/managemanage_resource_actions.png" alt="Manage resource action" width="300">
</p>
-To add group enter group name, choose certain action which should be allowed for group and also you can add discrete user(s) (not mandatory) and then click "Create" button.
-New group will be added and appears on "Manage roles" popup.
-
-Administrator can remove group or user. For that you should only click on "Delete group" button for certain group or click on delete icon <img src="doc/cross_icon.png" alt="delete" width="16"> for particular user. After that Hit "Yes" in confirmation popup.
+Confirm stopping/decommissioning of the Computational resource by hitting Yes:
<p align="center">
- <img src="doc/delete_group.png" alt="Delete group" width="780">
+ <img src="doc/manage_env_confirm.png" alt="Manage environment action confirm" width="400">
</p>
-### SSN monitor <a name="ssn_monitor"></a>
-
-Administrator can monitor SSN HDD, Memory and CPU.
-Clicking on "SSN monitor button" will open "SSN monitor" popup.
-There are three tabs on 'SSN monitor' popup: CPU, HDD, Memory:
+**NOTE:** terminate action is available only for notebooks and computational resources, not for Edge Nodes.
-<p align="center">
- <img src="doc/cpu.png" alt="SSN CPU" width="480">
-</p>
+### Manage environment <a name="manage_environment"></a>
-<p align="center">
- <img src="doc/memory.png" alt="SSN memory" width="480">
-</p>
+Administrator can manage users environment clicking on Manage environment button. "Manage environment" popup will show-up. All users environments will be shown which at least one instance has Running status:
<p align="center">
- <img src="doc/hdd.png" alt="SSN HDD" width="480">
+ <img src="doc/manage_environment.png" alt="Manage environment" width="520">
</p>
--------------------------------
+
# DLab Billing report <a name="billing_page"></a>
On this page you can see all billing information, including all costs assosiated with service base name of SSN.
-
+![Billing page]
+(doc/billing_page.png)
In the header you can see 3 fields:
- Service base name of your environment
@@ -575,42 +534,6 @@ You can also filter data by each column:
In the footer of billing report, you can see Total cost for all environments.
--------------------------------
-# DLab Environment Management Page <a name="environment_management"></a>
-
-DLab Environment Management page is an administration page allowing admins to show the list of all users` environments and to stop/terminate all of them of separate specific resource.
-
-To access Environment management page either navigate to it via main menu:
-
-<p align="center">
- <img src="doc/main_menu_env.png" alt="Main menu" width="250">
-</p>
-
-<p align="center">
- <img src="doc/environment_management.png" alt="Environment management">
-</p>
-
-To Stop or Terminate the Notebook click on a gear icon gear in the Actions column for a needed Notebook and hit Stop or Terminate action:
-<p align="center">
- <img src="doc/manage_env_actions.png" alt="Manage environment actions" width="160">
-</p>
-
-Any Computational resources except for Spark clusters will be automatically terminated and Spark clusters will be stopped in case of Stop action hitting, and all resources will be killed in case of Terminate action hitting.
-
-To stop or release specific cluster click an appropriate button close to cluster alias.
-
-<p align="center">
- <img src="doc/managemanage_resource_actions.png" alt="Manage resource action" width="300">
-</p>
-
-Confirm stopping/decommissioning of the Computational resource by hitting Yes:
-
-<p align="center">
- <img src="doc/manage_env_confirm.png" alt="Manage environment action confirm" width="400">
-</p>
-
-**NOTE:** terminate action is available only for notebooks and computational resources, not for Edge Nodes.
-
---------------------------------
# Web UI filters <a name="filter"></a>
@@ -671,18 +594,4 @@ After login user will be notified that corresponding resources are about to be
<p align="center">
<img src="doc/scheduler reminder.png" alt="Scheduler reminder" width="400">
-</p>
-
-# Key reupload <a name="key_reupload"></a>
-In case when user private key was corrupted, lost etc. DLAB provide a possibility to reupload user public key.
-It can be done on manage environment page using ACTIONS menu on edge instance:
-
-<p align="center">
- <img src="doc/reupload_key_action.png" alt="Reupload key action" width="200">
-</p>
-
-After that similar to create initial environment dialog appeared where you can upload new key or generate new key-pair:
-
- <p align="center">
- <img src="doc/reupload_key_dialog.png" alt="Reupload key dialog" width="400">
- </p>
+</p>
\ No newline at end of file
diff --git a/doc/billing_filter.png b/doc/billing_filter.png
index 09a0acd..e1dbd78 100644
Binary files a/doc/billing_filter.png and b/doc/billing_filter.png differ
diff --git a/doc/computational_scheduler.png b/doc/computational_scheduler.png
index b00c626..d87a22f 100644
Binary files a/doc/computational_scheduler.png and b/doc/computational_scheduler.png differ
diff --git a/doc/computational_scheduler_create.png b/doc/computational_scheduler_create.png
index 463351d..5d1ef24 100644
Binary files a/doc/computational_scheduler_create.png and b/doc/computational_scheduler_create.png differ
diff --git a/doc/delete_group.png b/doc/delete_group.png
index d5c38e3..9b7c878 100644
Binary files a/doc/delete_group.png and b/doc/delete_group.png differ
diff --git a/doc/emr_creating.png b/doc/emr_creating.png
index 7fb7fde..1e20418 100644
Binary files a/doc/emr_creating.png and b/doc/emr_creating.png differ
diff --git a/doc/emr_terminate_confirm.png b/doc/emr_terminate_confirm.png
index b1fa871..5eb515e 100644
Binary files a/doc/emr_terminate_confirm.png and b/doc/emr_terminate_confirm.png differ
diff --git a/doc/environment_management.png b/doc/environment_management.png
index e4c2cda..ba0399c 100644
Binary files a/doc/environment_management.png and b/doc/environment_management.png differ
diff --git a/doc/git_creds_window.png b/doc/git_creds_window.png
index fdf7a41..ed41936 100644
Binary files a/doc/git_creds_window.png and b/doc/git_creds_window.png differ
diff --git a/doc/git_creds_window2.png b/doc/git_creds_window2.png
index 1481df0..f13444f 100644
Binary files a/doc/git_creds_window2.png and b/doc/git_creds_window2.png differ
diff --git a/doc/main_page.png b/doc/main_page.png
index 4338603..b6f1e17 100644
Binary files a/doc/main_page.png and b/doc/main_page.png differ
diff --git a/doc/main_page2.png b/doc/main_page2.png
index 5305a05..3d3af40 100644
Binary files a/doc/main_page2.png and b/doc/main_page2.png differ
diff --git a/doc/main_page3.png b/doc/main_page3.png
index 255de05..1812925 100644
Binary files a/doc/main_page3.png and b/doc/main_page3.png differ
diff --git a/doc/main_page_filter.png b/doc/main_page_filter.png
index 5818548..cd764ec 100644
Binary files a/doc/main_page_filter.png and b/doc/main_page_filter.png differ
diff --git a/doc/manage_env_confirm.png b/doc/manage_env_confirm.png
index 91f3d30..ae4b543 100644
Binary files a/doc/manage_env_confirm.png and b/doc/manage_env_confirm.png differ
diff --git a/doc/manage_environment.png b/doc/manage_environment.png
index ead01e1..1043e61 100644
Binary files a/doc/manage_environment.png and b/doc/manage_environment.png differ
diff --git a/doc/manage_role.png b/doc/manage_role.png
index 152cf7c..9db76c2 100644
Binary files a/doc/manage_role.png and b/doc/manage_role.png differ
diff --git a/doc/managemanage_resource_actions.png b/doc/managemanage_resource_actions.png
index 23c58d4..bd1394c 100644
Binary files a/doc/managemanage_resource_actions.png and b/doc/managemanage_resource_actions.png differ
diff --git a/doc/notebook_create.png b/doc/notebook_create.png
index 18a674b..c12f4f1 100644
Binary files a/doc/notebook_create.png and b/doc/notebook_create.png differ
diff --git a/doc/notebook_libs_status.png b/doc/notebook_libs_status.png
index 5f49722..8aa861d 100644
Binary files a/doc/notebook_libs_status.png and b/doc/notebook_libs_status.png differ
diff --git a/doc/notebook_scheduler.png b/doc/notebook_scheduler.png
index 31bd9ac..81502c3 100644
Binary files a/doc/notebook_scheduler.png and b/doc/notebook_scheduler.png differ
diff --git a/doc/notebook_terminated.png b/doc/notebook_terminated.png
index fb6399b..408e5ee 100644
Binary files a/doc/notebook_terminated.png and b/doc/notebook_terminated.png differ
diff --git a/doc/notebook_terminating.png b/doc/notebook_terminating.png
index d20b967..b62a492 100644
Binary files a/doc/notebook_terminating.png and b/doc/notebook_terminating.png differ
diff --git a/doc/spark_stop_confirm.png b/doc/spark_stop_confirm.png
index 59b6bf9..7b6bc34 100644
Binary files a/doc/spark_stop_confirm.png and b/doc/spark_stop_confirm.png differ
diff --git a/doc/upload_or_generate_user_key.png b/doc/upload_or_generate_user_key.png
index 2766334..6d6e6e1 100644
Binary files a/doc/upload_or_generate_user_key.png and b/doc/upload_or_generate_user_key.png differ
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@dlab.apache.org
For additional commands, e-mail: commits-help@dlab.apache.org