This is an automated email from the ASF dual-hosted git repository.
vvitanska pushed a commit to branch UG_image_vv
in repository https://gitbox.apache.org/repos/asf/incubator-datalab.git
The following commit(s) were added to refs/heads/UG_image_vv by this push:
new b240d925b [DATALAB-2937]: Described image section in UG
b240d925b is described below
commit b240d925b7839ed1427d66b86136ce81b9e6177a
Author: viravit <[email protected]>
AuthorDate: Mon Sep 12 16:10:59 2022 +0200
[DATALAB-2937]: Described image section in UG
---
USER_GUIDE.md | 49 +++++++++++++++++++++++++++++++++++++++++++++----
1 file changed, 45 insertions(+), 4 deletions(-)
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index 9488cac59..7834c9049 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -249,7 +249,11 @@ On "Create AMI" popup you should fill:
<img src="doc/create_ami.png" alt="Create AMI" width="480">
</p>
-After clicking on "Create" button the Notebook status changes to "Creating
image". Once an image is created the Notebook status changes back to "Running".
+After clicking on "Create" button the Notebook status changes to "Creating
image" and this iamge shows up in the list of "Images" page. Once an image is
created the Notebook status changes back to "Running" and image status - to
"Active":
+
+<p align="center">
+ <img src="doc/main_image_page.png" alt="Main Image Page" width="480">
+</p>
To create new analytical environment from custom image click on "Create new"
button on “Resources” page.
@@ -261,11 +265,32 @@ To create new analytical environment from custom image
click on "Create new" but
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.
-In addition, you can view the list of all images which are created by you and
shared with you on the "Images" page:
+In addition, you can filter by clicking on "Filter" button:
+
+<p align="center">
+ <img src="doc/filter_image_popup.png" alt="Filter Image Popup" width="480">
+</p>
+
+Here you can filter by:
+- Image name - custom image name that has been assigned by user who has
created the image
+- Status - current status of the image that inform user whether image is
active or not
+- Endpoint - endpoint for the instance which was used to create the image
+- Template name - the name of the template (custom or cloud) which was used to
create the instance and later the image
+- Sharing status - current status of the image that inform user whether image
has been shared with other users or user groups
+
+As soon as the you select one or several filtering options you can confirm the
filter action by clicking "Ok" button
+After confirmation the page is updated by filtered parameters.
+
+<p align="center">
+ <img src="doc/filtered_images.png" alt="Filter Image Popup" width="480">
+</p>
-
+On top of that, you have several options to clear filter by:
+- Clicking on blue cross icon <img src="doc/filter_cross_icon.png" alt="cross"
width="20"> next to each column - only the filtering for this column is cleared
+- Clicking on cross icon <img src="doc/filter_cross_icon.png" alt="cross"
width="20"> near to blue activate filter button - all filters are cleared
+- Clicking in each column in the "Filter image" pop-up
-You can share the image in Created status with all users in the project or
terminate it if you are image creator/owner. Creator is the user who has
created the image.
+You can share the image in "Active" status with all users in the project or
terminate it if you are image creator/owner. Creator is the user who has
created the image.
Owner is the user who is owning the right to manage image and perform Share
and Terminate actions. The owners are Creator and Admin.
To share or terminate image click on a gear icon <img src="doc/gear_icon.png"
alt="gear" width="20"> in the "Actions" menu for a needed image and hit
"Terminate" or "Share" button appropriately.
@@ -273,6 +298,22 @@ To share or terminate image click on a gear icon <img
src="doc/gear_icon.png" al
<img src="doc/image_action_menu.png" alt="Image action menu" width="150">
</p>
+Confirmation pop-up for image termination:
+
+<p align="center">
+ <img src="doc/image_termination.png" alt="Image termination" width="150">
+</p>
+
+After you confirm your intent to terminate the image - the status changes to
"Terminating" and later becomes "Terminated"
+
+Confirmation pop-up for image sharing:
+
+<p align="center">
+ <img src="doc/image_sharing.png" alt="Image sharing" width="150">
+</p>
+
+Confirm image sharing and afterwards image status changes status from
"Private" to "Shared" for user who shares the image. The shared image show up
in the list of images and has "Received" status for user with whom image is
shared.
+
--------------------------
## Stop Notebook server <a name="notebook_stop"></a>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
