Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions packages/backend.ai-webui-docs/src/en/vfolder/vfolder.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ such as the folder name and ID, the NFS host name where the folder is located
There are two types of storage folders: `User` and `Project`. You can
distinguish between them in the 'Type' column.

## Invitation Badge and Entry Point

When another user invites you to share one of their storage folders, a small
invitation badge appears on the Data page entry in the sidebar and next to the
folder status summary. The badge displays the number of pending invitations
that still need a response.

![](../images/vfolder_invitation_badge.png)

Click the badge to open the invitation list, where you can accept or decline
each pending invitation. Accepted folders immediately appear in your folder
list with the `Invited` type. The `/data` page itself is also a valid entry
point for reviewing invitations — open the Data page and the same invitation
list is reachable from the folder status summary.

A User folder is created directly by an individual user for personal use.
A Project folder is created by a domain administrator for each project.
Regular users cannot create project folders themselves; they can only use
Expand Down Expand Up @@ -97,6 +112,23 @@ You can create a new directory on the current path with the 'Create' button
of these file operations can also be performed using the above-described method
of mounting folders into a compute session.

:::warning
The 'Upload' button (and drag-and-drop upload) is **disabled** when your account
does not have the `upload-file` permission on the storage host that hosts this
folder. The button itself remains visible but is greyed out, and tooltips
explain that uploads are not permitted.

`upload-file` is a host-level capability granted through your **keypair
resource policy**. If you need to upload files and the button is disabled, ask
your administrator to add `upload-file` to the allowed SFTP / vfolder host
permissions on your resource policy. You can identify which host the folder
lives on from the **Location** column in the folder list or from the folder
detail drawer; the required permission must be enabled for *that* host.
:::

![](../images/vfolder_upload_disabled.png)
<!-- TODO: Capture screenshot of the disabled Upload button with permission tooltip -->

Comment thread
agatha197 marked this conversation as resolved.
The maximum length of file or directory inside a folder may depends on the host
file system. But, it usually cannot exceed 255 characters.

Expand Down Expand Up @@ -153,6 +185,25 @@ into the field, and click the red 'DELETE FOREVER' button to permanently delete

![](../images/vfolder_delete_dialog.png)

:::warning[Cascading model card deletion]
If the folder you are deleting is associated with a **model card**, the
confirmation modal additionally surfaces the option *"Also delete the
associated model folder"* with the warning *"Deleting the associated model
folder will also delete every model card that uses it."* Proceeding with the
deletion permanently removes every model card backed by this storage folder —
not just the folder's files. Review the listed model cards before confirming;
this action cannot be undone.
:::

![](../images/vfolder_cascading_delete_warning.png)
<!-- TODO: Capture screenshot of the cascading delete warning dialog -->

Administrators who delete model cards from the **Admin → Manage Model Cards**
page can trigger the inverse flow — bulk-deleting model cards offers an option
to also move the associated storage folders to the trash. See
[Manage Model Cards](../admin_menu/admin_menu.md#manage-models-cards) for the
admin-side bulk flow.

## Using FileBrowser


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions packages/backend.ai-webui-docs/src/ja/vfolder/vfolder.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専

ストレージフォルダには、`ユーザー`と`プロジェクト`の2つのタイプがあります。「種類」列で区別できます。

## 招待バッジとエントリーポイント

他のユーザーが自分のストレージフォルダを共有するために招待を送ると、サイドバーのデータ
ページ項目とフォルダステータスの概要の横に小さな招待バッジが表示されます。バッジには、
まだ応答していない保留中の招待の件数が表示されます。

![](../images/vfolder_invitation_badge.png)

バッジをクリックすると招待リストが開き、保留中の各招待を受諾または辞退できます。
受諾したフォルダは即座にフォルダ一覧に `招待` タイプとして表示されます。`/data`
ページ自体も招待を確認するための有効なエントリーポイントです。データページを開けば、
フォルダステータスの概要から同じ招待リストにアクセスできます。

ユーザーフォルダは、個々のユーザーが個人的に使用するために直接作成したフォルダです。
プロジェクトフォルダは、ドメイン管理者が各プロジェクトに対して作成したフォルダです。
一般ユーザーは自分でプロジェクトフォルダを作成できません。管理者が作成したプロジェクトフォルダのみ使用できます。
Expand Down Expand Up @@ -76,6 +89,23 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専

現在のパスに新しいディレクトリを作成するには、「作成」ボタン(フォルダーエクスプローラー内)を使用するか、ローカルファイルやフォルダーをアップロードするには「アップロード」ボタンを使用します。これらのファイル操作は、上記のフォルダーをコンピューターセッションにマウントする方法を使用して実行することもできます。

:::warning
お使いのアカウントに、このフォルダがホストされているストレージホストに対する
`upload-file` 権限がない場合、「アップロード」ボタン(およびドラッグアンドドロップでの
アップロード)は **無効化** されます。ボタン自体は表示されますがグレーアウトされ、
ツールチップでアップロードが許可されていないことが案内されます。

`upload-file` は、ユーザーの **キーペアリソースポリシー** を通じて付与されるホストレベルの
権限です。ファイルをアップロードする必要があるのにボタンが無効になっている場合は、
管理者に依頼して、リソースポリシーで許可されている SFTP / vfolder ホスト権限に
`upload-file` を追加してもらってください。フォルダがどのホスト上にあるかは、
フォルダ一覧の **ロケーション** 列、またはフォルダ詳細ドロワーで確認できます。
必要な権限は *該当する* ホストに対して有効になっている必要があります。
:::

![](../images/vfolder_upload_disabled.png)
<!-- TODO: 権限ツールチップが表示された無効状態のアップロードボタンのスクリーンショットを撮影します -->

Comment thread
agatha197 marked this conversation as resolved.
フォルダ内のファイルまたはディレクトリの最大長は、ホストファイルシステムに依存することがあります。しかし、通常は255文字を超えることはできません。


Expand Down Expand Up @@ -122,6 +152,24 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専

![](../images/vfolder_delete_dialog.png)

:::warning[モデルカードの連鎖削除]
削除対象のフォルダが **モデルカード** に関連付けられている場合、確認モーダルには
*「関連するモデルフォルダも削除する」* オプションと *「関連するモデルフォルダを削除すると、
そのフォルダを使用しているすべてのモデルカードも削除されます。」* という警告メッセージが
追加で表示されます。このまま削除を実行すると、このストレージフォルダを基盤とする
すべてのモデルカードが永久に削除されます。フォルダのファイルだけが削除されるわけでは
ありません。削除を確定する前に、一覧に表示されるモデルカードを必ず確認してください。
この操作は元に戻せません。
:::

![](../images/vfolder_cascading_delete_warning.png)
<!-- TODO: 連鎖削除警告ダイアログのスクリーンショットを撮影します -->

**管理 → モデルカード管理** ページでモデルカードを削除する管理者は、逆の流れも利用できます。
モデルカードを一括削除する際に、関連付けられたストレージフォルダもゴミ箱に移動する
オプションを選択できます。管理者側の一括処理フローについては
[モデルカード管理](../admin_menu/admin_menu.md#manage-models-cards) を参照してください。

## ファイルブラウザの使用


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions packages/backend.ai-webui-docs/src/ko/vfolder/vfolder.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용

스토리지 폴더에는 `사용자`와 `프로젝트` 두 가지 유형이 있습니다. '종류' 열에서 구분할 수 있습니다.

## 초대 배지 및 진입점

다른 사용자가 자신의 스토리지 폴더를 공유하기 위해 초대를 보내면, 사이드바의 데이터
페이지 항목과 폴더 상태 요약 옆에 작은 초대 배지가 표시됩니다. 배지에는 아직 응답하지
않은 대기 중인 초대의 개수가 함께 표시됩니다.

![](../images/vfolder_invitation_badge.png)

배지를 클릭하면 초대 목록이 열리며, 대기 중인 초대를 각각 수락하거나 거절할 수
있습니다. 수락한 폴더는 즉시 폴더 목록에 `초대받음` 유형으로 표시됩니다. `/data` 페이지
자체도 초대를 검토하는 유효한 진입점입니다. 데이터 페이지를 열면 폴더 상태 요약에서
동일한 초대 목록에 접근할 수 있습니다.

사용자 폴더는 일반 사용자가 직접 생성하여 개인적으로 사용하는 폴더입니다. 프로젝트 폴더는 도메인 관리자가 프로젝트별로 생성하는 폴더입니다. 일반 사용자는 프로젝트 폴더를 직접 생성할 수 없으며, 관리자가 생성한 프로젝트 폴더만 사용할 수 있습니다.

![](../images/vfolder_status.png)
Expand Down Expand Up @@ -76,6 +89,21 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용

'만들기' 버튼으로 현재 경로에 새로운 폴더를 생성할 수 있으며, '업로드' 버튼으로 현재 경로에 로컬 파일 혹은 폴더를 업로드할 수도 있습니다. 이러한 파일 작업은 앞서 설명한 연산 세션 마운트 방식으로도 모두 수행 가능합니다.

:::warning
사용자의 계정에 해당 폴더가 위치한 스토리지 호스트에 대한 `upload-file` 권한이 없으면
'업로드' 버튼(및 드래그 앤 드롭 업로드)은 **비활성화**됩니다. 버튼 자체는 표시되지만
회색으로 변하며, 툴팁을 통해 업로드가 허용되지 않는다는 안내가 표시됩니다.

`upload-file`은 사용자의 **키페어 자원 정책**을 통해 부여되는 호스트 수준의 권한입니다.
업로드가 필요한데 버튼이 비활성화되어 있다면, 자원 정책에서 허용된 SFTP / vfolder
호스트 권한에 `upload-file`을 추가해 달라고 관리자에게 요청하세요. 폴더가 어떤
호스트에 위치해 있는지는 폴더 목록의 **위치** 열이나 폴더 상세 드로어에서 확인할 수
있으며, 필요한 권한은 *해당* 호스트에 대해 활성화되어 있어야 합니다.
:::

![](../images/vfolder_upload_disabled.png)
<!-- TODO: 권한 툴팁이 표시된 비활성화 상태의 업로드 버튼 스크린샷을 캡처합니다 -->

Comment thread
agatha197 marked this conversation as resolved.
폴더 내 파일 또는 디렉토리의 최대 이름 길이는 호스트 파일 시스템에 따라 달라질 수 있습니다. 일반적으로 255자를 초과할 수 없습니다.


Expand Down Expand Up @@ -122,6 +150,23 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용

![](../images/vfolder_delete_dialog.png)

:::warning[모델 카드 연쇄 삭제]
삭제하려는 폴더가 **모델 카드**와 연결되어 있는 경우, 확인 모달에는 *"연결된 모델
폴더도 함께 삭제"* 옵션과 *"연결된 모델 폴더를 삭제하면 해당 폴더를 사용하는 모든
모델 카드도 함께 삭제됩니다."*라는 경고 메시지가 추가로 표시됩니다. 이 상태에서
삭제를 진행하면 해당 스토리지 폴더를 기반으로 하는 모든 모델 카드가 영구적으로
제거됩니다. 폴더의 파일만 삭제되는 것이 아닙니다. 삭제를 확정하기 전에 함께 삭제되는
모델 카드 목록을 반드시 확인하세요. 이 작업은 되돌릴 수 없습니다.
:::

![](../images/vfolder_cascading_delete_warning.png)
<!-- TODO: 연쇄 삭제 경고 대화 상자의 스크린샷을 캡처합니다 -->

**관리자 → 모델 카드 관리** 페이지에서 모델 카드를 삭제하는 관리자는 반대 흐름도 사용할
수 있습니다. 모델 카드를 일괄 삭제할 때, 연결된 스토리지 폴더도 함께 휴지통으로 보내는
옵션을 선택할 수 있습니다. 관리자 측의 일괄 처리 흐름에 대해서는
[모델 카드 관리](../admin_menu/admin_menu.md#manage-models-cards)를 참고하세요.

## 파일 브라우저 사용하기


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading