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
21 changes: 14 additions & 7 deletions packages/backend.ai-webui-docs/TERMINOLOGY.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,21 @@ Backend.AI's GPU virtualization technology that allows sharing a single physical

### App Proxy (formerly WSProxy)

The proxy component that relays in-container application traffic (Jupyter, Terminal, TensorBoard, etc.) between the user's browser and the compute session. Renamed from **WSProxy** to **App Proxy** in the UI in FR-2841. The internal binary / daemon is still named `wsproxy`; only the user-facing label changed.
The standalone, per-resource-group proxy service that relays in-container application traffic (Jupyter, Terminal, TensorBoard, etc.) directly between the user's browser and the compute session's Agent (the **v2** path, bypassing the Manager). Renamed from **WSProxy** to **App Proxy** in the UI in FR-2841.

There is **no** standalone `wsproxy` daemon. In Backend.AI core, App Proxy is a separate service family (App Proxy **Coordinator** + **Worker**); the legacy **v1** path is not a daemon at all but a stream proxy embedded in the Manager process. The lowercase `wsproxy` token survives only as **internal identifiers** — never a user-facing component name:

- DB columns: `scaling_groups.wsproxy_addr`, `wsproxy_api_token`
- API route: `/scaling-groups/{sg}/wsproxy-version`
- Constant: `WSPROXY_V1_VERSION = "v1"`
- The WebUI's own client-side embedded proxy (`src/wsproxy/`) and its `config.toml` key `wsproxy.proxyURL`

| Language | Term | Notes |
|----------|------|-------|
| English | App Proxy | Use "App Proxy (formerly WSProxy)" on first mention for users familiar with the old term. |
| Korean | App Proxy | UI 라벨은 영문 그대로 사용합니다. 처음 언급할 때 "App Proxy(이전 명칭 WSProxy)"로 적어 줍니다. |
| Japanese | App Proxy | UIラベルは英語のまま使用します。初出時は「App Proxy(旧称 WSProxy)」と表記します。 |
| Thai | App Proxy | ใช้ป้ายภาษาอังกฤษเดิม เมื่อกล่าวถึงครั้งแรกให้เขียนว่า "App Proxy (ชื่อเดิม WSProxy)" |
| English | App Proxy | Use "App Proxy" only. Do not reference the old "WSProxy" name in user-facing documentation. |
| Korean | App Proxy | UI 라벨은 영문 그대로 "App Proxy"를 사용합니다. 사용자 문서에 옛 명칭 "WSProxy"를 병기하지 않습니다. |
| Japanese | App Proxy | UIラベルは英語のまま「App Proxy」を使用します。ユーザー向け文書で旧称「WSProxy」を併記しません。 |
| Thai | App Proxy | ใช้ป้ายภาษาอังกฤษ "App Proxy" และไม่อ้างถึงชื่อเดิม "WSProxy" ในเอกสารสำหรับผู้ใช้ |

**Field labels** (Resource Group settings):

Expand All @@ -147,7 +154,7 @@ The proxy component that relays in-container application traffic (Jupyter, Termi
| App Proxy Server Address | App Proxy 서버 주소 | App Proxy サーバアドレス | ที่อยู่เซิร์ฟเวอร์ App Proxy |
| App Proxy API Token | App Proxy API 토큰 | App Proxy APIトークン | โทเค็น API ของ App Proxy |

**Do NOT use** "WSProxy" as the user-facing label in new documentation. Keep `wsproxy` (lowercase, in `code` style) only when referring to the internal binary, daemon, or config key (e.g., `wsproxy.proxyURL` in `config.toml`).
**Do NOT use** "WSProxy" as the user-facing label in new documentation, and do **not** describe `wsproxy` as a server-side binary or daemon (it isn't one). Keep `wsproxy` (lowercase, `code` style) only for the internal identifiers listed above — DB columns, the API route, the `WSPROXY_V1_VERSION` constant, the WebUI's own client-side proxy (`src/wsproxy/`), and the `config.toml` key `wsproxy.proxyURL`.

### Container vs Kernel / Image

Expand Down Expand Up @@ -206,4 +213,4 @@ These terms match sidebar menu items. Keep documentation references consistent w
| data folder | storage folder / vfolder | Non-standard |
| worker node | agent node | Reserve "worker node" for model serving context only |
| compute node | agent node | Non-standard in docs |
| WSProxy (as a UI label) | App Proxy | Renamed in FR-2841; use `wsproxy` (code style) only for the internal binary/daemon |
| WSProxy (as a UI label) | App Proxy | Renamed in FR-2841; `wsproxy` (code style) survives only as internal identifiers (DB columns, API route, constants), not a daemon |
Original file line number Diff line number Diff line change
Expand Up @@ -1046,7 +1046,7 @@ You can deactivate a resource policy by turning off Active Status.
The resource group edit dialog contains the following additional fields:

- **Allowed session types**: Since users can choose the type of session, the resource group can allow certain types. You should allow at least one session type. The allowed session types are Interactive, Batch, Inference, and System.
- **App Proxy Server Address**: Sets the App Proxy (formerly WSProxy) address for the resource group's Agents to use. If you set a URL in this field, App Proxy will relay the traffic of an app like Jupyter directly to the compute session via Agent bypassing Manager (v2 API). By enabling the v2 API, you can lower the Manager's burden when using app services. If a direct connection from App Proxy to the Agent node is not available, leave this field blank to fall back to the v1 API.
- **App Proxy Server Address**: Sets the App Proxy address for the resource group's Agents to use. If you set a URL in this field, App Proxy will relay the traffic of an app like Jupyter directly to the compute session via Agent bypassing Manager.
- **App Proxy API Token**: The API token for authenticating with the App Proxy server.
- **Active**: Toggle the active status of the resource group.
- **Public**: When enabled, the resource group is visible to all users.
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 8 additions & 9 deletions packages/backend.ai-webui-docs/src/en/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,16 @@ achieves more intuitive use.
- Web-UI: A GUI client that is served as a web or stand-alone app.
You can use the service after logging in by specifying the address of the
Backend.AI server and entering the user account information.
- Local `wsproxy`: Proxy server built into the Web-UI app. The local `wsproxy`
daemon converts general HTTP requests between the server and Web-UI app to
websocket and delivers the messages. If the Web-UI app loses its connection
to `wsproxy` or the `wsproxy` server is dead, it will not be possible to
access services such as Jupyter Notebook and Terminal. In the WebUI, this
component is surfaced as **App Proxy** (formerly WSProxy).
- Web `wsproxy`: In the case of the Web-UI provided in a web, the built-in
- Local wsproxy: Proxy server built into the Web-UI app. Local wsproxy converts
general HTTP requests between the server and Web-UI app to websocket and
delivers the messages. If the Web-UI app loses its connection to wsproxy or
the wsproxy server is dead, it will not be possible to access services such as
Jupyter Notebook and Terminal.
Comment on lines +80 to +84
- Web wsproxy: In the case of the Web-UI provided in a web, the built-in
server cannot be used due to the nature of the browser. In this case, you
can use services such as Jupyter Notebook, Terminal, etc. in the web
environment by making the `wsproxy` server a separate web server
so that the Web-UI app can see the web `wsproxy`.
environment by making the wsproxy server as a separate web server
so that the Web-UI app can see the web wsproxy.


<a id="backend-ai-feature-details"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ connection.

### Users cannot launch apps like Jupyter Notebook

There may be a problem on connecting the App Proxy (formerly WSProxy) service.
There may be a problem on connecting the App Proxy service.
Try to stop and restart the service by referencing the guide on
start/stop/restart App Proxy service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ Terminatedタブでは、一度接続されてから終了または切断され
リソースグループ編集ダイアログには以下の追加フィールドが含まれています:

- **許可されたセッションタイプ**: ユーザーがセッションタイプを選択できるため、リソースグループで特定のタイプを許可できます。少なくとも1つのセッションタイプを許可する必要があります。許可されるセッションタイプは Interactive、Batch、Inference、System です。
- **App Proxy サーバアドレス**: リソースグループのエージェントが使用するApp Proxy(旧称 WSProxy)アドレスを設定します。このフィールドにURLを設定すると、App ProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します(v2 API)。App Proxyからエージェントノードへの直接接続が利用できない場合は、このフィールドを空白のままにしてv1 APIにフォールバックしてください
- **App Proxy サーバアドレス**: リソースグループのエージェントが使用するApp Proxyアドレスを設定します。このフィールドにURLを設定すると、App ProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します。
- **App Proxy APIトークン**: App Proxyサーバーとの認証用APIトークンです。
- **アクティブ**: リソースグループの有効/無効を切り替えます。
- **公開**: 有効にすると、リソースグループがすべてのユーザーに表示されます。
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions packages/backend.ai-webui-docs/src/ja/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ GUIクライアントパッケージは、Backend.AIサーバーがサポート
- バーチャルフォルダ(vfolder):コンテナがどのノードで実行されているかに関わらず、常にアクセス可能でコンテナ内にマウント可能な「クラウド」フォルダ(ユーザごとに個別)。自分のバーチャルフォルダを作成した後、自分のプログラムコードやデータなどを事前にアップロードし、計算セッションを実行する際にフォルダをマウントして、あたかもローカルディスクであるかのように読み書きすることができます。
- アプリケーションサービス、サービスポート: コンピュートセッション内で実行されているさまざまなユーザーアプリケーション(例: DIGITS、Jupyter Notebook、シェルターミナル、TensorBoardなど)にアクセスする機能です。コンテナのアドレスやポート番号を直接知る必要はなく、提供されたCLIクライアントまたはGUI Web-UIを使用して、セッションの目的のデーモンに直接アクセスできます。
- Web-UI: Webまたはスタンドアロンアプリとして提供されるGUIクライアントです。Backend.AIサーバーのアドレスを指定し、ユーザーアカウント情報を入力してログインすることでサービスを利用できます。
- ローカル `wsproxy`: Web-UI アプリに組み込まれたプロキシサーバー。ローカル `wsproxy` は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが `wsproxy` への接続を失うか、`wsproxy` サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。WebUI ではこのコンポーネントを **App Proxy**(旧称 WSProxy)として表示します
- Web `wsproxy`: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、`wsproxy` サーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb `wsproxy` を参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
- ローカル wsproxy: Web-UI アプリに組み込まれたプロキシサーバー。ローカル wsproxy は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが wsproxy への接続を失うか、wsproxy サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。
- Web wsproxy: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、wsproxyサーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb wsproxyを参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
Comment on lines +24 to +25


<a id="backend-ai-feature-details"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Web-UIアプリが閉じられ再起動されても、既存のコンピュー

### ユーザーは Jupyter Notebook のようなアプリを起動できません。

App Proxy(旧称 WSProxy)サービスの接続に問題がある可能性があります
App Proxyサービスの接続に問題がある可能性があります
App Proxyサービスの開始・停止・再起動ガイドを参照して、サービスを停止してから再起動してみてください。

### 指定されたリソースが実際の割り当てと一致しません。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -841,7 +841,7 @@ Terminated 탭에서는 한번 연결되었다가 종료되거나 연결이 끊
자원 그룹 편집 대화 상자에는 다음과 같은 추가 필드가 포함되어 있습니다:

- **허용된 세션 타입**: 사용자가 세션 유형을 선택할 수 있으므로, 자원 그룹에서 특정 유형의 세션을 허용할 수 있습니다. 최소 하나의 세션 유형은 허용해야 합니다. 허용되는 세션 유형은 Interactive, Batch, Inference, System입니다.
- **App Proxy 서버 주소**: 자원 그룹의 에이전트가 사용할 App Proxy(이전 명칭 WSProxy) 주소를 설정합니다. 이 필드에 URL을 설정하면 App Proxy가 Jupyter와 같은 앱의 트래픽을 Manager를 우회하여 에이전트를 통해 연산 세션으로 직접 중계합니다 (v2 API). App Proxy에서 에이전트 노드로의 직접 연결이 가능하지 않은 경우 이 필드를 비워 두어 v1 API로 폴백하세요.
- **App Proxy 서버 주소**: 자원 그룹의 에이전트가 사용할 App Proxy 주소를 설정합니다. 이 필드에 URL을 설정하면 App Proxy가 Jupyter와 같은 앱의 트래픽을 Manager를 우회하여 에이전트를 통해 연산 세션으로 직접 중계합니다.
- **App Proxy API 토큰**: App Proxy 서버와의 인증을 위한 API 토큰입니다.
- **활성**: 자원 그룹의 활성 상태를 전환합니다.
- **공개**: 활성화하면 자원 그룹이 모든 사용자에게 표시됩니다.
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions packages/backend.ai-webui-docs/src/ko/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,13 @@ GUI 클라이언트입니다. Backend.AI 서버에 접속하여 연산 자원을
- Web-UI: 웹 또는 독립 실행형 앱으로 제공되는 GUI 클라이언트입니다. Backend.AI
서버의 주소를 지정하고 사용자 계정 정보를 입력하여 로그인한 후 서비스를 사용할
수 있습니다.
- 로컬 `wsproxy`: Web-UI 앱에 내장된 프록시 서버입니다. 로컬 `wsproxy`는 서버와
- 로컬 wsproxy: Web-UI 앱에 내장된 프록시 서버입니다. 로컬 wsproxy는 서버와
Web-UI 앱 간의 일반 HTTP 요청을 websocket으로 변환하여 메시지를 전달합니다.
Web-UI 앱과 `wsproxy` 간의 연결이 끊기거나 `wsproxy` 서버가 중단되면 Jupyter
Notebook, Terminal 등의 서비스에 접속할 수 없습니다. WebUI 화면에서는 이
구성 요소를 **App Proxy**(이전 명칭 WSProxy)로 표기합니다.
- 웹 `wsproxy`: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를
사용할 수 없습니다. 이 경우 `wsproxy` 서버를 별도의 웹 서버로 구성하여 Web-UI
앱이 웹 `wsproxy`를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal
Web-UI 앱과 wsproxy 간의 연결이 끊기거나 wsproxy 서버가 중단되면 Jupyter
Notebook, Terminal 등의 서비스에 접속할 수 없습니다.
Comment on lines +71 to +74
- 웹 wsproxy: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를
사용할 수 없습니다. 이 경우 wsproxy 서버를 별도의 웹 서버로 구성하여 Web-UI
앱이 웹 wsproxy를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal
Comment on lines +75 to +77
등의 서비스를 사용할 수 있습니다.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Web-UI 앱을 통한 SFTP 연결은 Web-UI 앱이 내장하고 있는 로컬 pro

### 사용자가 Jupyter Notebook 등의 앱을 띄울 수 없는 경우

App Proxy(이전 명칭 WSProxy) 서비스 연결에 문제가 있을 수 있습니다. App Proxy 서비스 시작/중지/재시작 가이드를 참고하여 서비스를 중지한 후 다시 시작해 보십시오.
App Proxy 서비스 연결에 문제가 있을 수 있습니다. App Proxy 서비스 시작/중지/재시작 가이드를 참고하여 서비스를 중지한 후 다시 시작해 보십시오.

### 표시되는 자원 양이 실제 할당된 양과 다릅니다

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,7 @@ Superadmin สามารถดูรายการโหนดเอเจน
กลุ่มทรัพยากรมีตัวเลือกเพิ่มเติมดังนี้:

- **ประเภทเซสชันที่อนุญาต**: ผู้ใช้สามารถเลือกประเภทของเซสชันได้ กลุ่มทรัพยากรสามารถอนุญาตประเภทเซสชันบางประเภท ประเภทเซสชันที่อนุญาต ได้แก่ Interactive, Batch, Inference และ System
- **ที่อยู่เซิร์ฟเวอร์ App Proxy**: ตั้งค่าที่อยู่ App Proxy (ชื่อเดิม WSProxy) สำหรับเอเจนต์ของกลุ่มทรัพยากร
- **ที่อยู่เซิร์ฟเวอร์ App Proxy**: ตั้งค่าที่อยู่ App Proxy สำหรับเอเจนต์ของกลุ่มทรัพยากร
- **โทเค็น API ของ App Proxy**: โทเค็น API สำหรับการยืนยันตัวตนกับ App Proxy
- **ใช้งาน**: เปิด/ปิดสถานะการใช้งานของกลุ่มทรัพยากร
- **สาธารณะ**: เปิดเผยกลุ่มทรัพยากรให้ผู้ใช้ทุกคนเห็น
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading