From 171b0fcb949dbafb1777ee3015dd5df4d70dcd06 Mon Sep 17 00:00:00 2001 From: Jinho Heo Date: Thu, 24 Oct 2024 17:22:30 +0000 Subject: [PATCH] Rebuild 'mount_vfolder' document to match latest UI and writing guideline. --- .../mount_vfolder/mount_vfolder.po | 490 ++++++++++++------ docs/mount_vfolder/mount_vfolder.rst | 144 +++-- 2 files changed, 398 insertions(+), 236 deletions(-) diff --git a/docs/locale/ko/LC_MESSAGES/mount_vfolder/mount_vfolder.po b/docs/locale/ko/LC_MESSAGES/mount_vfolder/mount_vfolder.po index 3474071..a2ef763 100644 --- a/docs/locale/ko/LC_MESSAGES/mount_vfolder/mount_vfolder.po +++ b/docs/locale/ko/LC_MESSAGES/mount_vfolder/mount_vfolder.po @@ -2,15 +2,15 @@ # Copyright (C) 2020, Lablup Inc. # This file is distributed under the same license as the Backend.AI Console # User Guide package. -# FIRST AUTHOR , 2020. +# FIRST AUTHOR , 2020. # msgid "" msgstr "" -"Project-Id-Version: Backend.AI Console User Guide 19.09\n" +"Project-Id-Version: Backend.AI Console User Guide 24.09\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-24 10:51+0900\n" +"POT-Creation-Date: 2024-10-25 13:07+0900\n" "PO-Revision-Date: 2023-03-25 23:38+0900\n" -"Last-Translator: Jonghyun Park \n" +"Last-Translator: Jinho Heo \n" "Language: ko\n" "Language-Team: Lablup\n" "Plural-Forms: nplurals=1; plural=0;\n" @@ -25,251 +25,431 @@ msgstr "연산 세션에 폴더 마운트" #: ../../mount_vfolder/mount_vfolder.rst:7 msgid "" -"When you start a compute session, the user has access to the " -"``/home/work/`` directory, and the normal directories and files created " -"under ``/home/work/`` will disappear when the compute session is " +"Backend.AI provides a function to mount storage folders when creating a " +"compute session. When new compute session is started, user will have " +"access to the``/home/work/`` directory. Normal directories and files " +"created under ``/home/work/`` will disappear when the compute session is " "terminated. This is because compute sessions are dynamically created and " -"deleted based on the container. To preserve the data inside the container" -" independent of the life cycle of the container, a separate host folder " -"must be mounted into the container, and then files must be created within" -" the mounted folder. Backend.AI provides a function to mount storage " -"folders when creating a compute session." +"deleted based on the container. To preserve data inside a container " +"regardless of the container's lifecycle, a separate host folder must be " +"mounted in the container, and then files must be created within the " +"mounted folder." msgstr "" -"연산 세션을 시작하면 사용자는 ``/home/work/`` 폴더에 접근 권한을 가지게 되는데, ``/home/work/`` 및 그 " -"하위에 생성된 일반 폴더와 파일은 연산 세션이 삭제되면 함께 사라지게 됩니다. 이는 연산 세션이 컨테이너에 기반하여 동적으로 " -"생성/삭제 되기 때문으로, 컨테이너 내부의 데이터를 컨테이너의 수명 주기와 상관없이 보존하려면 별도의 호스트 폴더를 컨테이너에 " -"마운트 한 뒤 마운트 된 폴더 내에 파일을 생성해야 합니다. Backend.AI 에서는 Storage 폴더 연산 세션 생성 시 " -"마운트 할 수 있는 기능을 제공하고 있습니다." +"Backend.AI는 Storage 폴더 연산 세션 생성 시 마운트 할 수 있는 기능을 제공합니다.연산 세션을 시작하면 사용자는 " +"``/home/work/`` 폴더에 접근 권한을 가지게 되는데, ``/home/work/`` 및 그 하위에 생성된 일반 폴더와 " +"파일은 연산 세션이 삭제되면 함께 사라집니다. 이는 연산 세션이 컨테이너에 기반하여 동적으로 생성/삭제 되기 때문으로, 컨테이너 " +"내부의 데이터를 컨테이너 수명 주기와 상관없이 보존하기 위해서는 별도의 호스트 폴더를 컨테이너에 마운트 한 뒤, 마운트 된 폴더 " +"안에 파일을 생성해야 합니다." -#: ../../mount_vfolder/mount_vfolder.rst:16 +#: ../../mount_vfolder/mount_vfolder.rst:13 msgid "" -"Let's go to the Sessions page and click the START button to create a new " -"compute session. In the Folders to mount panel in the session creation " -"dialog, you can see a list of storage folders that can be mount. By " -"clicking the folder you want to mount, you can mount it. You can also " -"mount multiple folders simultaneously by clicking multiple items. In this" -" example, we will mount two folders, ``user1-ml-test`` and " -"``user2-vfolder``, and then create a compute session." +"Go to 'Sessions' page and click the 'Start' button. After filling out the" +" 'Session Type', 'Environments & Resource allocation' pages, navigate to " +"the 'Data & Folders' page to see a list of folders that users can mount. " +"From this list, choose the folders to mount and add them, or select " +"multiple folders to mount more. The documentation will explain how to " +"mount two folders, ``user1-ml-test`` and ``user2-vfolder``, and then " +"create a session." msgstr "" -"Sessions 페이지로 이동해서 START 버튼을 눌러 새로운 세션을 생성해 보겠습니다. 세션 생성 다이얼로그의 Folders " -"to mount 패널에서 사용자가 마운트 할 수 있는 폴더의 리스트를 볼 수 있습니다. 이 중에서 마운트 하고자 하는 폴더를 " -"클릭하여 추가할 수 있습니다. 여러 개를 클릭해서 여러 폴더를 동시에 마운트 할 수도 있습니다. 이 예제에서는 ``user1-ml-" -"test`` 와 ``user2-vfolder`` 두 개의 폴더를 마운트한 후 세션을 생성 하겠습니다." +"'세션' 페이지에서 '시작' 버튼을 누르면 새로운 세션을 생성할 수 있습니다. " +"'세션 타입', '실행 환경 & 자원 할당' 페이지를 작성한 후, '데이터 & 폴더' 페이지로 이동하면 사용자가 마운트할 수 있는 폴더의 리스트를 확인할 수 있습니다. " +"해당 리스트에서 마운트 하고자 하는 폴더를 선택하여 추가할 수 있으며, 여러 개의 폴더를 선택하면 다수의 폴더를 마운트 할 수 있습니다. " +"해당 Docs에서는 ``user1-ml-test`` 와 ``user2-vfolder`` 두 개의 폴더를 마운트한 후 세션을 생성하는 법에 대해 설명합니다. " #: ../../mount_vfolder/mount_vfolder.rst:-1 msgid "Launch a compute session with storage folders" msgstr "자동 마운트 폴더를 이용하여 연산 세션 환경 구성하기" -#: ../../mount_vfolder/mount_vfolder.rst:29 +#: ../../mount_vfolder/mount_vfolder.rst:25 msgid "" -"Folders to mount only lists the data folders that the user can currently " -"mount. For example, project folders used by other projects are not " -"exposed in Folders to mount. The storage host for each folder is also " -"displayed under the folder's name." +"By looking at the data and folder information within that project, users " +"can see information such as usage mode, the storage host the folder " +"belongs to, permissions, and more. Note that the 'Data & Folders' page " +"only outputs data folders that are mountable by the current user. For " +"example, folders that belong to other projects cannot be viewed." msgstr "" -"Folders to mount 패널에는 현재 사용자가 마운트 가능한 데이터 폴더만 출력됩니다. 예를 들어, 다른 프로젝트에 속한 " -"프로젝트 폴더는 표시되지 않습니다. 각 폴더 이름 아래에서 해당 폴더가 속한 스토리지 호스트도 확인할 수 있습니다." +"해당 프로젝트 내의 데이터와 폴더 정보를 살펴보면 사용 모드, 해당 폴더가 속해 있는 스토리지 호스트, 권한 등의 정보를 확인할 수 있습니다. " +"참고로, '데이터 & 폴더' 페이지에는 현재 사용자가 마운트 가능한 데이터 폴더만 출력됩니다. " +"예를 들어, 다른 프로젝트에 속한 폴더는 해당 메뉴를 통해 조회할 수 없습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:34 +#: ../../mount_vfolder/mount_vfolder.rst:30 msgid "" -"By clicking on a folder name, you can use ''Folder Explore''' to view the" -" stored files or folders inside the folder or upload new files or " -"folders. For more information on how to use it, please refer " -":ref:`Explore Folder` section." +"Accessing the 'Data & Storage' side menu will show the information " +"related to the folders. From this menu, users can view the folders that " +"have been created, create new folders, and upload files. For more " +"detailed instructions related to folders, please refer :ref:`Explore " +"Folder` section." msgstr "" -"폴더 이름을 클릭하면 ''폴더 탐색기''를 통해 폴더 내부 정보를 확인하거나 새로운 파일 혹은 폴더를 " -"업로드 할 수 있습니다. ''폴더 탐색기''에 대한 자세한 사용방법은 :ref:`폴더 내용 조회하기` 를 확인하세요. " +"'데이터 & 스토리지' 사이드 메뉴에 접근할 경우, '폴더' 정보를 한 눈에 확인할 수 있습니다. " +"해당 메뉴에서는 생성되어 있는 폴더를 확인하고, 새로운 폴더를 생성하고, 파일을 업로드할 수 있습니다. " +"해당 메뉴에 대한 자세한 설명은 :ref:`폴더 내용 조회하기` 를 참조하세요. " -#: ../../mount_vfolder/mount_vfolder.rst:38 +#: ../../mount_vfolder/mount_vfolder.rst:34 msgid "" -"Alternatively, you can create a new virtual folder by clicking the '+' " -"button. For more information on how to create a new folder in session " -"launcher page, please refer :ref:`Create storage " +"Alternatively, a new virtual folder can be created by clicking the '+ " +"Add' button. For further information on how to create a new folder in " +"session launcher page, please refer :ref:`Create storage " "folder` section." msgstr "" -"추가적으로, '+' 버튼을 클릭해 새로운 폴더를 생성할 수도 있습니다. 세션 런처에서 새로운 폴더를 " -"생성하는 자세한 방법은, :ref:`Storage 폴더 생성` 를 확인하세요. " +"여기에 더해, '+ 추가' 버튼을 클릭하여 새로운 폴더를 생성할 수도 있습니다. 세션 런처에서 새로운 폴더를 생성하는 자세한 방법을" +" 확인하시려면, :ref:`Storage 폴더 생성` 섹션을 참조하세요. " -#: ../../mount_vfolder/mount_vfolder.rst:42 +#: ../../mount_vfolder/mount_vfolder.rst:38 msgid "" -"Now, open the terminal by clicking the terminal icon in the created " -"session. If you run ``ls`` command in the terminal, you can see that the " -"``user1-ml-test`` and ``user2-vfolder`` folders are mounted under the " -"home directory." +"In the created session, screen terminal window can be brought up by " +"clicking the terminal icon. ``ls`` command will mount ``user1-ml-test` " +"folder and ``user2-vfolder`` under the ``user1-ml-test`` and " +"``user2-vfolder`` folders are mounted under the home directory." msgstr "" -"생성된 세션에서 터미널 아이콘을 클릭해 터미널 창을 띄워 봅시다. 터미널에서 ``ls`` 명령을 내려보면 ``user1-ml-" -"test`` 폴더와 ``user2-vfolder`` 폴더가 홈 디렉토리 하위에 마운트 되어 보이는 것을 알 수 있습니다." +"생성된 세션에서 터미널 아이콘을 클릭하면 터미널 창을 띄울 수 있습니다. 터미널에서 ``ls`` 명령을 내리면 ``user1-ml-" +"test`` 폴더와 ``user2-vfolder`` 폴더가 홈 디렉토리 하위에 마운트되는 것을 확인할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:47 +#: ../../mount_vfolder/mount_vfolder.rst:43 msgid "" -"The selected folder, by default, will be mounted with its name under " -"``/home/work/`` inside the compute session. For example, if a folder's " -"name is ``test``, it is mounted on ``/home/work/test``. In case you want " -"to customize the mount path, write the absolute path in the Path & Alias " -"input field. If you write ``/workspace`` in the input field for the " -"``test`` folder, it will be mounted on ``/workspace`` inside the session." -" Writing a relative path will mount the folder under ``/home/work/`` with" -" the path." +"The selected folder will be mounted with its name under ``/home/work/`` " +"inside the compute session, by its default. For example, if folder's name" +" is ``test``, it is mounted on ``/home/work/test``. To customize the " +"mount path, write an absolute path in the 'Path and Alias' input fields. " +"Writing ``/workspace`` in the input field of the ``test`` folder will " +"mount to ``/workspace`` inside the session. Writing a relative path will " +"mount the folder under ``/home/work/`` with the path." msgstr "" "선택한 폴더는 기본적으로 연산 세션 내의 ``/home/work/`` 하위에 폴더의 이름으로 마운트 됩니다. 예를 들어, 폴더의 " "이름이 ``test`` 일 경우, ``/home/work/test`` 에 마운트 됩니다. 만약, 연산 세션 내 마운트 경로를 " -"변경하고 싶다면 Path & Alias 입력 필드에 절대 경로를 입력합니다. 만약, ``test`` 폴더의 마운트 경로를 " -"``/workspace`` 로 입력한 경우, ``test`` 폴더가 연산 세션 내의 ``/workspace`` 경로에 마운트 " -"됩니다. 상대 경로를 입력하면 ``/home/work/`` 아래에 마운트 됩니다." +"변경하고 싶다면 '경로 & 대체 이름' 입력 필드에 절대 경로를 입력합니다. 만약, ``test`` 폴더의 마운트 경로를 " +"``/workspace`` 로 입력한 경우에는 ``test`` 폴더가 연산 세션 내 ``/workspace`` 경로에 마운트 " +"됩니다. 상대 경로를 입력하면 ``/home/work/`` 아래에 마운트 됩니다. " + +#: ../../mount_vfolder/mount_vfolder.rst:49 +msgid "" +"Backend.AI gives an option to preserve files in folders when a compute " +"session is deleted. The example below illustrates what's happening." +msgstr "" +"Backend.AI에서는 연산 세션을 삭제해도 폴더 안의 파일을 보존할 수 있는 옵션을 제공합니다. " +"아래 예제를 통해 관련된 내용을 확인할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:55 +#: ../../mount_vfolder/mount_vfolder.rst:52 msgid "" -"Let's create a ``test_file`` under ``user2-vfolder`` to see if the file " -"can be preserved after the compute session is terminated. The contents of" -" this file will be \"file inside user2-vfolder\"." +"Under the ``user2-vfolder``, create a ``test_file``. Fill the contents " +"with \\\"file inside user2-vfolder\\\"." msgstr "" -"연산 세션이 삭제된 후에도 파일을 보존할 수 있는지 확인하기 위해 ``user2-vfolder`` 하위에 ``test_file`` " -"파일을 생성해 보겠습니다. 이 파일의 내용은 《file inside user2-vfolder》로 채우겠습니다." +"우선, ``user2-vfolder`` 하위에 ``test_file`` 파일을 생성합니다. " +"해당 파일의 내용은 《file inside user2-vfolder》로 채우겠습니다. " #: ../../mount_vfolder/mount_vfolder.rst:-1 msgid "Mounted folders in terminal" msgstr "" -#: ../../mount_vfolder/mount_vfolder.rst:62 +#: ../../mount_vfolder/mount_vfolder.rst:58 msgid "" -"If you run ``ls`` command against ``user2-vfolder``, you can see that the" -" file was created successfully. Also note the contents of the file with " -"the ``cat`` command." +"Running ``ls`` command against ``user2-vfolder``, users can confirm the " +"file was created successfully. Please note the contents of the file can " +"be chekced with ``cat`` command." msgstr "" -"``user2-vfolder`` 를 대상으로 ``ls`` 명령을 실행해보면 파일이 잘 생성된 것을 확인할 수 있습니다. " -"``cat`` 명령으로 파일 내용도 확인해 보았습니다." +"``user2-vfolder`` 를 대상으로 ``ls`` 명령을 실행해보면 파일이 생성된 것을 확인할 수 있습니다. 참고로, " +"``cat`` 명령을 사용하면 파일 내용을 확인할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:66 +#: ../../mount_vfolder/mount_vfolder.rst:61 msgid "" "Now delete the compute session and go to the Storage page. Locate the " -"``user2-vfolder folder``, open a file explorer and check that the file " -"``test_file`` exists. Click the file download button in Actions to " +"``user2-vfolder folder``, open a file explorer and check that the " +"``test_file`` exists. Click the 'download' button in 'Actions' tab to " "download the file to the local machine and open it to confirm that the " -"contents of the file are \"file inside user2-vfolder\"." +"contents are \\\"file inside user2-vfolder\\\"." msgstr "" -"이제 세션을 삭제한 후 Data & Storage 페이지로 이동합니다. ``user2-vfolder`` 폴더를 찾아 파일 탐색기를 " -"열고 ``test_file`` 파일이 존재하는 것을 확인합니다. Actions의 파일 다운로드 버튼을 클릭하여 파일을 로컬 머신에 " -"받아 내용을 확인해서 파일의 내용이 \"file inside user2-vfolder\" 임을 확인합니다." +"이제 세션을 삭제한 후 Data & Storage 페이지로 이동합니다. ``user2-vfolder`` 폴더를 찾아 클릭하여 파일 " +"탐색기를 열고 ``test_file`` 파일이 존재하는 것을 확인합니다. '작업' 탭의 파일 다운로드 버튼을 클릭하여 파일을 로컬 " +"머신에 내려받은 후, 내용이 \"file inside user2-vfolder\" 임을 확인합니다. " #: ../../mount_vfolder/mount_vfolder.rst:-1 msgid "Download icon in the folder explorer" msgstr "" -#: ../../mount_vfolder/mount_vfolder.rst:75 +#: ../../mount_vfolder/mount_vfolder.rst:69 msgid "" -"Like this, when creating a compute session, you can mount storage folders" -" and perform any file operations on those mounted folders to save data " -"even after the compute session termination." +"Performing file management on a mounted folder when you create a compute " +"session, data can be preserved even after users ends the compute session." msgstr "" -"이처럼 연산 세션을 생성할 때 폴더 마운트를 하고, 마운트 된 폴더에서 파일 작업을 수행하면 연산 세션이 종료된 이후에도 데이터를 " -"보존할 수 있습니다." +"연산 세션을 생성할 때 폴더를 마운트한 후, 마운트 된 폴더에서 파일 작업을 수행하면 연산 세션이 종료된 이후에도 데이터를 보존할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:83 +#: ../../mount_vfolder/mount_vfolder.rst:76 msgid "Configure a compute session environment using an automount folder" msgstr "자동 마운트 폴더를 이용하여 연산 세션 환경 구성하기" -#: ../../mount_vfolder/mount_vfolder.rst:85 +#: ../../mount_vfolder/mount_vfolder.rst:78 msgid "" -"Sometimes you need a new program or library that is not pre-installed in " -"a compute session. In that case, you can install packages and configure a" -" certain environment regardless of the type of compute session by using " -"the Storage folder, which persists independent of session lifecycle, and " -"the :ref:`automount folder`." +"If a new program or library is required that is not pre-installed in a " +"compute session, a Storage folder attribute and :ref:`automount-folder" +"`, which is independent of the compute session " +"lifecycle, can be used to install the package. Configure a consistent " +"environment regardless of the type of compute session." msgstr "" -"연산 세션에 사전 설치되어 있지 않은 새 프로그램이나 라이브러리를 필요로 할 때가 있습니다. 이런 경우, 연산 세션의 수명 주기와 " -"관계없는 Storage 폴더 특성과 :ref:`자동 마운트 폴더` 를 이용해서 패키지를 설치하고, " -"연산 세션의 종류에 상관없이 일정한 환경을 구성할 수 있습니다." +"연산 세션에 사전 설치되어 있지 않은 새 프로그램이나 라이브러리를 필요로 하는 경우, 연산 세션의 수명 주기와 관계 없는 Storage " +"폴더 특성과 :ref:`자동 마운트 폴더` 를 이용해서 패키지를 설치하고, 연산 세션의 종류에 상관없이 일정한 환경을 구성할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:94 +#: ../../mount_vfolder/mount_vfolder.rst:85 msgid "Install Python packages via pip" -msgstr "pip을 통한 파이썬 패키지 설치" +msgstr "pip를 통한 파이썬 패키지 설치" -#: ../../mount_vfolder/mount_vfolder.rst:96 +#: ../../mount_vfolder/mount_vfolder.rst:87 msgid "" "Creating a folder named ``.local`` allows a user to install Python user " -"packages in that folder. This is because ``pip`` by default installs the " -"packages in the ``.local`` folder under the user's home folder (note that" -" automount folder is mounted under user's home folder). So, if you want " -"to install and keep the Python package ``tqdm`` regardless of the type of" -" computing environment, you can issue the following command in your " -"terminal:" +"packages in same folder. ``pip`` by default installs the packages in the " +"``.local`` folder under the user's home folder (Please note that " +"automount folder is mounted under user's home folder). So, to keep a " +"Python package called ``tqdm`` installed at all times, regardless of the " +"computing environment, a command like the following could be issued from " +"the terminal:" msgstr "" -"``.local`` 이라는 이름의 폴더를 생성하면 파이썬 사용자 패키지를 해당 폴더에 설치하고 공유할 수 있습니다. ``pip`` " -"으로 패키지를 설치하면 사용자 홈폴더 하위에 있는 ``.local`` 폴더에 패키지를 설치하기 때문입니다 (자동 마운트 폴더는 " -"사용자 홈폴더 하위에 마운트 됩니다). 따라서, 만약 ``tqdm`` 이라는 파이썬 패키지를 연산 환경과 상관없이 항상 설치되어 " -"있는 상태를 유지하려면 터미널에서 다음과 같은 명령을 내릴 수 있습니다:" +"``.local`` 이라는 이름의 폴더를 생성하면 파이썬 사용자 패키지를 해당 폴더에 설치하고 공유할 수 있습니다. ``pip``로" +" 패키지를 설치하면 사용자 홈 폴더 하위에 있는 ``.local`` 폴더에 패키지를 설치하기 때문입니다. (자동 마운트 폴더는 " +"사용자 홈폴더 하위에 마운트 됩니다.) 따라서, 연산 환경과 상관없이``tqdm`` 이라는 파이썬 패키지의 설치 상태를 항상 " +"유지하려면 터미널에서 다음과 같은 명령을 내릴 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:107 +#: ../../mount_vfolder/mount_vfolder.rst:97 msgid "" "After that, when a new compute session is created, the ``.local`` folder " -"where the ``tqdm`` package is installed is automatically mounted, so you " -"can use the ``tqdm`` package without reinstalling." +"where the ``tqdm`` package is installed is automatically mounted, so " +"users can use it without reinstalling the ``tqdm`` package." msgstr "" "이후, 연산 세션을 새로 생성하게 되면 ``tqdm`` 패키지가 설키된 ``.local`` 폴더가 자동으로 마운트 되므로, " -"``tqdm`` 패키지를 다시 설치하지 않고 사용할 수 있습니다." +"``tqdm`` 패키지를 다시 설치하지 않고 사용할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:113 +#: ../../mount_vfolder/mount_vfolder.rst:102 msgid "" -"If you spawn multiple sessions that use different Python versions, there " -"may be compatibility issues with the packages. This can be circumvented " -"by branching ``PYTHONPATH`` environment variable via the ``.bashrc``. " -"This is because the user's ``pip`` package is installed in the path " -"specified in the ``PYTHONPATH``." +"When using multiple Python versions or sessions with different Python " +"versions, packages may have compatibility issues. This can be " +"circumvented by branching ``PYTHONPATH`` environment variable via the " +"``.bashrc``. This is because the user's ``pip`` package is installed in " +"the path specified in the ``PYTHONPATH``." msgstr "" -"여러 파이썬 버전이나 다른 파이썬 버전을 사용하는 세션을 사용할 경우 패키지들의 호환성 문제가 있을 수 있습니다. 이는 " -"``.bashrc`` 편집기능을 통해 ``PYTHONPATH`` 를 분기하는 방식으로 적용할 수 있습니다. " -"``PYTHONPATH`` 환경 변수에 지정된 경로에 사용자 ``pip`` 패키지가 설치되기 때문입니다." +"여러 파이썬 버전이나 다른 파이썬 버전을 사용하는 세션을 사용할 경우 패키지들의 호환성 문제가 있을 수 있습니다. 이를 해결하기 " +"위해, ``.bashrc`` 편집기능을 통해 ``PYTHONPATH`` 를 분기하는 방식의 적용이 가능합니다. 해당 방법을 " +"사용하면, ``PYTHONPATH`` 환경 변수에 지정된 경로에 사용자 ``pip`` 패키지를 설치할 수 있습니다." -#: ../../mount_vfolder/mount_vfolder.rst:122 +#: ../../mount_vfolder/mount_vfolder.rst:109 msgid "Install packages via Homebrew" msgstr "Homebrew를 통해 패키지 설치" -#: ../../mount_vfolder/mount_vfolder.rst:124 +#: ../../mount_vfolder/mount_vfolder.rst:111 msgid "" "Package managers like Ubuntu ``apt`` or CentOS ``yum`` usually require " "the ``root`` permission. For security reasons, ``sudo`` and ``root`` " -"accesses are blocked by default in Backend.AI's compute session (it may " -"be allowed depending on the configuration), so we recommend to use " -"`Homebrew on Linux `_ which does " -"not require ``sudo``." +"accesses are blocked by default in Backend.AI's compute session " +"(Depending on the configuration, this may be allowed), so we recommend to" +" use `Homebrew on Linux `_ which " +"does not require ``sudo``." msgstr "" "Ubuntu의 ``apt`` 나 CentOS의 ``yum`` 같은 패키지 매니저는 일반적으로 ``root`` 권한을 필요로 합니다." -" Backend.AI의 연산 세션은 보안을 위해 ``sudo`` 권한 및 ``root`` 접근이 기본적으로 막혀 있기 때문에 " -"(설정에 따라 접근을 허용할 수도 있습니다), 패키지 설치를 위해 ``sudo`` 접근이 필요하지 않은 `Homebrew on " -"Linux `_ 사용을 권장하고 있습니다." +" Backend.AI의 연산 세션은 보안을 위해 ``sudo`` 권한 및 ``root`` 접근이 기본적으로 막혀 있기 때문에 " +"(설정에 따라 접근이 허용될 수도 있습니다), 패키지 설치를 위해 ``sudo`` 접근이 필요하지 않은 `Homebrew on " +"Linux `_ 사용을 권장하고 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:130 +#: ../../mount_vfolder/mount_vfolder.rst:114 msgid "Homebrew can be configured as follows:" -msgstr "Homebrew는 다음과 같이 구성할 수 있습니다." +msgstr "Homebrew는 다음과 같이 구성할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:132 +#: ../../mount_vfolder/mount_vfolder.rst:116 msgid "Create ``.linuxbrew`` folder in Data & Storage page." -msgstr "Data & Storage 페이지에서 ``.linuxbrew`` 폴더 생성." +msgstr "Data & Storage 페이지에서 ``.linuxbrew`` 폴더 생성 " -#: ../../mount_vfolder/mount_vfolder.rst:133 +#: ../../mount_vfolder/mount_vfolder.rst:117 msgid "" "Create a compute session (``.linuxbrew`` folder is automatically mounted " "at ``/home/linuxbrew/.linuxbrew``)." -msgstr "연산 세션을 생성(``.linuxbrew`` 폴더가 자동으로 ``/home/linuxbrew/.linuxbrew`` 위치에 마운트)." +msgstr "연산 세션을 생성(``.linuxbrew`` 폴더가 자동으로 ``/home/linuxbrew/.linuxbrew`` 위치에 마운트) " -#: ../../mount_vfolder/mount_vfolder.rst:135 +#: ../../mount_vfolder/mount_vfolder.rst:119 msgid "Install Homebrew in the compute session, if not yet installed." -msgstr "연산 세션 내에서 Homebrew 설치(아직 설치하지 않은 경우)." +msgstr "연산 세션 내에서 Homebrew 설치(아직 설치하지 않은 경우) " -#: ../../mount_vfolder/mount_vfolder.rst:141 -msgid "Homebrew packages can be installed like:" -msgstr "Homebrew 패키지는 다음과 같이설치할 수 있습니다:" +#: ../../mount_vfolder/mount_vfolder.rst:125 +msgid "Homebrew packages can be installed like following:" +msgstr "Homebrew 패키지는 다음과 같이 설치할 수 있습니다. " -#: ../../mount_vfolder/mount_vfolder.rst:149 +#: ../../mount_vfolder/mount_vfolder.rst:133 msgid "" "``brew`` installs packages under ``/home/linuxbrew/.linuxbrew`` which is " -"automatically mounted when ``.linuxbrew`` folder exists. So, if you " -"create a automount folder named ``.linuxbrew``, Homebrew packages can be " -"kept after the compute session is destroyed and then reused for the next " -"compute session." +"automatically mounted when ``.linuxbrew`` folder exists. So, if an " +"automount folder named ''.linuxbrew'' is created, the Homebrew packages " +"previously installed can be used again, even if the compute session is " +"deleted and a new compute session is created." msgstr "" "``brew`` 는 패키지를 ``/home/linuxbrew/.linuxbrew`` 디렉토리 하위에 설치하는데, " "``.linuxbrew`` 라는 데이터 폴더가 있다면 연산 세션 생성 시 자동으로 그 위치에 마운트합니다. 따라서, " "``.linuxbrew`` 라는 자동 마운트 폴더를 생성해두면 연산 세션을 삭제하고 새로운 연산 세션을 생성하더라도 기존에 설치했던" -" Homebrew 패키지를 다시 사용할 수 있습니다." +" Homebrew 패키지를 다시 사용할 수 있습니다. " + +#~ msgid "" +#~ "Go to 'Sessions' page and click " +#~ "the 'Start' button. After filling out" +#~ " the 'Session Type', 'Environments & " +#~ "Resource allocation' pages, navigate to " +#~ "the 'Data & Folders' page to see" +#~ " a list of folders that users " +#~ "can mount. From this list, choose " +#~ "the folders to mount and add them," +#~ " or select multiple folders to mount" +#~ " more. The documentation will explain " +#~ "how to mount two folders, ``user1-ml-" +#~ "test`` and ``user2-vfolder``, and then " +#~ "create a session. " +#~ msgstr "" +#~ "'세션' 페이지에서 '시작' 버튼을 누르면 새로운 세션을" +#~ " 생성할 수 있습니다. '세션 타입', '실행 환경" +#~ " & 자원 할당' 페이지를 작성한 후, '데이터 " +#~ "& 폴더' 페이지로 이동하면 사용자가 마운트할 수 " +#~ "있는 폴더의 리스트를 확인할 수 있습니다. 해당 " +#~ "리스트에서 마운트 하고자 하는 폴더를 선택하여 추가할 " +#~ "수 있으며, 여러 개의 폴더를 선택하면 다수의 " +#~ "폴더를 마운트 할 수 있습니다. 해당 Docs에서는 " +#~ "``user1-ml-test`` 와 ``user2-vfolder`` 두 " +#~ "개의 폴더를 마운트한 후 세션을 생성하는 법에 대해" +#~ " 설명합니다. " + +#~ msgid "" +#~ "By looking at the data and folder" +#~ " information within that project, users " +#~ "can see information such as usage " +#~ "mode, the storage host the folder " +#~ "belongs to, permissions, and more. Note" +#~ " that the 'Data & Folders' page " +#~ "only outputs data folders that are " +#~ "mountable by the current user. For " +#~ "example, folders that belong to other" +#~ " projects cannot be viewed. " +#~ msgstr "" +#~ "해당 프로젝트 내의 데이터와 폴더 정보를 살펴보면 " +#~ "사용 모드, 해당 폴더가 속해 있는 스토리지 " +#~ "호스트, 권한 등의 정보를 확인할 수 있습니다. " +#~ "참고로, '데이터 & 폴더' 페이지에는 현재 사용자가 " +#~ "마운트 가능한 데이터 폴더만 출력됩니다. 예를 들어, " +#~ "다른 프로젝트에 속한 폴더는 해당 메뉴를 통해 " +#~ "조회할 수 없습니다. " + +#~ msgid "" +#~ "Accessing the 'Data & Storage' side " +#~ "menu will show the information related" +#~ " to the folders. From this menu, " +#~ "users can view the folders that " +#~ "have been created, create new folders," +#~ " and upload files. For more detailed" +#~ " instructions related to folders, please" +#~ " refer :ref:`Explore Folder` " +#~ "section. " +#~ msgstr "" +#~ "'데이터 & 스토리지' 사이드 메뉴에 접근할 경우, " +#~ "'폴더' 정보를 한 눈에 확인할 수 있습니다. 해당" +#~ " 메뉴에서는 생성되어 있는 폴더를 확인하고, 새로운 " +#~ "폴더를 생성하고, 파일을 업로드할 수 있습니다. 해당 " +#~ "메뉴에 대한 자세한 설명은 :ref:`폴더 내용 " +#~ "조회하기` 를 참조하세요. " + +#~ msgid "" +#~ "Backend.AI gives an option to preserve" +#~ " files in folders when a compute " +#~ "session is deleted. The example below" +#~ " illustrates what's happening. Under the" +#~ " ``user2-vfolder``, create a ``test_file``Fill" +#~ " the contents with \"file inside " +#~ "user2-vfolder\"." +#~ msgstr "" +#~ "Backend.AI에서는 연산 세션을 삭제해도 폴더 안의 " +#~ "파일을 보존할 수 있는 옵션을 제공합니다. 아래 " +#~ "예제를 통해 관련된 내용을 확인할 수 있습니다. " +#~ "우선, ``user2-vfolder`` 하위에 ``test_file`` 파일을" +#~ " 생성합니다. 해당 파일의 내용은 《file inside " +#~ "user2-vfolder》로 채우겠습니다. " + +#~ msgid "" +#~ "Performing file management on a mounted" +#~ " folder when you create a compute " +#~ "session, data can be preserved even " +#~ "after users ends the compute session." +#~ " " +#~ msgstr "" +#~ "연산 세션을 생성할 때 폴더를 마운트한 후, 마운트" +#~ " 된 폴더에서 파일 작업을 수행하면 연산 세션이 " +#~ "종료된 이후에도 데이터를 보존할 수 있습니다. " + +#~ msgid "" +#~ "Configure a consistent environment regardless" +#~ " of the type of compute session." +#~ " \n" +#~ msgstr "" +#~ "연산 세션에 사전 설치되어 있지 않은 새 " +#~ "프로그램이나 라이브러리를 필요로 하는 경우, 연산 세션의" +#~ " 수명 주기와 관계 없는 Storage 폴더 특성과" +#~ " :ref:`자동 마운트 폴더` 를 " +#~ "이용해서 패키지를 설치하고, 연산 세션의 종류에 상관없이" +#~ " 일정한 환경을 구성할 수 있습니다. " + +#~ msgid "" +#~ "Let's go to the Sessions page and" +#~ " click the START button to create " +#~ "a new compute session. In the " +#~ "Folders to mount panel in the " +#~ "session creation dialog, you can see " +#~ "a list of storage folders that can" +#~ " be mount. By clicking the folder " +#~ "you want to mount, you can mount" +#~ " it. You can also mount multiple " +#~ "folders simultaneously by clicking multiple" +#~ " items. In this example, we will " +#~ "mount two folders, ``user1-ml-test`` and" +#~ " ``user2-vfolder``, and then create a " +#~ "compute session." +#~ msgstr "" + +#~ msgid "" +#~ "Folders to mount only lists the " +#~ "data folders that the user can " +#~ "currently mount. For example, project " +#~ "folders used by other projects are " +#~ "not exposed in Folders to mount. " +#~ "The storage host for each folder " +#~ "is also displayed under the folder's " +#~ "name." +#~ msgstr "" + +#~ msgid "" +#~ "By clicking on a folder name, you" +#~ " can use ''Folder Explore''' to view" +#~ " the stored files or folders inside" +#~ " the folder or upload new files " +#~ "or folders. For more information on " +#~ "how to use it, please refer " +#~ ":ref:`Explore Folder` section." +#~ msgstr "" + +#~ msgid "" +#~ "Let's create a ``test_file`` under " +#~ "``user2-vfolder`` to see if the file " +#~ "can be preserved after the compute " +#~ "session is terminated. The contents of" +#~ " this file will be \"file inside " +#~ "user2-vfolder\"." +#~ msgstr "" + +#~ msgid "" +#~ "Like this, when creating a compute " +#~ "session, you can mount storage folders" +#~ " and perform any file operations on" +#~ " those mounted folders to save data" +#~ " even after the compute session " +#~ "termination." +#~ msgstr "" + +#~ msgid "" +#~ "Sometimes you need a new program " +#~ "or library that is not pre-" +#~ "installed in a compute session. In " +#~ "that case, you can install packages " +#~ "and configure a certain environment " +#~ "regardless of the type of compute " +#~ "session by using the Storage folder, " +#~ "which persists independent of session " +#~ "lifecycle, and the :ref:`automount folder" +#~ "`." +#~ msgstr "" diff --git a/docs/mount_vfolder/mount_vfolder.rst b/docs/mount_vfolder/mount_vfolder.rst index 15e575c..aa564c2 100644 --- a/docs/mount_vfolder/mount_vfolder.rst +++ b/docs/mount_vfolder/mount_vfolder.rst @@ -4,77 +4,70 @@ Mounting Folders to a Compute Session ============================================= -When you start a compute session, the user has access to the ``/home/work/`` -directory, and the normal directories and files created under ``/home/work/`` -will disappear when the compute session is terminated. This is because compute -sessions are dynamically created and deleted based on the container. To preserve -the data inside the container independent of the life cycle of the container, a -separate host folder must be mounted into the container, and then files must be -created within the mounted folder. Backend.AI provides a function to mount -storage folders when creating a compute session. - -Let's go to the Sessions page and click the START button to create a new compute -session. In the Folders to mount panel in the session creation dialog, you can -see a list of storage folders that can be mount. By clicking the folder you -want to mount, you can mount it. You can also mount multiple folders -simultaneously by clicking multiple items. In this example, we will mount two -folders, ``user1-ml-test`` and ``user2-vfolder``, and then create a compute -session. +Backend.AI provides a function to mount storage folders when creating a compute session. +When new compute session is started, user will have access to the``/home/work/`` directory. +Normal directories and files created under ``/home/work/`` will disappear when the compute session is terminated. +This is because compute sessions are dynamically created and deleted based on the container. +To preserve data inside a container regardless of the container's lifecycle, a separate host folder must be mounted in the container, and then files must be created within the mounted folder. + +Go to 'Sessions' page and click the 'Start' button. +After filling out the 'Session Type', 'Environments & Resource allocation' pages, +navigate to the 'Data & Folders' page to see a list of folders that users can mount. +From this list, choose the folders to mount and add them, or select multiple folders to mount more. +The documentation will explain how to mount two folders, ``user1-ml-test`` and ``user2-vfolder``, +and then create a session. .. image:: create_session_with_folders.png :align: center :alt: Launch a compute session with storage folders .. note:: - Folders to mount only lists the data folders that the user can currently - mount. For example, project folders used by other projects are not exposed in - Folders to mount. The storage host for each folder is also displayed under - the folder's name. + By looking at the data and folder information within that project, users can see information such as usage mode, + the storage host the folder belongs to, permissions, and more. + Note that the 'Data & Folders' page only outputs data folders that are mountable by the current user. + For example, folders that belong to other projects cannot be viewed. .. note:: - By clicking on a folder name, you can use ''Folder Explore''' to view the - stored files or folders inside the folder or upload new files or folders. - For more information on how to use it, please refer :ref:`Explore Folder` section. + Accessing the 'Data & Storage' side menu will show the information related to the folders. + From this menu, users can view the folders that have been created, create new folders, and upload files. + For more detailed instructions related to folders, please refer :ref:`Explore Folder` section. - Alternatively, you can create a new virtual folder by clicking the '+' button. - For more information on how to create a new folder in session launcher page, - please refer :ref:`Create storage folder` section. + Alternatively, a new virtual folder can be created by clicking the '+ Add' button. + For further information on how to create a new folder in session launcher page, + please refer :ref:`Create storage folder` section. -Now, open the terminal by clicking the terminal icon in the created session. If -you run ``ls`` command in the terminal, you can see that the ``user1-ml-test`` -and ``user2-vfolder`` folders are mounted under the home directory. +In the created session, screen terminal window can be brought up by clicking the terminal icon. +``ls`` command will mount ``user1-ml-test` folder and ``user2-vfolder`` under the ``user1-ml-test`` +and ``user2-vfolder`` folders are mounted under the home directory. .. note:: - The selected folder, by default, will be mounted with its name under - ``/home/work/`` inside the compute session. For example, if a folder's name - is ``test``, it is mounted on ``/home/work/test``. In case you want to - customize the mount path, write the absolute path in the Path & Alias input - field. If you write ``/workspace`` in the input field for the ``test`` folder, - it will be mounted on ``/workspace`` inside the session. Writing a relative - path will mount the folder under ``/home/work/`` with the path. - -Let's create a ``test_file`` under ``user2-vfolder`` to see if the file can be -preserved after the compute session is terminated. The contents of this file -will be "file inside user2-vfolder". + The selected folder will be mounted with its name under ``/home/work/`` inside the compute session, by its default. + For example, if folder's name is ``test``, it is mounted on ``/home/work/test``. + To customize the mount path, write an absolute path in the 'Path and Alias' input fields. + Writing ``/workspace`` in the input field of the ``test`` folder will mount to ``/workspace`` inside the session. + Writing a relative path will mount the folder under ``/home/work/`` with the path. + +Backend.AI gives an option to preserve files in folders when a compute session is deleted. +The example below illustrates what's happening. + +Under the ``user2-vfolder``, create a ``test_file``. +Fill the contents with \"file inside user2-vfolder\". .. image:: mounted_folders_in_terminal.png :alt: Mounted folders in terminal -If you run ``ls`` command against ``user2-vfolder``, you can see that the file -was created successfully. Also note the contents of the file with the ``cat`` -command. +Running ``ls`` command against ``user2-vfolder``, users can confirm the file was created successfully. +Please note the contents of the file can be chekced with ``cat`` command. -Now delete the compute session and go to the Storage page. Locate the -``user2-vfolder folder``, open a file explorer and check that the file -``test_file`` exists. Click the file download button in Actions to download the -file to the local machine and open it to confirm that the contents -of the file are "file inside user2-vfolder". +Now delete the compute session and go to the Storage page. +Locate the ``user2-vfolder folder``, open a file explorer and check that the ``test_file`` exists. +Click the 'download' button in 'Actions' tab to download the file to the local machine and open it +to confirm that the contents are \"file inside user2-vfolder\". .. image:: download_file_from_folder.png :alt: Download icon in the folder explorer -Like this, when creating a compute session, you can mount storage folders and -perform any file operations on those mounted folders to save data even after the -compute session termination. +Performing file management on a mounted folder when you create a compute session, +data can be preserved even after users ends the compute session. .. _using-automount-folder: @@ -82,52 +75,43 @@ compute session termination. Configure a compute session environment using an automount folder ------------------------------------------------------------------- -Sometimes you need a new program or library that is not pre-installed in a -compute session. In that case, you can install packages and configure a certain -environment regardless of the type of compute session by using the Storage -folder, which persists independent of session lifecycle, and the :ref:`automount -folder`. +If a new program or library is required that is not pre-installed in a compute session, a Storage folder attribute and :ref:`automount-folder`, +which is independent of the compute session lifecycle, can be used to install the package. +Configure a consistent environment regardless of the type of compute session. .. _using-pip-with-automountfolder: Install Python packages via pip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Creating a folder named ``.local`` allows a user to install Python user packages -in that folder. This is because ``pip`` by default installs the packages in the -``.local`` folder under the user's home folder (note that automount folder is -mounted under user's home folder). So, if you want to install and keep the -Python package ``tqdm`` regardless of the type of computing environment, you can -issue the following command in your terminal: +Creating a folder named ``.local`` allows a user to install Python user packages in same folder. +``pip`` by default installs the packages in the ``.local`` folder under the user's home folder +(Please note that automount folder is mounted under user's home folder). +So, to keep a Python package called ``tqdm`` installed at all times, regardless of the computing environment, +a command like the following could be issued from the terminal: .. code-block:: shell pip install tqdm -After that, when a new compute session is created, the ``.local`` folder where -the ``tqdm`` package is installed is automatically mounted, so you can use the -``tqdm`` package without reinstalling. +After that, when a new compute session is created, the ``.local`` folder where the ``tqdm`` package +is installed is automatically mounted, so users can use it without reinstalling the ``tqdm`` package. .. warning:: - If you spawn multiple sessions that use different Python versions, there may - be compatibility issues with the packages. This can be circumvented by - branching ``PYTHONPATH`` environment variable via the ``.bashrc``. This is - because the user's ``pip`` package is installed in the path specified in the - ``PYTHONPATH``. + When using multiple Python versions or sessions with different Python versions, packages may have compatibility issues. + This can be circumvented by branching ``PYTHONPATH`` environment variable via the ``.bashrc``. + This is because the user's ``pip`` package is installed in the path specified in the ``PYTHONPATH``. .. _using-linuxbrew-with-automountfolder: Install packages via Homebrew ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Package managers like Ubuntu ``apt`` or CentOS ``yum`` usually require the -``root`` permission. For security reasons, ``sudo`` and ``root`` accesses are -blocked by default in Backend.AI's compute session (it may be allowed depending -on the configuration), so we recommend to use `Homebrew on Linux -`_ which does not require ``sudo``. +Package managers like Ubuntu ``apt`` or CentOS ``yum`` usually require the ``root`` permission. +For security reasons, ``sudo`` and ``root`` accesses are blocked by default in Backend.AI's compute session (Depending on the configuration, this may be allowed), so we recommend to use `Homebrew on Linux `_ which does not require ``sudo``. -Homebrew can be configured as follows: +Homebrew can be configured as follows: - Create ``.linuxbrew`` folder in Data & Storage page. - Create a compute session (``.linuxbrew`` folder is automatically mounted at @@ -138,7 +122,7 @@ Homebrew can be configured as follows: $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -- Homebrew packages can be installed like: +- Homebrew packages can be installed like following: .. code-block:: shell @@ -146,7 +130,5 @@ Homebrew can be configured as follows: $ hello Hello, world! -``brew`` installs packages under ``/home/linuxbrew/.linuxbrew`` which is -automatically mounted when ``.linuxbrew`` folder exists. So, if you create a -automount folder named ``.linuxbrew``, Homebrew packages can be kept after the -compute session is destroyed and then reused for the next compute session. +``brew`` installs packages under ``/home/linuxbrew/.linuxbrew`` which is automatically mounted when ``.linuxbrew`` folder exists. +So, if an automount folder named ''.linuxbrew'' is created, the Homebrew packages previously installed can be used again, even if the compute session is deleted and a new compute session is created.