This is an automated email from the ASF dual-hosted git repository.
vvitanska pushed a commit to branch user_guide
in repository https://gitbox.apache.org/repos/asf/incubator-dlab.git
The following commit(s) were added to refs/heads/user_guide by this push:
new e0c71c1 [DLAB-1698]: Got rid of future tense
e0c71c1 is described below
commit e0c71c19e0ae24aed4ae175016d9a7b48b827132
Author: viravit <[email protected]>
AuthorDate: Tue Apr 7 17:27:37 2020 +0300
[DLAB-1698]: Got rid of future tense
---
USER_GUIDE.md | 170 ++++++++++++++++++++++++++++------------------------------
1 file changed, 83 insertions(+), 87 deletions(-)
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index d8a5393..b4aefd8 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -63,6 +63,7 @@ DLab Web Application authenticates users against:
- OpenLdap;
- Cloud Identity and Access Management service user validation;
+- KeyCloak integration for seamless SSO experience;
| Login error messages | Reason
|
|------------------------------------|----------------------------------------------------------------------------------|
@@ -74,7 +75,7 @@ DLab Web Application authenticates users against:
To stop working with DLab - click on Log Out link at the top right corner of
DLab.
-After login user will see warning in case of exceeding quota or close to this
limit.
+After login user sees warning in case of exceeding quota or close to this
limit.
<p align="center" class="facebox-popup">
<img src="doc/exceeded quota.png" alt="Exceeded quota" width="400">
@@ -87,19 +88,21 @@ After login user will see warning in case of exceeding
quota or close to this li
----------------------------------
# Create project <a name="setup_edge_node"></a>
-When you log into DLab Web Application, the first thing you will have to
create new project.
+When you log into DLab Web Application, the first thing you need to do is to
create a new project.
-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.
+To do this click on “Upload” button on “Projects” page, select your personal
public key (or click on "Generate" button), endpoint, group, 'Use shared image'
select enable or disable and hit “Create” button. Do not forget to 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="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 “Projects” page. 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 guides Windows, MasOS and Linux on how to generate SSH key pairs
quickly.
-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.
+Creation of Project starts after hitting "Create" button. 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
has status "Creating".
-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:
+'Use shared image' enabled means, that image of particular notebook is created
during the first notebook creation for the whole DLab. This image is used for
the next creation within DLab. 'Use share image' disabled means, that image of
particular notebook is created during the first notebook creation for the
current project. This image is used for the next creation within particular
project.
+
+As soon as Project is created, Data Scientist can create notebook server on
“List of Resources” page. The message “To start working, please create new
environment” is appeared on “List of Resources” page:

@@ -111,7 +114,7 @@ As soon as an Project is created, Data Scientist can create
notebook server on
To create new analytical environment from “List of Resources” page click on
"Create new" button.
-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.
+The "Create analytical tool" popup shows 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
@@ -120,6 +123,8 @@ Currently by means of DLab, Data Scientists can select
between any of the follow
- RStudio with TensorFlow
- Jupyter with TensorFlow
- Deep Learning (Jupyter + MXNet, Caffe, Caffe2, TensorFlow, CNTK, Theano,
Torch and Keras)
+- JupyterLab
+- Superset (implemented on GCP)
<p align="center">
<img src="doc/notebook_create.png" alt="Create notebook" width="574">
@@ -129,7 +134,7 @@ After specifying desired template, you should fill in the
“Name” and “Inst
Name field – is just for visual differentiation between analytical tools on
“List of resources” dashboard.
-Instance shape dropdown, contains configurable list of shapes, which should be
chosen depending on the type of analytical work to be performed. Following
groups of instance shapes will be showing up with default setup configuration:
+Instance shape dropdown, contains configurable list of shapes, which should be
chosen depending on the type of analytical work to be performed. Following
groups of instance shapes are showing up with default setup configuration:
<p align="center">
<img src="doc/select_shape.png" alt="Select shape" width="250">
@@ -137,25 +142,25 @@ Instance shape dropdown, contains configurable list of
shapes, which should be c
These groups have T-Shirt based shapes (configurable), that can help Data
Scientist to either save money\* and leverage not very powerful shapes (for
working with relatively small datasets), or that could boost the performance of
analytics by selecting more powerful instance shape.
-\* Please refer to official documentation from Amazon that will help you
understand what [instance shapes](https://aws.amazon.com/ec2/instance-types/)
would be most preferable in your particular DLAB setup. Also, you can use [AWS
calculator](https://calculator.s3.amazonaws.com/index.html) to roughly estimate
the cost of your environment.
+\* Please refer to official documentation from Amazon that helps you to
understand what [instance shapes](https://aws.amazon.com/ec2/instance-types/)
is the most preferable in your particular DLAB setup. Also, you can use [AWS
calculator](https://calculator.s3.amazonaws.com/index.html) to roughly estimate
the cost of your environment.
You can override the default configurations for local spark. The configuration
object is referenced as a JSON file. To tune spark configuration check off
"Spark configurations" check box and insert JSON format in text box.
-After you Select the template, fill in the Name and choose needed instance
shape - you need to click on "Create" button for your instance to start
creating. Corresponding record will show up in your dashboard:
+After you Select the template, fill in the Name and choose needed instance
shape - you need to click on "Create" button for your instance to start
creating. Corresponding record is shown up in your dashboard:

-As soon as notebook server is created, its status will change to Running:
+As soon as notebook server is created, its status changes to Running:

-When you click on the name of your Analytical tool in the dashboard –
analytical tool popup will show up:
+When you click on the name of your Analytical tool in the dashboard –
analytical tool popup is shown up:
<p align="center">
<img src="doc/notebook_info.png" alt="Notebook info" width="574">
</p>
-In the header you will see version of analytical tool, its status and shape.
+In the header you see version of analytical tool, its status and shape.
In the body of the dialog:
@@ -165,30 +170,24 @@ In the body of the dialog:
- Shared bucket for all users
- Bucket that has been provisioned for your needs
-To access analytical tool Web UI you proceed with one of the options:
-
-- use direct URL's to access notebooks (your access will be established via
reverse proxy, so you don't need to have Edge node tunnel up and running)
-- SOCKS proxy based URL's to access notebooks (via tunnel to Edge node)
-
-If you use direct urls you don't need to open tunnel for Edge node and set
SOCKS proxy.
-If you use indirect urls you need to configure SOCKS proxy and open tunnel for
Edge node. Please follow the steps described on “Read instruction how to create
the tunnel” page to configure SOCKS proxy for Windows/MAC/Linux machines. “Read
instruction how to create the tunnel” is available on DLab notebook popup.
+To access analytical tool Web UI you use direct URL's (your access is
established via reverse proxy, so you don't need to have Edge node tunnel up
and running).
### Manage libraries <a name="manage_libraries"></a>
-On every analytical tool instance you can install additional libraries by
clicking on gear icon <img src="doc/gear_icon.png" alt="gear" width="20"> in
the Actions column for a needed Notebook and hit Manage libraries:
+On every analytical tool instance you can install additional libraries by
clicking on gear icon <img src="doc/gear_icon.png" alt="gear" width="20"> in
the "Actions" column for a needed Notebook and hit "Manage libraries":
<p align="center">
<img src="doc/notebook_menu_manage_libraries.png" alt="Notebook
manage_libraries" width="150">
</p>
-After clicking you will see the window with 3 fields:
-- Field for selecting an active resource to install libraries on
+After clicking you see the window with 3 fields:
+- Field for selecting an active resource to install libraries
- Field for selecting group of packages (apt/yum, Python 2, Python 3, R,
Java, Others)
- Field for search available packages with autocomplete function except for
Java. java library you should enter using the next format:
"groupID:artifactID:versionID"

-You need to wait for a while after resource choosing till list of all
available libraries will be received.
+You need to wait for a while after resource choosing till list of all
available libraries is received.

@@ -198,25 +197,25 @@ You need to wait for a while after resource choosing till
list of all available

-After selecting library, you can see it on the right and could delete in from
this list before installing.
+After selecting library, you can see it n the miidle of the window and can
delete it from this list before installation.

-After clicking on "Install" button you will see process of installation with
appropriate status.
+After clicking on "Install" button you see process of installation with
appropriate status.

-**Note:** If package can't be installed you will see "Failed" in status column
and button to retry installation.
+**Note:** If package can't be installed you see "Failed" in status column and
button to retry installation.
### Create image <a name="create_image"></a>
-Out of each analytical tool instance you can create an AMI image (notebook
should be in Running status), including all libraries, which have been
installed on it. You can use that AMI to speed-up provisioining of further
analytical tool, if you would like to re-use existing configuration. To create
an AMI click on a gear icon <img src="doc/gear_icon.png" alt="gear" width="20">
in the Actions menu for a needed Notebook and hit "Create AMI":
+Out of each analytical tool instance you can create an AMI image (notebook
should be in Running status), including all libraries, which have been
installed on it. You can use that AMI to speed-up provisioining of further
analytical tool, if you want to re-use existing configuration. To create an AMI
click on a gear icon <img src="doc/gear_icon.png" alt="gear" width="20"> in the
"Actions" menu for a needed Notebook and hit "Create AMI":
<p align="center">
<img src="doc/notebook_menu_create_ami.png" alt="Notebook create_ami"
width="150">
</p>
-On Create AMI popup you will be asked to fill in:
+On "Create AMI" popup you should fill:
- text box for an AMI name (mandatory)
- text box for an AMI description (optional)
@@ -224,11 +223,11 @@ On Create AMI popup you will be asked to fill in:
<img src="doc/create_ami.png" alt="Create AMI" width="480">
</p>
-After clicking on "Assign" button the Notebook status will change to Creating
AMI. Once an image is created the Notebook status changes back to Running.
+After clicking on "Assign" button the Notebook status changes to Creating AMI.
Once an image is created the Notebook status changes back to Running.
-To create new analytical environment from custom image click "Create new"
button on “List of Resources” page.
+To create new analytical environment from custom image click on "Create new"
button on “List of Resources” page.
-“Create analytical tool” popup will show-up. Choose a template of a Notebook
for which the custom image is created:
+“Create analytical tool” popup is shown up. Choose a template of a Notebook
for which the custom image is created:
<p align="center">
<img src="doc/create_notebook_from_ami.png" alt="Create notebook from AMI"
width="560">
@@ -239,53 +238,52 @@ Before clicking "Create" button you should choose the
image from "Select AMI" an
--------------------------
## Stop Notebook server <a name="notebook_stop"></a>
-Once you have stopped working with an analytical tool and you would like to
release cloud resources for the sake of the costs, you might want to Stop the
notebook. You will be able to Start the notebook again after a while and
proceed with your analytics.
+Once you have stopped working with an analytical tool and you need to release
cloud resources for the sake of the costs, you might want to stop the notebook.
You are able to start the notebook again after a while and proceed with your
analytics.
-To Stop the Notebook click on a gear icon <img src="doc/gear_icon.png"
alt="gear" width="20"> in the Actions column for a needed Notebook and hit Stop:
+To stop the Notebook click on a gear icon <img src="doc/gear_icon.png"
alt="gear" width="20"> in the "Actions" column for a needed Notebook and hit
"Stop":
<p align="center">
<img src="doc/notebook_menu_stop.png" alt="Notebook stopping" width="150">
</p>
-Hit OK in confirmation popup.
+Hit "OK" in confirmation popup.
-**NOTE:** if any Computational resources except for Spark cluster have been
connected to your notebook server – they will be automatically terminated if
you stop the notebook and Spark cluster will be automatically stopped.
+**NOTE:** Connected Data Engine Server is terminated and related Data Engine
is stopped during Notebook stopping.
<p align="center">
<img src="doc/notebook_stop_confirm.png" alt="Notebook stop confirm"
width="400">
</p>
-After you confirm you intent to Stop the notebook - the status will be changed
to Stopping and will become Stopped in a while. Spark cluster status will be
changed to Stopped and other Computational resource status will be changed to
Terminated.
+After you confirm you intent to Stop the notebook - the status changes to
"Stopping" and soon becomes "Stopped".
--------------------------------
## Terminate Notebook server <a name="notebook_terminate"></a>
-Once you have finished working with an analytical tool and you would like to
release cloud resources for the sake of the costs, you might want to Terminate
the notebook. You will not be able to Start the notebook which has been
Terminated. Instead, you will have to create new Notebook server if you will
need to proceed your analytical activities.
+Once you have finished working with an analytical tool and you need to release
cloud resources for the sake of the costs, you might want to terminate the
notebook. You are not able to start the notebook which has been terminated.
Instead, you have to create new Notebook server if you need to proceed your
analytical activities.
-To Terminate the Notebook click on a gear icon <img src="doc/gear_icon.png"
alt="gear" width="20"> in the Actions column for a needed Notebook and hit
Terminate:
+To terminate the Notebook click on a gear icon <img src="doc/gear_icon.png"
alt="gear" width="20"> in the "Actions" column for a needed Notebook and hit
"Terminate":
-**NOTE:** if any Computational resources have been linked to your notebook
server – they will be automatically terminated if you stop the notebook.
+**NOTE:** If any Computational resources have been linked to your notebook
server – they are automatically terminated if you terminate the notebook.
-Confirm termination of the notebook and afterward notebook status will be
changed to **Terminating**:
+Confirm termination of the notebook and afterward notebook status changes to
"Terminating":

-Once corresponding instances are terminated on cloud, status will finally
-change to Terminated:
+Once corresponding instances are terminated on cloud, status finally changes
to "Terminated":

---------------
## Deploy Computational resource <a name="computational_deploy"></a>
-After deploying Notebook node, you can deploy Computational resource and it
will be automatically linked with your Notebook server. Computational resource
is a managed cluster platform, that simplifies running big data frameworks,
such as Apache Hadoop and Apache Spark on cloud to process and analyze vast
amounts of data. Adding Computational resource is not mandatory and is needed
in case computational resources are required for job execution.
+After deploying Notebook node, you can deploy Computational resource and it is
automatically linked with your Notebook server. Computational resource is a
managed cluster platform, that simplifies running big data frameworks, such as
Apache Hadoop and Apache Spark on cloud to process and analyze vast amounts of
data. Adding Computational resource is not mandatory and is needed in case
computational resources are required for job execution.
-On “Create Computational Resource” popup you will have to choose Computational
resource version (configurable) and specify alias for it. To setup a cluster
that meets your needs – you will have to define:
+On “Create Computational Resource” popup you have to choose Computational
resource version (configurable) and specify alias for it. To setup a cluster
that meets your needs – you have to define:
- Total number of instances (min 2 and max 14, configurable);
- Master and Slave instance shapes (list is configurable and supports all
available cloud instance shapes, supported in your cloud region);
-Also, if you would like to save some costs for your Computational resource you
can create it based on [spot instances](https://aws.amazon.com/ec2/spot/),
which are often available at a discount price (this functionality is only
available for AWS cloud):
+Also, if you want to save some costs for your Computational resource you can
create it based on [spot instances](https://aws.amazon.com/ec2/spot/), which
are often available at a discount price (this functionality is only available
for AWS cloud):
- Select Spot Instance checkbox;
- Specify preferable bid for your spot instance in % (between 20 and 90,
configurable).
@@ -309,29 +307,29 @@ This picture shows menu for creating Computational
resource for Azure:
<img src="doc/dataengine_creating_menu.png" alt="Create Computational
resource on Azure" width="760">
</p>
-If you click on "Create" button Computational resource creation will kick off.
You will see corresponding record on DLab Web UI in status **Creating**:
+If you click on "Create" button Computational resource creation kicks off. You
see corresponding record on DLab Web UI in status "Creating":

-Once Computational resources are provisioned, their status will be changed to
**Running**.
+Once Computational resources are provisioned, their status changes to
"Running".
-Clicking on Computational resource name in DLab dashboard will open
Computational resource details popup:
+After clicking on Computational resource name in DLab dashboard you see
Computational resource details popup:
<p align="center">
<img src="doc/emr_info.png" alt="Computational resource info" width="480">
</p>
-Also you can go to computational resource master UI via link "Apache Spark
Master' or "EMR Master" (this functionality is only available for AWS cloud).
+Also you can go to computational resource master UI via link "Apache Spark
Master', "EMR Master" or "Dataproc Master" .
Since Computational resource is up and running - you are now able to leverage
cluster computational power to run your analytical jobs on.
To do that open any of the analytical tools and select proper
kernel/interpreter:
-**Jupyter** – goto Kernel and choose preferable interpreter between local and
Computational resource ones. Currently we have added support of Python 2/3,
Spark, Scala, R into Jupyter.
+**Jupyter** – go to Kernel and choose preferable interpreter between local and
Computational resource ones. Currently we have added support of Python 2/3,
Spark, Scala, R into Jupyter.

-**Zeppelin** – goto Interpreter Biding menu and switch between local and
Computational resource there. Once needed interpreter is selected click on Save.
+**Zeppelin** – go to Interpreter Biding menu and switch between local and
Computational resource there. Once needed interpreter is selected click on
"Save".

@@ -349,9 +347,9 @@ Insert following “magics” before blocks of your code to
start executing your
---------------
## Stop Apache Spark cluster <a name="spark_stop"></a>
-Once you have stopped working with a spark cluster and you would like to
release cloud resources for the sake of the costs, you might want to Stop
Apache Spark cluster. You will be able to Start apache Spark cluster again
after a while and proceed with your analytics.
+Once you have stopped working with a spark cluster and you need to release
cloud resources for the sake of the costs, you might want to stop Apache Spark
cluster. You are able to start apache Spark cluster again after a while and
proceed with your analytics.
-To Stop Apache Spark cluster click on <img src="doc/stop_icon.png" alt="stop"
width="20"> button close to spark cluster alias.
+To stop Apache Spark cluster click on <img src="doc/stop_icon.png" alt="stop"
width="20"> button close to spark cluster alias.
Hit "YES" in confirmation popup.
@@ -359,42 +357,40 @@ Hit "YES" in confirmation popup.
<img src="doc/spark_stop_confirm.png" alt="Spark stop confirm" width="400">
</p>
-After you confirm your intent to Apache Spark cluster - the status will be
changed to Stopping and will become Stopped in a while.
+After you confirm your intent to Apache Spark cluster - the status changes to
"Stopping" and soon becomes "Stopped".
------------------
## Terminate Computational resource <a name="computational_terminate"></a>
-To release cluster computational resources click on <img
src="doc/cross_icon.png" alt="cross" width="16"> button close to Computational
resource alias. Confirm decommissioning of Computational resource by hitting
Yes:
+To release cluster computational resources click on <img
src="doc/cross_icon.png" alt="cross" width="16"> button close to Computational
resource alias. Confirm decommissioning of Computational resource by hitting
"Yes":
<p align="center">
<img src="doc/emr_terminate_confirm.png" alt="Computational resource
terminate confirm" width="400">
</p>
-In a while Computational resource cluster will get **Terminated**.
Corresponding cloud instances will also removed on cloud.
+In a while Computational resource cluster gets "Terminated". Corresponding
cloud instances also is removed on cloud.
--------------------------------
## Collaboration space <a name="collaboration_space"></a>
### Manage Git credentials <a name="git_creds"></a>
-To work with Git (pull, push) via UI tool (ungit) you could add multiple
credentials in DLab UI, which will be set on all running instances with
analytical tools.
+To work with Git (pull, push) via UI tool (ungit) you could add multiple
credentials in DLab UI, which are set on all running instances with analytical
tools.
-When you click on the button "Git credentials" – following popup will show up:
+When you click on the button "Git credentials" – following popup is shown up:
<p align="center">
<img src="doc/git_creds_window.png" alt="Git_creds_window" width="760">
</p>
In this window you need to add:
-- Your Git server hostname, without **http** or **https**, for example:
gitlab.com, github.com, or your internal GitLab server, which can be deployed
with DLab.
+- Your Git server hostname, without **http** or **https**, for example:
gitlab.com, github.com, or your internal GitLab server.
- Your Username and Email - used to display author of commit in git.
- Your Login and Password - for authorization into git server.
-**Note:** If you have GitLab server, which was deployed with DLab, you should
use your LDAP credentials for access to GitLab.
+Once all fields are filled in and you click on "Assign" button, you see the
list of all your Git credentials.
-Once all fields are filled in and you click on "Assign" button, you will see
the list of all your Git credentials.
-
-Clicking on "Apply changes" button, your credentials will be sent to all
running instances with analytical tools. It takes a few seconds for changes to
be applied.
+Clicking on "Apply changes" button, your credentials are sent to all running
instances with analytical tools. It takes a few seconds for changes to be
applied.
<p align="center">
<img src="doc/git_creds_window2.png" alt="Git_creds_window1" width="760">
@@ -403,7 +399,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">
@@ -424,7 +420,7 @@ After creating repository you can see all commits and
branches:

-On the top of window in the red field UI show us changed or new files to
commit. You can uncheck or add some files to gitignore.
+On the top of window in the red field UI shows us changed or new files to
commit. You can uncheck or add some files to gitignore.
**Note:** Git always checks you credentials. If this is your first commit
after adding/changing credentials and after clicking on "Commit" button nothing
happened - just click on "Commit" button again.
@@ -434,7 +430,7 @@ To see all modified files - click on the "circle" button on
the center:

-After commit you will see your local version and remote repository. To push
you changes - click on your current branch and press "Push" button.
+After commit you see your local version and remote repository. To push you
changes - click on your current branch and press "Push" button.

@@ -447,7 +443,7 @@ Also clicking on "circle" button you can uncommit or revert
changes.
## Manage roles <a name="manage_roles"></a>
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 do it click on "Add group" button. "Add group" popup is shown up:
<p align="center">
<img src="doc/manage_role.png" alt="Manage roles" width="780">
@@ -456,7 +452,7 @@ To do it click on "Manage roles" button. "Manage roles"
popup will show-up:
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/delete_btn.png" alt="delete" width="16"> for particular user. After
that Hit "Yes" in confirmation popup.
+Administrator can remove group or user. For that you should only click on bin
icon for certain group or for 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/delete_group.png" alt="Delete group" width="780">
@@ -466,7 +462,7 @@ Administrator can remove group or user. For that you should
only click on "Delet
## 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.
+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:
@@ -474,12 +470,12 @@ To access Environment management page either navigate to
it via main menu:
<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:
+To stop or terminate the Notebook click on a gear icon 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.
+**NOTE:** Connected Data Engine Server is terminated and related Data Engine
is stopped during Notebook stopping. During Notebook termination related
Computational resources are automatically terminated.
To stop or release specific cluster click an appropriate button close to
cluster alias.
@@ -487,17 +483,17 @@ To stop or release specific cluster click an appropriate
button close to cluster
<img src="doc/managemanage_resource_actions.png" alt="Manage resource
action" width="300">
</p>
-Confirm stopping/decommissioning of the Computational resource by hitting Yes:
+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.
+**NOTE:** Terminate action is available only for notebooks and computational
resources, not for Edge Nodes.
### Manage environment <a name="manage_environment"></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:
+Administrator can manage users environment clicking on "Manage DLab quotas"
button. "Manage DLab quotas" popup is shown up. All active project are conveyed:
<p align="center">
<img src="doc/manage_environment.png" alt="Manage environment" width="520">
@@ -512,9 +508,8 @@ On this page you can see all billing information, including
all costs assosiated
![Billing page]
(doc/billing_page.png)
-In the header you can see 3 fields:
+In the header you can see 2 fields:
- Service base name of your environment
-- Resource tag ID
- Date period of available billing report
On the center of header you can choose period of report in datepicker:
@@ -554,22 +549,23 @@ There is also an option for quick and easy way to filter
out all inactive instan
# Scheduler <a name="scheduler"></a>
-Scheduler component allows to automatically schedule start/stop of
notebook/cluster. There are 2 types of schedulers available:
+Scheduler component allows to automatically schedule start/stop of
Notebook/Computational resource and terminate only Computational resource.
There are 2 types of schedulers available:
- notebook scheduler;
-- data engine scheduler (currently spark cluster only);
+- Computational resource scheduler (currently spark cluster only for
starting/stoping and termination for all clusters).
-To create scheduler for a notebook click on a <img src="doc/gear_icon.png"
alt="gear" width="20"> icon in the Actions column for a needed Notebook and hit
Scheduler:
+To create scheduler for a notebook click on an <img src="doc/gear_icon.png"
alt="gear" width="20"> icon in the "Actions" column for a needed Notebook and
hit "Scheduler":
<p align="center">
<img src="doc/notebook_menu_scheduler.png" alt="Notebook scheduler action"
width="150">
</p>
-After clicking you will see popup with the following fields:
+After clicking you see popup with the following fields:
- start/finish dates - date range when scheduler is active;
- start/end time - time when notebook should be running;
-- offset - your zone offset;
+- timezone - your time zone;
- repeat on - days when scheduler should be active
-- possibility to synchronize notebook scheduler with computational schedulers
+- possibility to synchronize notebook scheduler with computational schedulers
+- possibility not to stop notebook in case of running jon on Spark Standalone
<p align="center">
<img src="doc/notebook_scheduler.png" alt="Notebook scheduler" width="400">
@@ -587,11 +583,11 @@ There is a possibility to inherit scheduler start
settings from notebook, if suc
<img src="doc/computational_scheduler.png" alt="Computational scheduler"
width="400">
</p>
-Once any scheduler is set up, notebook/spark cluster will be started/stopped
automatically.
-Please also note that if notebook is configured to be stopped, all running
data engines assosiated with it will be stopped (for spark cluster) or
terminated (for data engine serice) with notebook.
+Notebook/spark cluster is started/stopped automatically after scheduler
setting.
+Please also note that if notebook is configured to be stopped, all running
data engines assosiated with is stopped (for spark cluster) or terminated (for
data engine serice) with notebook.
-After login user will be notified that corresponding resources are about to
be stopped/terminated in some time.
+After login user is notified that corresponding resources are about to be
stopped/terminated in some time.
<p align="center">
<img src="doc/scheduler reminder.png" alt="Scheduler reminder" width="400">
-</p>
\ No newline at end of file
+</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]