You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md
+150-6Lines changed: 150 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -338,28 +338,30 @@ To enable the **Deploy** button on a model card in the Model Store, include `ser
338
338
339
339
## Admin Features
340
340
341
+
<a id="admin-deployments-page"></a>
341
342
<a id="admin-serving-page"></a>
342
343
343
-
### Admin Serving Page
344
+
### Admin Deployments Page
344
345
345
-
Administrators and superadmins can access the Admin Serving page, which provides a cross-project view of all endpoints. This page shows the **Project** column in addition to the standard endpoint list columns, allowing admins to manage services across all projects.
346
+
Administrators and superadmins can access the Admin Deployments page at `/admin-deployments`, which provides a cross-project view of every deployment in the cluster. This page shows the **Project** column in addition to the standard deployment list columns, allowing admins to manage deployments across all projects.
346
347
347
348

348
349
349
-
The Admin Serving page has two tabs:
350
+
The Admin Deployments page has three tabs:
350
351
351
-
- **Serving**: Displays the endpoint list across all projects, with the same lifecycle and property filters as the user-facing Serving page.
352
+
- **Deployments**: Displays the deployment list across all projects, with the same lifecycle and property filters as the user-facing Deployments page.
353
+
- **Deployment Presets**: Lets administrators manage reusable deployment presets that end users can apply when deploying a model. See [Deployment Presets](#deployment-presets) below.
352
354
- **Model Store Management**: Available to superadmins only. See the section below.
353
355
354
356
:::note
355
-
Each individual admin deployment now has its own dedicated route at `/admin-deployments/:id`. When you open a deployment from the Admin Serving page, the URL changes to this path so that the deployment detail can be linked to or bookmarked directly.
357
+
Each individual admin deployment has its own dedicated route at `/admin-deployments/:id`. When you open a deployment from the Admin Deployments page, the URL changes to this path so that the deployment detail can be linked to or bookmarked directly.
356
358
:::
357
359
358
360
<a id="admin-model-store-management"></a>
359
361
360
362
### Admin Model Store Management
361
363
362
-
Superadmins can manage model cards through the **Model Store Management** tab on the Admin Serving page.
364
+
Superadmins can manage model cards through the **Model Store Management** tab on the Admin Deployments page.
363
365
364
366

365
367
@@ -419,6 +421,148 @@ The deletion confirmation dialog includes an **Also delete the associated model
419
421
420
422
The same behavior applies to **bulk deletion** (the label becomes **Also delete all associated model folders**): each selected model card's linked storage folder is moved to the trash when the option is checked, and a trash notification is shown for each folder that was moved.
421
423
424
+
<a id="deployment-presets"></a>
425
+
426
+
## Deployment Presets
427
+
428
+
A **Deployment Preset** is a reusable, administrator-curated bundle of deployment settings — image, runtime, resource slots, cluster mode, environment variables, startup command, replica count, visibility, and other defaults — that end users can apply when they create a model deployment from a storage folder. Presets let administrators publish a small set of vetted, known-good deployment shapes (for example, *vLLM-GPU-Large* or *SGLang-CPU-Small*) so that end users can deploy a model without having to choose every advanced field from scratch.
429
+
430
+

431
+
432
+
### What Is a Deployment Preset?
433
+
434
+
A Deployment Preset captures the defaults of a model deployment so that:
435
+
436
+
- **Administrators** can offer end users a curated catalog of deployment shapes that match the organization's hardware and policy constraints.
437
+
- **End users** can pick a preset when deploying a model from the Data page (via the *Create New Deployment with Preset* flow) and skip filling in advanced fields manually.
438
+
- **Operators** can ensure that production deployments use consistent resource allocations, runtimes, and visibility defaults across the organization.
439
+
440
+
When a deployment is created from a preset, the preset's values pre-populate the deployment launcher fields. Users can still review and adjust those fields before confirming the deployment.
441
+
442
+
Each preset stores the following deployment defaults:
- **Cluster**: Cluster mode (Single-Node or Multi-Node) and cluster size.
448
+
- **Execution**: Startup command, environment variables, and bootstrap script.
449
+
- **Deployment Defaults**: Replica count, revision history limit, and the *Open to Public* visibility default.
450
+
- **Advanced**: Model definition JSON (when needed for a custom runtime).
451
+
452
+
<a id="managing-deployment-presets"></a>
453
+
454
+
### Managing Deployment Presets
455
+
456
+
Only administrators can create, edit, or delete deployment presets. Administrators manage them from the **Deployment Presets** tab on the Admin Deployments page.
457
+
458
+

459
+
460
+
The list view shows each preset with its name, runtime, image, rank, and key resource fields. From this list, administrators can:
461
+
462
+
- Filter presets by name, runtime, or tag.
463
+
- Click a tag chip on any row to filter the list to presets sharing that tag.
464
+
- Open a preset's detail view to inspect its full configuration.
465
+
- Create, edit, or delete a preset.
466
+
467
+
#### Create a Deployment Preset
468
+
469
+
1. Click the **Create Preset** button at the top right of the preset list.
470
+
2. Fill in the fields in the *Create Preset* dialog. The dialog is organized into the following sections:
471
+
472
+
- **Basic Info**:
473
+
* **Name**: A unique preset name (for example, `vLLM-GPU-Large`).
474
+
* **Description**: A short summary of the preset's intended use.
475
+
* **Runtime**: The runtime variant (for example, vLLM, SGLang, or Custom).
476
+
* **Rank**: Display ordering among presets of the same runtime. Lower values appear first.
477
+
- **Image**: The container image to use when deploying.
- **Cluster**: Cluster mode (Single-Node or Multi-Node) and cluster size.
480
+
- **Execution**: Startup command, environment variables, and bootstrap script.
481
+
- **Deployment Defaults**:
482
+
* **Replica Count**: Default number of replicas created from this preset.
483
+
* **Revision History Limit**: Number of past revisions kept for each deployment created from this preset.
484
+
* **Open to Public**: Whether the endpoint of deployments created from this preset is reachable without an access token by default.
485
+
- **Advanced** (optional): Model definition JSON for custom runtimes.
486
+
487
+

488
+
489
+
3. Click **Create Preset** to save. A success notification confirms the preset has been created.
490
+
491
+
:::tip
492
+
If a required field is missing or invalid, the **Create Preset** button stays disabled until the error is resolved. Required fields show inline validation messages as you type.
493
+
:::
494
+
495
+
#### Edit a Deployment Preset
496
+
497
+
1. From the preset list, open the action menu on the preset row (or open the preset's detail view) and select **Edit Preset**.
498
+
2. The *Edit Preset* dialog opens with the preset's current values pre-filled. The available sections are identical to the *Create Preset* dialog.
499
+
3. Adjust the fields as needed, then click **Edit Preset** to save your changes.
500
+
501
+

502
+
503
+
Editing a preset only changes the defaults for **future** deployments. Existing deployments that were already created from this preset are not modified.
504
+
505
+
#### Delete a Deployment Preset
506
+
507
+
1. From the preset list (or the preset's detail view), open the action menu on the preset and select **Delete Preset**.
508
+
2. A typed-confirmation dialog appears asking you to type the preset's name to confirm. The **OK** button stays disabled until the typed value matches the preset name exactly.
509
+
3. Type the preset's name, then click **OK** to confirm.
510
+
511
+
:::danger
512
+
Deleting a deployment preset is **irreversible**. The preset itself is removed, but deployments that were already created from it continue to run unaffected. Future deployments can no longer reference this preset.
End users apply a deployment preset through the **VFolder Deploy** modal, which opens when you deploy a model from a storage folder on the Data page.
520
+
521
+
1. From the Data page, locate the model folder you want to deploy and click **Deploy as Service**.
522
+
2. The VFolder Deploy modal opens, listing the deployment presets available for your project.
523
+
3. Click a preset row to open its **Deployment Preset Detail** view. The detail view shows every field that the preset will apply when used — image, runtime, resources, cluster mode, replica count, visibility, and so on.
524
+
525
+

526
+
527
+
4. From the detail view, choose how to proceed:
528
+
529
+
- **Auto-deploy**: Create the deployment immediately using the preset's values as-is. This is the fastest path; the deployment is created in one click with no further input required.
530
+
- **Manual deploy** (*Create New Deployment with Preset*): Open the deployment launcher with all fields pre-populated from the preset, so you can review and adjust before confirming.
531
+
532
+
:::note
533
+
The active preset, tab key, and other navigation state are preserved in the URL via `URLSearchParams`. You can share a link to a specific preset's detail view, and the recipient lands on the same screen.
534
+
:::
535
+
536
+
### Pre-Populated Launcher Fields
537
+
538
+
When you choose the manual-deploy path, the deployment launcher opens with every field pre-filled from the selected preset:
539
+
540
+
- Image, runtime variant, and resource group.
541
+
- Resource slots, shared memory, and resource options.
542
+
- Cluster mode and cluster size.
543
+
- Startup command and environment variables.
544
+
- Replica count, revision history limit, and **Open to Public** visibility.
545
+
- Auto-selected resource preset, which is preserved across the launcher's initial-value resolution.
546
+
547
+
You can edit any pre-populated field before deploying. Editing a field does **not** modify the underlying preset — it only changes the values used for this one deployment. The preset's defaults remain unchanged for future deployments.
548
+
549
+
:::tip
550
+
If the auto-selected resource preset is the right one for your workload, leave it as-is. The launcher preserves the auto-selection across the initial-values pass, so you do not need to re-select it after switching presets.
551
+
:::
552
+
553
+
### Filtering by Tags
554
+
555
+
Both the user-facing preset list and the admin preset list support **clickable tag chips** that filter the list to presets sharing the clicked tag.
556
+
557
+

558
+
<!-- TODO: Capture screenshot of the deployment preset list filtered by a tag chip -->
559
+
560
+
1. Locate a preset row that has the tag you want to filter by.
561
+
2. Click the tag chip on that row.
562
+
3. The list refreshes to show only presets that include the selected tag. The active filter is reflected in the filter bar; clear it to return to the full list.
563
+
564
+
This is useful when you have many presets and want to quickly narrow down to, for example, all GPU-backed presets or all presets for a specific runtime family.
Copy file name to clipboardExpand all lines: packages/backend.ai-webui-docs/src/en/model_serving/deployment_presets.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ A **Deployment Preset** is a reusable, administrator-curated bundle of deploymen
7
7

8
8
9
9
:::info
10
-
Deployment Presets are part of the Model Serving feature set introduced in version 26.4. Cross-references to preset-aware revision creation are documented in the [Model Serving](#model-serving) page.
10
+
This page lives under the **Administration** section because only administrators can create, edit, and delete deployment presets. End users cannot manage presets themselves, but they can **apply** any preset that has been published to their project when they deploy a model. The two halves of this page reflect that split: [Managing Deployment Presets](#managing-deployment-presets) describes the admin workflow, and [Using a Preset When Deploying a Model](#using-a-preset-when-deploying-a-model) describes the end-user workflow. Preset-aware revision creation is also documented on the [Deployments](#model-serving) page.
11
11
:::
12
12
13
13
## What Is a Deployment Preset?
@@ -30,9 +30,11 @@ Each preset stores the following deployment defaults:
30
30
-**Deployment Defaults**: Replica count, revision history limit, and the *Open to Public* visibility default.
31
31
-**Advanced**: Model definition JSON (when needed for a custom runtime).
32
32
33
-
## (Admin) Manage Deployment Presets
33
+
<aid="managing-deployment-presets"></a>
34
34
35
-
Administrators manage deployment presets from the admin Model Serving area on the **Deployment Presets** tab.
35
+
## Managing Deployment Presets
36
+
37
+
Only administrators can create, edit, or delete deployment presets. Administrators manage them from the **Deployment Presets** tab on the Admin Deployments page.
0 commit comments