docs: add contents on vfolder sharing

docs/index.rst

@@ -28,6 +28,7 @@ The latest versions of this document can be found from sites below:
    session_list/session_list
    session_use/session_use
    vfolder/vfolder
+   share_vfolder/share_vfolder
    mount_vfolder/mount_vfolder
    sftp_to_container/sftp_to_container
    admin_user_keypair_management/admin_user_keypair_management

docs/locale/ko/LC_MESSAGES/share_vfolder/share_vfolder.po

@@ -0,0 +1,209 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2020, Lablup Inc.
+# This file is distributed under the same license as the Backend.AI Console
+# Essential Guide package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Backend.AI Console Essential Guide Enterprise R2\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2020-09-12 00:34+0900\n"
+"PO-Revision-Date: 2020-09-12 00:29+0900\n"
+"Last-Translator: \n"
+"Language: ko_KR\n"
+"Language-Team: \n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.8.0\n"
+
+#: ../../share_vfolder/share_vfolder.rst:3
+msgid "Data Sharing and Access Control by Shared Storage Folder"
+msgstr "공유 스토리지 기능을 통한 데이터 공유 및 접근 제한 제어"
+
+#: ../../share_vfolder/share_vfolder.rst:5
+msgid ""
+"You may need to share the contents of a storage folder with other users "
+"or group members to collaborate. For this purpose, Backend.AI provides "
+"flexible folder sharing feature."
+msgstr ""
+"Storage 폴더의 내용을 다른 사용자 또는 그룹 멤버와 공유하여 공동 작업이나 학습을 수행할 필요가 있을 수 있습니다. 이를 "
+"위해 Backend.AI에서는 GUI를 통해 Storage 폴더를 손쉽게 공유할 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:11
+msgid "Sharing user's storage folders with other users"
+msgstr "개인 Storage 폴더를 다른 사용자와 공유하기"
+
+#: ../../share_vfolder/share_vfolder.rst:13
+msgid ""
+"Let's learn how to share your personal Storage folder with other users. "
+"First, log in to User A's account and go to the Data & Storage page. "
+"There are several folders, and we want to share a folder named ``test`` "
+"to User B."
+msgstr ""
+"개인의 Storage 폴더를 다른 사용자와 공유하는 방법에 관해 알아보겠습니다. 먼저 사용자A의 계정으로 로그인 한 뒤 Data &"
+" Storage 페이지로 이동합니다. 여러 폴더가 보이는데 이 중 ``test`` 라는 폴더를 사용자B에게 공유 하려고 합니다."
+
+#: ../../share_vfolder/share_vfolder.rst:19
+msgid ""
+"Inside the ``test`` folder you can see files and directories like "
+"``hello.txt`` and ``myfolder``."
+msgstr ""
+"``test`` 폴더 안에는 ``hello.txt``, ``myfolder`` 와 같은 파일 및 디렉토리가 있는 것을 볼 수 "
+"있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:24
+msgid ""
+"Confirm that the ``test`` folder is not listed when logging in with User "
+"B's account."
+msgstr "사용자B의 계정으로 로그인 했을 때 ``test`` 폴더가 조회되지 않는 것을 확인합니다."
+
+#: ../../share_vfolder/share_vfolder.rst:28
+msgid ""
+"If a folder named ``test`` already exists in User B's account, User A's "
+"``test`` folder cannot be shared with User B."
+msgstr ""
+"만약 사용자B 계정에 ``test`` 라는 이름의 폴더가 이미 존재한다면 사용자A의 ``test`` 폴더는 사용자B에게 공유할 수 "
+"없습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:33
+msgid ""
+"Back to User A's account and click the third icon in the Control column "
+"on the right of the ``test`` folder. Enter User B's email in the email "
+"input field and click the SHARE button to send a sharing invitation. No "
+"actual email is sent, and invitations are generated through the "
+"Backend.AI database. In the case of Permissions, if you check View, it is"
+" shared as read-only, and if you check Edit together, even write "
+"operation is allowed to User B. If you want to share with multiple users,"
+" you can also click the + button to enter additional emails."
+msgstr ""
+"사용자A 계정으로 이동한 뒤 ``test`` 폴더의 우측 Control 열에 있는 세 번째 공유 아이콘을 클릭합니다. 이메일 입력 "
+"필드에 사용자B의 이메일을 입력하고 SHARE 버튼을 클릭해서 공유 초대장을 발송합니다. 실제 이메일이 발송되는 것은 아니며, "
+"Backend.AI 데이터베이스를 통해 초대장이 생성됩니다. Permissions의 경우, View를 체크하면 읽기 전용으로 "
+"공유하게 되고, Edit까지 같이 체크하면 쓰기 작업까지도 사용자B에게 허용합니다. 만약 여러 사용자에게 공유하고 싶다면 + 버튼을"
+" 클릭하여 이메일을 추가로 입력할 수도 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:45
+msgid ""
+"Back to User B's account and visit to the Summary page. At the bottom of "
+"the page, you can see an invitation with the title Invitation arrived. If"
+" you don't see the invitation, go to another page once and then go back "
+"to the Summary page again. Click the ACCEPT button to accept the "
+"invitation."
+msgstr ""
+"사용자B 계정으로 접속해서 Summary 페이지로 이동합니다. 페이지 하단에 Invitation이라는 제목의 초대장이 도착한 것을 "
+"확인할 수 있습니다. 만약 초대장이 보이지 않는다면 다른 페이지로 한 번 이동했다가 다시 Summary 페이지로 이동하십시오. "
+"ACCEPT 버튼을 클릭하여 초대를 수락합니다."
+
+#: ../../share_vfolder/share_vfolder.rst:52
+msgid ""
+"Visit the Data & Storage page and check that the ``test`` folder is "
+"displayed in the list. If you don't see it on the list, try refreshing "
+"your browser page. Since you have accepted the invitation, you can now "
+"view the contents of User A's ``test`` folder in User B account. Compared"
+" to the other folders created by User B, the ``test`` folder has no "
+"management icon in the Control column. You can also see only the R (read-"
+"only) mark displayed in the Permission column."
+msgstr ""
+"Data & Storage 페이지로 이동한 뒤 ``test`` 폴더가 리스트에 출력되는 것을 확인하세요. 만약 리스트에 보이지 "
+"않는다면 브라우저 페이지 갱신을 해보시기 바랍니다. 초대를 수락했기 때문에 이제 사용자B 계정에서 사용자A의 test 폴더 내용을 "
+"조회할 수 있습니다. 사용자B가 생성한 다른 폴더와 비교해 test 폴더는 Control 열에 관리 아이콘이 빠진 것을 확인할 수 "
+"있습니다. Permission 열에는 R(읽기전용) 표시만 떠 있는 것도 볼 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:61
+msgid ""
+"Let's navigate inside the ``test`` folder by clicking the folder icon in "
+"the Control column of ``test``. You can check the ``hello.txt`` and "
+"``myfolder`` that you checked in the user A's account again. Let's create"
+" a compute session by mounting this storge folder with the user B's "
+"account."
+msgstr ""
+"``test``의 Control 열에 폴더 아이콘을 클릭하여 ``test`` 폴더 내부를 탐색해 봅시다. 사용자A 계정에서 확인했던"
+" ``hello.txt``, ``myfolder`` 를 다시 확인할 수 있습니다. 사용자B 계정으로 이 폴더를 마운트 하여 연산 "
+"세션을 생성해보겠습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:70
+msgid ""
+"After creating a session, open the web terminal and check that the "
+"``test`` folder is mounted in the home folder. The contents of the "
+"``test`` folder are displayed, but attempts to create or delete files are"
+" not allowed. This is because User A shared it as read-only. User B can "
+"create a file in the ``test`` folder if it has been shared including "
+"write access."
+msgstr ""
+"세션 생성 후 웹 터미널을 띄워 ``test`` 폴더가 홈폴더에 마운트 된 것을 확인 합니다. ``test`` 폴더 내용은 조회가 "
+"되지만, 파일을 생성하거나 삭제하려는 시도는 허용되지 않습니다. 사용자A가 읽기 전용으로 공유했기 때문입니다. 만약 쓰기 권한까지 "
+"포함하여 공유했다면 사용자B도 ``test`` 폴더에 파일을 생성할 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:80
+msgid ""
+"This way, you can share your personal storage folders with other users "
+"based on your Backend.AI email account."
+msgstr "이렇게 개인 폴더를 Backend.AI 이메일 계정 기반으로 다른 사용자에게 공유할 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:85
+msgid "Sharing a group storage folder with group members"
+msgstr "그룹 Storage 폴더를 다른 사용자와 공유하기"
+
+#: ../../share_vfolder/share_vfolder.rst:87
+msgid ""
+"In addition to user's storage folders, Backend.AI provides storage "
+"folders for groups. A group storage folder is a folder belonging to a "
+"specific group, not a specific user, and can be accessed by all users "
+"belonging to that group."
+msgstr ""
+"Backend.AI는 개인용 Storage 폴더 외에 그룹 전용 Storage 폴더를 제공합니다. 그룹 Storage 폴더는 특정 "
+"사용자가 아닌 특정 그룹에 속하는 폴더이며, 해당 그룹에 속한 모든 사용자가 접근할 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:92
+msgid ""
+"Group folders can only be created by administrators. Normal users can "
+"only access the contents of the group folder created by the "
+"administrator. Also, there may be cases where group folder is not allowed"
+" depending on the system settings."
+msgstr ""
+"그룹 폴더는 오직 관리자만 생성할 수 있습니다. 일반 사용자는 관리자가 생성한 그룹 폴더 내용을 공유해서 접근할 수 있을 뿐입니다."
+" 또한, 시스템 설정에 따라 그룹 폴더 생성이 허용되지 않는 경우도 있을 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:97
+msgid ""
+"First, log in with an administrator account and create a group folder. "
+"After moving to the Data & Storage page, click NEW FOLDER to open the "
+"folder creation dialog. Enter the folder name, set the Type to Group, and"
+" select the target group. The target group should be set to the group to "
+"which User B belongs for this example to work.  Permission is set to "
+"Read-Only again."
+msgstr ""
+"먼저 관리자 계정으로 로그인 한 뒤 그룹 폴더를 만들어보겠습니다. Data & Storage 페이지로 이동 후 NEW FOLDER를"
+" 클릭하여 폴더 생성 다이얼로그를 엽니다. 폴더 이름을 입력하고 Type을 Group으로 설정한 후 목표 Group을 선택합니다. "
+"이 때, 목표 그룹은 사용자B가 속한 그룹으로 설정합니다. Permission은 Read-Only로 설정하였습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:107
+msgid ""
+"After confirming that the folder has been created, log in with the user "
+"B's account and check that the group folder just created on the Data & "
+"Storage page is displayed without an invitation procedure! You can see "
+"that R (Read Only) is also displayed in the Permission column."
+msgstr ""
+"폴더가 생성된 것을 확인한 후 사용자B 계정으로 로그인 하여 Data & Storage 페이지에 방금 생성한 그룹 폴더가 별도의 "
+"초대 절차 없이 조회되는 것을 확인합니다. Permission 열에는 역시 R(읽기전용)이 표시된 것을 확인할 수 있습니다."
+
+#: ../../share_vfolder/share_vfolder.rst:114
+msgid ""
+"In this way, Backend.AI provides invitation for user's folders and group "
+"folders to help you share data and models in a flexible way."
+msgstr ""
+"이렇게 Backend.AI는 개인 폴더의 초대 및 그룹 폴더를 제공하여 유연한 방식으로 데이터 및 모델을 공유할 수 있도록 돕고 "
+"있습니다."
+
+#~ msgid "Objectives"
+#~ msgstr "목표"
+
+#~ msgid "Share user's storage folders to other users"
+#~ msgstr "개인 폴더를 다양한 권한으로 다른 사용자에게 공유"
+
+#~ msgid "Understand the sharing by group storage folder (admin-only)"
+#~ msgstr "그룹 폴더 생성 후 그룹 내 사용자 전체에게 다양한 권한으로 공유 (관리자 전용)"
+

docs/share_vfolder/share_vfolder.rst

@@ -0,0 +1,115 @@
+========================================================
+Data Sharing and Access Control by Shared Storage Folder
+========================================================
+
+You may need to share the contents of a storage folder with other users or group
+members to collaborate. For this purpose, Backend.AI provides flexible folder
+sharing feature.
+
+
+Sharing user's storage folders with other users
+-----------------------------------------------
+
+Let's learn how to share your personal Storage folder with other users. First,
+log in to User A's account and go to the Data & Storage page. There are several
+folders, and we want to share a folder named ``test`` to User B.
+
+.. image:: list_of_vfolders_A.png
+
+Inside the ``test`` folder you can see files and directories like ``hello.txt``
+and ``myfolder``.
+
+.. image:: test_vfolder_explorer_A.png
+
+Confirm that the ``test`` folder is not listed when logging in with User B's
+account.
+
+.. warning::
+   If a folder named ``test`` already exists in User B's account, User A's
+   ``test`` folder cannot be shared with User B.
+
+.. image:: no_test_vfolder_in_B.png
+
+Back to User A's account and click the third icon in the Control column on the
+right of the ``test`` folder. Enter User B's email in the email input field and
+click the SHARE button to send a sharing invitation. No actual email is sent,
+and invitations are generated through the Backend.AI database. In the case of
+Permissions, if you check View, it is shared as read-only, and if you check Edit
+together, even write operation is allowed to User B. If you want to share with
+multiple users, you can also click the + button to enter additional emails.
+
+.. image:: send_vfolder_invitation.png
+   :width: 350
+   :align: center
+
+Back to User B's account and visit to the Summary page. At the bottom of the
+page, you can see an invitation with the title Invitation arrived. If you don't
+see the invitation, go to another page once and then go back to the Summary
+page again. Click the ACCEPT button to accept the invitation.
+
+.. image:: invitation_accept.png
+
+Visit the Data & Storage page and check that the ``test`` folder is displayed in
+the list. If you don't see it on the list, try refreshing your browser page.
+Since you have accepted the invitation, you can now view the contents of User
+A's ``test`` folder in User B account. Compared to the other folders created by
+User B, the ``test`` folder has no management icon in the Control column. You
+can also see only the R (read-only) mark displayed in the Permission column.
+
+.. image:: test_vfolder_listed_in_B.png
+
+Let's navigate inside the ``test`` folder by clicking the folder icon in the
+Control column of ``test``. You can check the ``hello.txt`` and ``myfolder``
+that you checked in the user A's account again. Let's create a compute session
+by mounting this storge folder with the user B's account.
+
+.. image:: launch_session_with_test_mounted_B.png
+   :width: 350
+   :align: center
+
+After creating a session, open the web terminal and check that the ``test``
+folder is mounted in the home folder. The contents of the ``test`` folder are
+displayed, but attempts to create or delete files are not allowed. This is
+because User A shared it as read-only. User B can create a file in the ``test``
+folder if it has been shared including write access.
+
+.. image:: file_operations_on_shared_test_folder.png
+   :width: 450
+   :align: center
+
+This way, you can share your personal storage folders with other users based on
+your Backend.AI email account.
+
+
+Sharing a group storage folder with group members
+-------------------------------------------------
+
+In addition to user's storage folders, Backend.AI provides storage folders for
+groups. A group storage folder is a folder belonging to a specific group, not a
+specific user, and can be accessed by all users belonging to that group.
+
+.. note::
+   Group folders can only be created by administrators. Normal users can only
+   access the contents of the group folder created by the administrator. Also,
+   there may be cases where group folder is not allowed depending on the system
+   settings.
+
+First, log in with an administrator account and create a group folder. After
+moving to the Data & Storage page, click NEW FOLDER to open the folder creation
+dialog. Enter the folder name, set the Type to Group, and select the target
+group. The target group should be set to the group to which User B belongs for
+this example to work.  Permission is set to Read-Only again.
+
+.. image:: group_folder_creation.png
+   :width: 450
+   :align: center
+
+After confirming that the folder has been created, log in with the user B's
+account and check that the group folder just created on the Data & Storage page
+is displayed without an invitation procedure! You can see that R (Read Only) is
+also displayed in the Permission column.
+
+.. image:: group_folder_listed_in_B.png
+
+In this way, Backend.AI provides invitation for user's folders and group folders
+to help you share data and models in a flexible way.