docs: update for 23.03 (#37)

* docs: add extra information and imgs for direct SSH/SFTP connection on session to local * docs: fix typo * docs: initial update for quota setting corresponds to vfolder v3 * docs: update version from 22.09.3 to 23.03.0 ; * docs: fix typo and add an extra description about default value of quota when no value is set * docs: fix omitted grammars * docs: fix grammars related to capital * docs: fix omitted typo * docs: polish up description about setting the default value when there's no quota config set * docs: touchup title and content of storage menu in admin menu * docs: add Korean translation for quota setting and removal of XFS directory based quota setting * docs: touchup korean translations * docs: remove duplicated space --------- Co-authored-by: Sujin-Kim1 <kimsujin@lablup.com>
lablup · Jul 12, 2023 · 4b9c86a · 4b9c86a
1 parent 01bc02c
commit 4b9c86a
Show file tree

Hide file tree

Showing 17 changed files with 651 additions and 396 deletions.
diff --git a/docs/admin_menu/admin_menu.rst b/docs/admin_menu/admin_menu.rst
@@ -228,7 +228,7 @@ the UPDATE button to update the resource policy.
 About details of each option in resource policy dialog, see the description below.
 
 * Resource Policy
-   * CPU:  Specify the maximum amount of CPU cores. (max value: 512)
+   * CPU: Specify the maximum amount of CPU cores. (max value: 512)
    * RAM: Specify the maximum amount of memory in GB. It would be good practice
      to set memory twice as large as the maximum value of GPU memory. (max value: 1024)
    * GPU: Specify the maximum amount of physical GPUs. If fractional GPU is
@@ -460,7 +460,7 @@ by Click note icon in the Control panel.
 
 On Terminated tab, you can check the information of the agents that has been
 connected once and then terminated or disconnected. It can be used as a
-reference for node management. If the list is empty, then It means
+reference for node management. If the list is empty, then it means
 that there's no disconnection or termination occurred.
 
 .. image:: terminated_agent_list.png
@@ -556,9 +556,94 @@ Storages
 --------
 
 On STORAGES tab, you can see what kind of mount volumes (usually NFS) exist.
+From 23.03 version, We provide per-user/per-project quota setting on storage that supports quota management.
+By using this feature, admin can easily manage and monitor the exact amount of storage usage for each user and project based folder.
 
 .. image:: storage_list.png
 
+In order to set quota, you need to first access to storages tab in resource page.
+And then, click gear icon in control column.
+
+.. note:: 
+   Please remind that quota setting is only available in storage that provides quota setting 
+   (e.g. XFS, CephFS, NetApp, Purestorage, etc.). Although you can see the usage of storage 
+   in quota setting page regardless of storage, you cannot configure the quota which doesn't 
+   support quota configuration internally.
+
+   .. image:: no_support_quota_setting.png
+
+Quota Setting Panel
+~~~~~~~~~~~~~~~~~~~~
+
+In Quota setting page, there are two panels that represent the corresponding items for each panel's title.
+
+.. image:: quota_setting_page.png
+
+* Overview panel
+   * Usage: Shows the actual amount usage of the selected storage.
+   * Endpoint: Represents the mount point of the selected storage.
+   * Backend Type: The type of storage.
+   * Capabilities: The supported feature of the selected storage.
+
+* Quota Settings
+   * For User: Configure per-user quota setting here.
+   * For Project: Configure per-project quota(project-folder) setting here.
+   * ID: Corresponds to user or project id.
+   * Hard Limit (GB): Currently set hard limit quota for selected quota.
+   * Control: Provides editing the hard limit or even deleting the quota setting.
+
+
+Set User Quota
+~~~~~~~~~~~~~~~~
+
+In Backend.AI, there are two types of vfolders created by user and admin(project). In this section,
+we would like to show how to check current quota setting per-user and how to configure it.   
+First, make sure the active tab of quota settings panel is ``For User``. Then, select user you desire to 
+check and edit the quota. You can see the quota id that corresponds to user's id and the configuration already set 
+in the table, if you already set the quota.   
+
+.. image:: per_user_quota.png
+
+Of course, if you want to edit the quota, you can simply click the Edit button in the control column. After Clicking ``Edit`` button, you may see the small modal that enables configuring quota setting. 
+After input the exact amount, don't forget to Click ``OK`` button, unless the changes will not be applied.
+
+.. image:: quota_settings_panel.png
+
+
+Set Project Quota
+~~~~~~~~~~~~~~~~~~
+
+Setting a quota on project-folder is similar to setting a user quota. The difference between setting 
+project quota and user quota is to confirm setting the project quota requires one more procedure, 
+which is selecting the domain that the project is dependent on. The rest are the same.
+As in the picture below, you need to first select the domain, and then select the project.
+
+.. image:: per_project_quota.png
+
+
+.. image:: per_project_quota_2.png
+
+
+Unset Quota
+~~~~~~~~~~~~
+
+We also provides the feature to unset the quota. Please remind that after removing the quota setting, quota will automatically follows 
+user or project default quota, which cannot be set in WebUI. If you want to change the default quota setting, you may need to access to admin-only page.   
+By Clicking ``Unset`` button in control column, the small snackbar message will show up and confirm whether you really want to delete the current quota setting. 
+If you click ``OK`` button in the snackbar message, then it will delete the quota setting and automatically reset the quota follows to corresponding quota, 
+which depends on the quota type(user / project).
+
+.. image:: unset_quota.png
+
+
+.. note::
+
+   If there's no config per user/project, then corresponding values in the user/project resource policy will be set as 
+   a default value. For example, If no hard limit value for quota is set, ``max_vfolder_size`` value in the resource policy 
+   is used as the default value.
+
+
+
 
 Download session lists
 ----------------------

diff --git a/docs/admin_menu/no_support_quota_setting.png b/docs/admin_menu/no_support_quota_setting.png
diff --git a/docs/admin_menu/per_project_quota.png b/docs/admin_menu/per_project_quota.png
diff --git a/docs/admin_menu/per_project_quota_2.png b/docs/admin_menu/per_project_quota_2.png
diff --git a/docs/admin_menu/per_user_quota.png b/docs/admin_menu/per_user_quota.png
diff --git a/docs/admin_menu/quota_setting_page.png b/docs/admin_menu/quota_setting_page.png
diff --git a/docs/admin_menu/quota_settings_panel.png b/docs/admin_menu/quota_settings_panel.png
diff --git a/docs/admin_menu/storage_list.png b/docs/admin_menu/storage_list.png
diff --git a/docs/admin_menu/unset_quota.png b/docs/admin_menu/unset_quota.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,8 +20,8 @@
 project = 'Backend.AI Web-UI User Guide'
 copyright = '2023, Lablup Inc.'
 author = 'Lablup Inc.'
-version = '22.09'
-release = '22.09.3'
+version = '23.03'
+release = '23.03.0'
 
 # -- General configuration ---------------------------------------------------