Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

update virtual cluster doc #1991

Merged
merged 4 commits into from
Jan 16, 2019
Merged
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
9 changes: 9 additions & 0 deletions docs/webportal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,15 @@ Click the tab "Cluster View" to see the status of the whole cluster. Specificall
* Hardware: Hardware metrics of each machine.
* K8s Dashboard: The Kubernetes Dashboard.

### Virtual cluster management

OpenPAI Virtual Cluster is designed to run jobs as a shared, multi-tenant cluster in an operator-friendly manner while maximizing the throughput and the utilization of the cluster. Click the tab "Virtual Cluster" to see virtual cluster's status and change virtual clusters for user and admin respectively. Specifically (for administrators only):

* Add a new virtual cluster.
* Remove an obsolete virtual cluster.
* Increase or decrease virtual cluster's capacity. Virtual cluster *capacity* in percentage (%) as a float (e.g. 12.5). Jobs in the virtual cluster may consume more resources than its capacity if there are free resources, providing elasticity.
* Change virtual cluster's availability. If a virtual cluster is in `STOPPED` state, new jobs cannot be submitted to *itself*. Existing jobs continue to completion, thus the virtual cluster can be *removed* gracefully. The stopped virtual cluster can also be started and change to `RUNNING` state.

### Read documents

Click the tab "Documents" to read the tutorial of submitting a job.
Expand Down