Skip to content

Commit 7c9bf1f

Browse files
committed
docs(FR-2916): correct WSProxy→App Proxy rename inaccuracies and recapture resource group screenshots
1 parent dcc10dc commit 7c9bf1f

21 files changed

Lines changed: 40 additions & 35 deletions

File tree

packages/backend.ai-webui-docs/TERMINOLOGY.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,21 @@ Backend.AI's GPU virtualization technology that allows sharing a single physical
131131

132132
### App Proxy (formerly WSProxy)
133133

134-
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.
134+
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.
135+
136+
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:
137+
138+
- DB columns: `scaling_groups.wsproxy_addr`, `wsproxy_api_token`
139+
- API route: `/scaling-groups/{sg}/wsproxy-version`
140+
- Constant: `WSPROXY_V1_VERSION = "v1"`
141+
- The WebUI's own client-side embedded proxy (`src/wsproxy/`) and its `config.toml` key `wsproxy.proxyURL`
135142

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

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

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

150-
**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`).
157+
**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`.
151158

152159
### Container vs Kernel / Image
153160

@@ -206,4 +213,4 @@ These terms match sidebar menu items. Keep documentation references consistent w
206213
| data folder | storage folder / vfolder | Non-standard |
207214
| worker node | agent node | Reserve "worker node" for model serving context only |
208215
| compute node | agent node | Non-standard in docs |
209-
| WSProxy (as a UI label) | App Proxy | Renamed in FR-2841; use `wsproxy` (code style) only for the internal binary/daemon |
216+
| 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 |

packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1046,7 +1046,7 @@ You can deactivate a resource policy by turning off Active Status.
10461046
The resource group edit dialog contains the following additional fields:
10471047

10481048
- **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.
1049-
- **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.
1049+
- **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.
10501050
- **App Proxy API Token**: The API token for authenticating with the App Proxy server.
10511051
- **Active**: Toggle the active status of the resource group.
10521052
- **Public**: When enabled, the resource group is visible to all users.
70.1 KB
Loading
62.9 KB
Loading

packages/backend.ai-webui-docs/src/en/overview/overview.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,16 @@ achieves more intuitive use.
7777
- Web-UI: A GUI client that is served as a web or stand-alone app.
7878
You can use the service after logging in by specifying the address of the
7979
Backend.AI server and entering the user account information.
80-
- Local `wsproxy`: Proxy server built into the Web-UI app. The local `wsproxy`
81-
daemon converts general HTTP requests between the server and Web-UI app to
82-
websocket and delivers the messages. If the Web-UI app loses its connection
83-
to `wsproxy` or the `wsproxy` server is dead, it will not be possible to
84-
access services such as Jupyter Notebook and Terminal. In the WebUI, this
85-
component is surfaced as **App Proxy** (formerly WSProxy).
86-
- Web `wsproxy`: In the case of the Web-UI provided in a web, the built-in
80+
- Local wsproxy: Proxy server built into the Web-UI app. Local wsproxy converts
81+
general HTTP requests between the server and Web-UI app to websocket and
82+
delivers the messages. If the Web-UI app loses its connection to wsproxy or
83+
the wsproxy server is dead, it will not be possible to access services such as
84+
Jupyter Notebook and Terminal.
85+
- Web wsproxy: In the case of the Web-UI provided in a web, the built-in
8786
server cannot be used due to the nature of the browser. In this case, you
8887
can use services such as Jupyter Notebook, Terminal, etc. in the web
89-
environment by making the `wsproxy` server a separate web server
90-
so that the Web-UI app can see the web `wsproxy`.
88+
environment by making the wsproxy server as a separate web server
89+
so that the Web-UI app can see the web wsproxy.
9190

9291

9392
<a id="backend-ai-feature-details"></a>

packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ connection.
8383

8484
### Users cannot launch apps like Jupyter Notebook
8585

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

packages/backend.ai-webui-docs/src/ja/admin_menu/admin_menu.md

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

967967
- **許可されたセッションタイプ**: ユーザーがセッションタイプを選択できるため、リソースグループで特定のタイプを許可できます。少なくとも1つのセッションタイプを許可する必要があります。許可されるセッションタイプは Interactive、Batch、Inference、System です。
968-
- **App Proxy サーバアドレス**: リソースグループのエージェントが使用するApp Proxy(旧称 WSProxy)アドレスを設定します。このフィールドにURLを設定すると、App ProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します(v2 API)。App Proxyからエージェントノードへの直接接続が利用できない場合は、このフィールドを空白のままにしてv1 APIにフォールバックしてください
968+
- **App Proxy サーバアドレス**: リソースグループのエージェントが使用するApp Proxyアドレスを設定します。このフィールドにURLを設定すると、App ProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します。
969969
- **App Proxy APIトークン**: App Proxyサーバーとの認証用APIトークンです。
970970
- **アクティブ**: リソースグループの有効/無効を切り替えます。
971971
- **公開**: 有効にすると、リソースグループがすべてのユーザーに表示されます。
76.5 KB
Loading
69.7 KB
Loading

packages/backend.ai-webui-docs/src/ja/overview/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ GUIクライアントパッケージは、Backend.AIサーバーがサポート
2121
- バーチャルフォルダ(vfolder):コンテナがどのノードで実行されているかに関わらず、常にアクセス可能でコンテナ内にマウント可能な「クラウド」フォルダ(ユーザごとに個別)。自分のバーチャルフォルダを作成した後、自分のプログラムコードやデータなどを事前にアップロードし、計算セッションを実行する際にフォルダをマウントして、あたかもローカルディスクであるかのように読み書きすることができます。
2222
- アプリケーションサービス、サービスポート: コンピュートセッション内で実行されているさまざまなユーザーアプリケーション(例: DIGITS、Jupyter Notebook、シェルターミナル、TensorBoardなど)にアクセスする機能です。コンテナのアドレスやポート番号を直接知る必要はなく、提供されたCLIクライアントまたはGUI Web-UIを使用して、セッションの目的のデーモンに直接アクセスできます。
2323
- Web-UI: Webまたはスタンドアロンアプリとして提供されるGUIクライアントです。Backend.AIサーバーのアドレスを指定し、ユーザーアカウント情報を入力してログインすることでサービスを利用できます。
24-
- ローカル `wsproxy`: Web-UI アプリに組み込まれたプロキシサーバー。ローカル `wsproxy` は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが `wsproxy` への接続を失うか、`wsproxy` サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。WebUI ではこのコンポーネントを **App Proxy**(旧称 WSProxy)として表示します
25-
- Web `wsproxy`: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、`wsproxy` サーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb `wsproxy` を参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
24+
- ローカル wsproxy: Web-UI アプリに組み込まれたプロキシサーバー。ローカル wsproxy は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが wsproxy への接続を失うか、wsproxy サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。
25+
- Web wsproxy: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、wsproxyサーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb wsproxyを参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
2626

2727

2828
<a id="backend-ai-feature-details"></a>

0 commit comments

Comments
 (0)