Merge pull request #1245 from apache/DATALAB-2526-update-user-guide-v2.5
[DATALAB-2526] updated user guide v2.5
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index 60e7359..20b212b 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -52,6 +52,8 @@
[Manage DataLab quotas](#manage_datalab_quotas)
+ [Configuration](#configuration)
+
[DataLab billing report](#billing_page)
[DataLab audit report](#audit_page)
@@ -155,6 +157,12 @@
You can override the default configurations of 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 the text box.
+Also there is a posibility to add GPU on GCP for Jupyter, Deeplearning notebook or Jupyter with TensorFlow. For Jupyter adding GPU is not mandatory. You can mark a check box and select GPU type from the list:
+
+<p align="center">
+ <img src="doc/notebook_create_gpu.png" alt="Select gpu" width="574">
+</p>
+
After you Select the template, fill in the Name and specify desired instance shape - you need to click on "Create" button for your analytical toolset to be created. Corresponding record shows up in your dashboard:
@@ -241,7 +249,7 @@
<img src="doc/create_notebook_from_ami.png" alt="Create notebook from AMI" width="560">
</p>
-Before clicking "Create" button you should choose the image from "Select AMI" and fill in the "Name" and "Instance shape".
+Before clicking "Create" button you should choose the image from "Select AMI" and fill in the "Name" and "Instance shape". For Deeplearning notebook on GCP there is also a list of predefined images.
--------------------------
## Stop Notebook server <a name="notebook_stop"></a>
@@ -316,14 +324,20 @@
<img src="doc/emr_create_configuration.png" alt="Create Custom Computational resource on AWS" width="760">
</p>
-This picture shows menu for creating Dataproc (Data Engine Service) for GCP:
+You can specify Master and Slave GPU type and GPU count for Dataproc (Data Engine Service) or Standalone Apache Spark cluster on GCP.
+
+This picture shows menu for creating Dataproc (Data Engine Service) and Standalone Apache Spark cluster for GCP:
<p align="center">
<img src="doc/dataproc_create.png" alt="Create Computational resource on GCP" width="760">
</p>
+<p align="center">
+ <img src="doc/spark_create_gcp.png" alt="Create Computational resource on GCP" width="760">
+</p>
+
To create Data Engine Service (Dataproc) with preemptible instances check off 'preemptible node count'. You can add from 1 to 11 preemptible instances.
-This picture shows menu for creating Standalone Apache Spark cluster for Azure, AWS and GCP:
+This picture shows menu for creating Standalone Apache Spark cluster for Azure and AWS:
<p align="center">
<img src="doc/spark_creating_menu.png" alt="Create Computational resource on Azure" width="760">
</p>
@@ -662,6 +676,37 @@
In such case user cannot create new instance and already "Running" instance changes its status to "Stopping", except for Data Engine Service (its status changes "Terminating") and soon becomes "Stopped" or "Terminated" appropriately.
+## Configuration <a name="configuration"></a>
+
+DataLab Configuration page is an administrative page allowing administrator to restart services and/or edit configuration files for self-service, provisioning and billing services.
+
+To access Configuration page, navigate to it through the main menu:
+
+<p align="center">
+ <img src="doc/configuration_page.png" alt="Configuration">
+</p>
+
+Navigate between tabs to edit services configuration files:
+
+<p align="center">
+ <img src="doc/configuration_page1.png" alt="Configuration">
+</p>
+
+To restart the service, select the appropriate endpoint from the list, and then select one or several services you want to restart and click on 'Restart' button. A confirmation dialog shows up, allowing you to confirm or reject the action:
+
+**NOTE:** Restarting services will make DataLab unavailable for some time.
+
+<p align="center">
+ <img src="doc/configuration_page_restart.png" alt="Configurationt">
+</p>
+
+**NOTE:** You will not be able to restart provisioning service if one of resources
+is in processing stage (creating, configuring, reconfiguring, creating image, stopping, starting, terminating):
+
+<p align="center">
+ <img src="doc/configuration_page_prov.png" alt="Configuration">
+</p>
+
--------------------------------
# DataLab Billing report <a name="billing_page"></a>
diff --git a/doc/audit_info.png b/doc/audit_info.png
index 6f16843..c15cae6 100644
--- a/doc/audit_info.png
+++ b/doc/audit_info.png
Binary files differ
diff --git a/doc/audit_page.png b/doc/audit_page.png
index bbad586..7f26780 100644
--- a/doc/audit_page.png
+++ b/doc/audit_page.png
Binary files differ
diff --git a/doc/billing_page.png b/doc/billing_page.png
index 5ba4006..cf3d554 100644
--- a/doc/billing_page.png
+++ b/doc/billing_page.png
Binary files differ
diff --git a/doc/bucket_button.png b/doc/bucket_button.png
index ee83a86..0a0c9fb 100644
--- a/doc/bucket_button.png
+++ b/doc/bucket_button.png
Binary files differ
diff --git a/doc/configuration_page.png b/doc/configuration_page.png
new file mode 100644
index 0000000..b1d055e
--- /dev/null
+++ b/doc/configuration_page.png
Binary files differ
diff --git a/doc/configuration_page1.png b/doc/configuration_page1.png
new file mode 100644
index 0000000..58ac0de
--- /dev/null
+++ b/doc/configuration_page1.png
Binary files differ
diff --git a/doc/configuration_page_prov.png b/doc/configuration_page_prov.png
new file mode 100644
index 0000000..0dd8d53
--- /dev/null
+++ b/doc/configuration_page_prov.png
Binary files differ
diff --git a/doc/configuration_page_restart.png b/doc/configuration_page_restart.png
new file mode 100644
index 0000000..1aedc6a
--- /dev/null
+++ b/doc/configuration_page_restart.png
Binary files differ
diff --git a/doc/dataproc_create.png b/doc/dataproc_create.png
index cbab3f4..1eb8ca7 100644
--- a/doc/dataproc_create.png
+++ b/doc/dataproc_create.png
Binary files differ
diff --git a/doc/environment_management.png b/doc/environment_management.png
index d67b16c..462201b 100644
--- a/doc/environment_management.png
+++ b/doc/environment_management.png
Binary files differ
diff --git a/doc/main_page.png b/doc/main_page.png
index 365f90a..e0230b8 100644
--- a/doc/main_page.png
+++ b/doc/main_page.png
Binary files differ
diff --git a/doc/main_page2.png b/doc/main_page2.png
index 8725222..b931895 100644
--- a/doc/main_page2.png
+++ b/doc/main_page2.png
Binary files differ
diff --git a/doc/main_page3.png b/doc/main_page3.png
index bf2bf33..a94038b 100644
--- a/doc/main_page3.png
+++ b/doc/main_page3.png
Binary files differ
diff --git a/doc/main_page_filter.png b/doc/main_page_filter.png
index 06a7c81..96c5fdc 100644
--- a/doc/main_page_filter.png
+++ b/doc/main_page_filter.png
Binary files differ
diff --git a/doc/notebook_create.png b/doc/notebook_create.png
index 9ca407e..b0dd89a 100644
--- a/doc/notebook_create.png
+++ b/doc/notebook_create.png
Binary files differ
diff --git a/doc/notebook_create_gpu.png b/doc/notebook_create_gpu.png
new file mode 100644
index 0000000..3dc00a0
--- /dev/null
+++ b/doc/notebook_create_gpu.png
Binary files differ
diff --git a/doc/notebook_info.png b/doc/notebook_info.png
index a2881a4..8640115 100644
--- a/doc/notebook_info.png
+++ b/doc/notebook_info.png
Binary files differ
diff --git a/doc/notebook_list_libs.png b/doc/notebook_list_libs.png
index 437c9fb..3b3f704 100644
--- a/doc/notebook_list_libs.png
+++ b/doc/notebook_list_libs.png
Binary files differ
diff --git a/doc/spark_create_gcp.png b/doc/spark_create_gcp.png
new file mode 100644
index 0000000..a16c720
--- /dev/null
+++ b/doc/spark_create_gcp.png
Binary files differ
diff --git a/doc/upload_or_generate_user_key.png b/doc/upload_or_generate_user_key.png
index e3f537d..95b624f 100644
--- a/doc/upload_or_generate_user_key.png
+++ b/doc/upload_or_generate_user_key.png
Binary files differ
