diff --git a/docs/Researcher/user-interface/trainings.md b/docs/Researcher/user-interface/trainings.md index 759c024491..e4f12ccb1a 100644 --- a/docs/Researcher/user-interface/trainings.md +++ b/docs/Researcher/user-interface/trainings.md @@ -29,7 +29,7 @@ To add a training: 1. Press **Tranings** in the menu. 2. In the *Projects* pane, select the destination project. Use the search box to find projects that are not listed. If you can't find the project, you can create your own, or see your system administrator. 3. In the *Multi-node* pane, choose `Single node` for a single node training, or `Multi-node (distributed)` for distributed training. When you choose `Multi-node`, select a framework that is listed, then select the `multi-node` training configuration by selecting either `Workers & master` or `Workers only`. -4. In the *Templates* pane, select a template from the list. Use the search box to find templates that are not listed. If you can't find the specific template you need, see [Creating a new template](../../admin/admin-ui-setup/templates.md#creating-templates), or see your system administrator. +4. In the *Templates* pane, select a template from the list. Use the search box to find templates that are not listed. If you can't find the specific template you need, see [Creating a new template](../../admin/workloads/templates.md#creating-templates), or see your system administrator. 5. In the *Training name* pane, enter a name for the *Training*, then press continue. 6. Select an environment from the tiles. If your environment is not listed, use the *Search environments* box to find it or press [*New environment*](workspaces/create/create-env.md) to create a new environment. Press to create an environment if needed. In the *Set the connection for your tool(s)*, enter the URL of the tool if a custom URL has been enabled in the selected environment. Use the *Private* toggle to lock access to the tool to only the creator of the environment. diff --git a/docs/Researcher/user-interface/workspaces/create/create-ds.md b/docs/Researcher/user-interface/workspaces/create/create-ds.md index c5f7a35397..67ecd04c23 100644 --- a/docs/Researcher/user-interface/workspaces/create/create-ds.md +++ b/docs/Researcher/user-interface/workspaces/create/create-ds.md @@ -87,7 +87,7 @@ ConfigMaps must be created on the cluster before being used within Run:ai. When ## Create a Secret as data source * A Run:ai project scope which is assigned to that item and all its subsidiaries. -* A *Credentials*. To create a new *Credentials*, see [Configuring Credentials](../../../../admin/admin-ui-setup/credentials-setup.md#configuring-credentials) +* A *Credentials*. To create a new *Credentials*, see [Configuring Credentials](../../../../admin/workloads/credentials-setup.md#configuring-credentials) !!! Note You can only choose a project as a scope. diff --git a/docs/admin/admin-ui-setup/overview.md b/docs/admin/admin-ui-setup/overview.md deleted file mode 100644 index 5dc8fbd9f1..0000000000 --- a/docs/admin/admin-ui-setup/overview.md +++ /dev/null @@ -1,45 +0,0 @@ -# User Interface Overview - -Run:ai provides a single user interface that, depending on your role, serves both as a control-plane management tool and a researcher workbench. - -The control-plane part of the tool allows the administrator to: - -* Analyze cluster status using [dashboards](dashboard-analysis.md). -* View Job details to be able to help researchers solve Job-related issues. - -The researcher workbench part of the tool allows Researchers to submit, delete and pause [Jobs](jobs.md), view Job logs etc. - -## Setup - -The cluster installation process requires [configuring a new cluster](../runai-setup/cluster-setup/cluster-install.md). -On SaaS-based installations, the cluster creation wizard requires a URL to the cluster as explained [here](../runai-setup/cluster-setup/cluster-prerequisites.md#). - -## Architecture - -* Run:ai saves metadata such as users, projects, departments, clusters, and tenant settings, in the control plane residing on the Run:ai cloud. -* Workload information resides on (sometimes multiple) GPU clusters. -* The Run:ai user interface needs to work with both sources of information. - -As such, the chosen architecture of the user interface is: - -![ui-architecture.png](img/ui-architecture.png) - -* The user interface is served from the management backend. -* The user interface connects directly to multiple GPU clusters using *cross-origin access*. This works using [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS){targe=_blank}: Cross-origin resource sharing. This allows submitting workloads and getting extended logging information directly from the GPU clusters. -* Meta-data, such as Projects, Settings, and Job information is synced into the management backend via a cluster-sync service. Cluster-sync creates an outbound-only channel with no incoming HTTPS connections. - -!!! Important note - One corollary of this architecture is that for SaaS-based tenants, the user interface will only be able to access the cluster when the browser is inside the corporate firewall. When working outside the firewall. Workload-related functionality such as Submitting a Job, viewing Job lots etc, is disabled. - -## Administrator Messages - -System administrators can use *Administrator messages* to make announcements to users once they have logged in. These messages typically are used to keep user informed about different aspects of the platform. - -To configure an *Administrator message*: - -1. Press `Settings | General`. -2. Expand the *Message from administrator* pane. -3. Press *Message*. -4. Enter your message in the text box. Use the formatting tools in the toolbar to add special formatting or links to the message. -5. Enable the `Display "Don't show this again" checkbox on message to users` to allow the users to see the message only once. -6. Press *Publish* when complete. diff --git a/docs/admin/admin-ui-setup/img/tools-and-settings.svg b/docs/admin/authentication/img/tools-and-settings.svg similarity index 100% rename from docs/admin/admin-ui-setup/img/tools-and-settings.svg rename to docs/admin/authentication/img/tools-and-settings.svg diff --git a/docs/admin/authentication/rbac.md b/docs/admin/authentication/rbac.md index 5678185ff1..69bf314e5c 100644 --- a/docs/admin/authentication/rbac.md +++ b/docs/admin/authentication/rbac.md @@ -97,7 +97,7 @@ The table contains the following columns: To create a new access rule: -1. Press the ![Tools and Settings](../admin-ui-setup/img/tools-and-settings.svg) icon, then *Access rules & Roles*. +1. Press the ![Tools and Settings](img/tools-and-settings.svg) icon, then *Access rules & Roles*. 2. Choose the *ACCESS RULES* tab, then press *NEW ACCESS RULE*. 3. Select a subject type from the dropdown. Choose from: @@ -115,5 +115,5 @@ To create a new access rule: To delete a rule: -1. Press the ![Tools and Settings](../admin-ui-setup/img/tools-and-settings.svg) icon, then *Roles and Access rules*. +1. Press the ![Tools and Settings](img/tools-and-settings.svg) icon, then *Roles and Access rules*. 2. Choose *Access rules*, then select a rule and press *Delete*. diff --git a/docs/admin/authentication/researcher-authentication.md b/docs/admin/authentication/researcher-authentication.md index 3c774f4fab..127dcce0c2 100644 --- a/docs/admin/authentication/researcher-authentication.md +++ b/docs/admin/authentication/researcher-authentication.md @@ -170,8 +170,6 @@ You can also submit a Job from the Run:ai User interface and verify that the new ## Test via User Interface -* Open the Run:ai user interface, go to `Jobs`. -* On the top-right, select `Submit Job`. +* Open the Run:ai user interface, go to `Workloads`. +* On the top-right, select `Submit Workload`. -!!! Tip - If you do not see the button or it is disabled, then you either do not have `Researcher` access or the cluster has not been set up correctly. For more information, refer to [user interface overview](../admin-ui-setup/overview.md). diff --git a/docs/admin/admin-ui-setup/dashboard-analysis.md b/docs/admin/performance/dashboard-analysis.md similarity index 100% rename from docs/admin/admin-ui-setup/dashboard-analysis.md rename to docs/admin/performance/dashboard-analysis.md diff --git a/docs/admin/admin-ui-setup/img/cluster-wizard.png b/docs/admin/performance/img/cluster-wizard.png similarity index 100% rename from docs/admin/admin-ui-setup/img/cluster-wizard.png rename to docs/admin/performance/img/cluster-wizard.png diff --git a/docs/admin/admin-ui-setup/img/consumption-dashboard-gpu-over-time.png b/docs/admin/performance/img/consumption-dashboard-gpu-over-time.png similarity index 100% rename from docs/admin/admin-ui-setup/img/consumption-dashboard-gpu-over-time.png rename to docs/admin/performance/img/consumption-dashboard-gpu-over-time.png diff --git a/docs/admin/admin-ui-setup/img/consumption-dashboard-project-over-quota-graph.png b/docs/admin/performance/img/consumption-dashboard-project-over-quota-graph.png similarity index 100% rename from docs/admin/admin-ui-setup/img/consumption-dashboard-project-over-quota-graph.png rename to docs/admin/performance/img/consumption-dashboard-project-over-quota-graph.png diff --git a/docs/admin/admin-ui-setup/img/consumption-dashboard-time-picker.png b/docs/admin/performance/img/consumption-dashboard-time-picker.png similarity index 100% rename from docs/admin/admin-ui-setup/img/consumption-dashboard-time-picker.png rename to docs/admin/performance/img/consumption-dashboard-time-picker.png diff --git a/docs/admin/admin-ui-setup/img/consumption-dashboard.png b/docs/admin/performance/img/consumption-dashboard.png similarity index 100% rename from docs/admin/admin-ui-setup/img/consumption-dashboard.png rename to docs/admin/performance/img/consumption-dashboard.png diff --git a/docs/admin/admin-ui-setup/img/cpu-utilization.png b/docs/admin/performance/img/cpu-utilization.png similarity index 100% rename from docs/admin/admin-ui-setup/img/cpu-utilization.png rename to docs/admin/performance/img/cpu-utilization.png diff --git a/docs/admin/admin-ui-setup/img/deployment-list.png b/docs/admin/performance/img/deployment-list.png similarity index 100% rename from docs/admin/admin-ui-setup/img/deployment-list.png rename to docs/admin/performance/img/deployment-list.png diff --git a/docs/admin/admin-ui-setup/img/deployment-properties.png b/docs/admin/performance/img/deployment-properties.png similarity index 100% rename from docs/admin/admin-ui-setup/img/deployment-properties.png rename to docs/admin/performance/img/deployment-properties.png diff --git a/docs/admin/admin-ui-setup/img/gpu-allocation.png b/docs/admin/performance/img/gpu-allocation.png similarity index 100% rename from docs/admin/admin-ui-setup/img/gpu-allocation.png rename to docs/admin/performance/img/gpu-allocation.png diff --git a/docs/admin/admin-ui-setup/img/gpu-utilization.png b/docs/admin/performance/img/gpu-utilization.png similarity index 100% rename from docs/admin/admin-ui-setup/img/gpu-utilization.png rename to docs/admin/performance/img/gpu-utilization.png diff --git a/docs/admin/admin-ui-setup/img/idle-gpus.png b/docs/admin/performance/img/idle-gpus.png similarity index 100% rename from docs/admin/admin-ui-setup/img/idle-gpus.png rename to docs/admin/performance/img/idle-gpus.png diff --git a/docs/admin/admin-ui-setup/img/job-list.png b/docs/admin/performance/img/job-list.png similarity index 100% rename from docs/admin/admin-ui-setup/img/job-list.png rename to docs/admin/performance/img/job-list.png diff --git a/docs/admin/admin-ui-setup/img/job-logs.png b/docs/admin/performance/img/job-logs.png similarity index 100% rename from docs/admin/admin-ui-setup/img/job-logs.png rename to docs/admin/performance/img/job-logs.png diff --git a/docs/admin/admin-ui-setup/img/jobs-with-errors.png b/docs/admin/performance/img/jobs-with-errors.png similarity index 100% rename from docs/admin/admin-ui-setup/img/jobs-with-errors.png rename to docs/admin/performance/img/jobs-with-errors.png diff --git a/docs/admin/admin-ui-setup/img/long-jobs.png b/docs/admin/performance/img/long-jobs.png similarity index 100% rename from docs/admin/admin-ui-setup/img/long-jobs.png rename to docs/admin/performance/img/long-jobs.png diff --git a/docs/admin/admin-ui-setup/img/multi-cluster-overview.png b/docs/admin/performance/img/multi-cluster-overview.png similarity index 100% rename from docs/admin/admin-ui-setup/img/multi-cluster-overview.png rename to docs/admin/performance/img/multi-cluster-overview.png diff --git a/docs/admin/admin-ui-setup/img/node-downtime.png b/docs/admin/performance/img/node-downtime.png similarity index 100% rename from docs/admin/admin-ui-setup/img/node-downtime.png rename to docs/admin/performance/img/node-downtime.png diff --git a/docs/admin/admin-ui-setup/img/pending-jobs.png b/docs/admin/performance/img/pending-jobs.png similarity index 100% rename from docs/admin/admin-ui-setup/img/pending-jobs.png rename to docs/admin/performance/img/pending-jobs.png diff --git a/docs/admin/admin-ui-setup/img/queue.png b/docs/admin/performance/img/queue.png similarity index 100% rename from docs/admin/admin-ui-setup/img/queue.png rename to docs/admin/performance/img/queue.png diff --git a/docs/admin/admin-ui-setup/img/settings-icon.png b/docs/admin/performance/img/settings-icon.png similarity index 100% rename from docs/admin/admin-ui-setup/img/settings-icon.png rename to docs/admin/performance/img/settings-icon.png diff --git a/docs/admin/admin-ui-setup/img/specific-job.png b/docs/admin/performance/img/specific-job.png similarity index 100% rename from docs/admin/admin-ui-setup/img/specific-job.png rename to docs/admin/performance/img/specific-job.png diff --git a/docs/admin/admin-ui-setup/img/submit-deployment.png b/docs/admin/performance/img/submit-deployment.png similarity index 100% rename from docs/admin/admin-ui-setup/img/submit-deployment.png rename to docs/admin/performance/img/submit-deployment.png diff --git a/docs/admin/admin-ui-setup/img/submit-job.png b/docs/admin/performance/img/submit-job.png similarity index 100% rename from docs/admin/admin-ui-setup/img/submit-job.png rename to docs/admin/performance/img/submit-job.png diff --git a/docs/admin/admin-ui-setup/img/training-interactive.png b/docs/admin/performance/img/training-interactive.png similarity index 100% rename from docs/admin/admin-ui-setup/img/training-interactive.png rename to docs/admin/performance/img/training-interactive.png diff --git a/docs/admin/admin-ui-setup/img/ui-architecture.png b/docs/admin/performance/img/ui-architecture.png similarity index 100% rename from docs/admin/admin-ui-setup/img/ui-architecture.png rename to docs/admin/performance/img/ui-architecture.png diff --git a/docs/admin/runai-setup/cluster-setup/cluster-install.md b/docs/admin/runai-setup/cluster-setup/cluster-install.md index 497e3106cf..29402d5c57 100644 --- a/docs/admin/runai-setup/cluster-setup/cluster-install.md +++ b/docs/admin/runai-setup/cluster-setup/cluster-install.md @@ -33,7 +33,7 @@ On the next page: ## Verify your cluster's health * Verify that the cluster status in the Run:ai Control Plane's [Clusters Table](#cluster-table) is `Connected`. -* Go to the [Overview Dashboard](../../admin-ui-setup/dashboard-analysis.md#overview-dashboard) and verify that the number of GPUs on the top right reflects your GPU resources on your cluster and the list of machines with GPU resources appears on the bottom line. +* Go to the [Overview Dashboard](../../performance/dashboard-analysis.md#overview-dashboard) and verify that the number of GPUs on the top right reflects your GPU resources on your cluster and the list of machines with GPU resources appears on the bottom line. * In case of issues, see the [Troubleshooting guide](../../troubleshooting/cluster-health-check.md). ## Researcher Authentication diff --git a/docs/admin/runai-setup/config/admin-messages.md b/docs/admin/runai-setup/config/admin-messages.md new file mode 100644 index 0000000000..b8dfe24c2e --- /dev/null +++ b/docs/admin/runai-setup/config/admin-messages.md @@ -0,0 +1,13 @@ + +# Administrator Messages + +System administrators can use *Administrator messages* to make announcements to users once they have logged in. These messages typically are used to keep user informed about different aspects of the platform. + +To configure an *Administrator message*: + +1. Press `Settings | General`. +2. Expand the *Message from administrator* pane. +3. Press *Message*. +4. Enter your message in the text box. Use the formatting tools in the toolbar to add special formatting or links to the message. +5. Enable the `Display "Don't show this again" checkbox on message to users` to allow the users to see the message only once. +6. Press *Publish* when complete. diff --git a/docs/admin/admin-ui-setup/credentials-setup.md b/docs/admin/workloads/credentials-setup.md similarity index 100% rename from docs/admin/admin-ui-setup/credentials-setup.md rename to docs/admin/workloads/credentials-setup.md diff --git a/docs/admin/admin-ui-setup/templates.md b/docs/admin/workloads/templates.md similarity index 100% rename from docs/admin/admin-ui-setup/templates.md rename to docs/admin/workloads/templates.md diff --git a/docs/developer/cluster-api/workload-overview-dev.md b/docs/developer/cluster-api/workload-overview-dev.md index e85d480cef..3ee760a2da 100644 --- a/docs/developer/cluster-api/workload-overview-dev.md +++ b/docs/developer/cluster-api/workload-overview-dev.md @@ -62,7 +62,7 @@ FIELDS: A Workload can be submitted via various channels: -* The Run:ai [user interface](../../admin/admin-ui-setup/jobs.md). +* The Run:ai user interface. * The Run:ai command-line interface, via the [runai submit](../../Researcher/cli-reference/runai-submit.md) command. * The Run:ai [Cluster API](submit-yaml.md). diff --git a/docs/home/data-privacy-details.md b/docs/home/data-privacy-details.md index d6b0d1af69..5e2264e5c5 100644 --- a/docs/home/data-privacy-details.md +++ b/docs/home/data-privacy-details.md @@ -15,7 +15,7 @@ Following is a list of platform data items that are sent to the Run:ai cloud. |---------|---------------| | Workload Metrics | Workload names, CPU, GPU, and Memory metrics, parameters sent using the `runai submit` command | | Workload Assets | Workload [Assets](../Researcher/user-interface/workspaces/blocks/building-blocks.md) such as environments, compute resources and data resoruces | -| Resource Credentials | [Credentials](../admin/admin-ui-setup/credentials-setup.md) to cluster resources are stored and encrypted using a SHA-512 algorithm. The encryption is tenant-specific | +| Resource Credentials | [Credentials](../admin/workloads/credentials-setup.md) to cluster resources are stored and encrypted using a SHA-512 algorithm. The encryption is tenant-specific | | Node Metrics | Node names and IPs, CPU, GPU, and Memory metrics | | Cluster Metrics | Cluster names, CPU, GPU, and Memory metrics | | Projects & Departments | Names, quota information | diff --git a/docs/home/whats-new-2-13.md b/docs/home/whats-new-2-13.md index db2698eb7d..4617fce223 100644 --- a/docs/home/whats-new-2-13.md +++ b/docs/home/whats-new-2-13.md @@ -65,7 +65,7 @@ This version contains features and fixes from previous versions starting with 2. **Dashboards** -* Added a new dashboard for **Quota management**, which provides an efficient means to monitor and manage resource utilization within the AI cluster. The dashboard filters the display of resource quotas based on *Departments*, *Projects*, and *Node pools*. For more information, see [Quota management dashboard](../admin/admin-ui-setup/dashboard-analysis.md#quota-management-dashboard). +* Added a new dashboard for **Quota management**, which provides an efficient means to monitor and manage resource utilization within the AI cluster. The dashboard filters the display of resource quotas based on *Departments*, *Projects*, and *Node pools*. For more information, see [Quota management dashboard](../admin/performance/dashboard-analysis.md#quota-management-dashboard). * Added to the **Overview dashboard**, the ability to filter the cluster by one or more node pools. For more information, see [Node pools](../Researcher/scheduling/using-node-pools.md). @@ -110,7 +110,7 @@ The association between workspaces and node pools is done using *Compute resourc **Credentials** -* Added *Docker registry* to the *Credentials* menu. Users can create docker credentials for use in specific projects for image pulling. To configure credentials, see [Configuring credentials](../admin/admin-ui-setup/credentials-setup.md#configuring-credentials). +* Added *Docker registry* to the *Credentials* menu. Users can create docker credentials for use in specific projects for image pulling. To configure credentials, see [Configuring credentials](../admin/workloads/credentials-setup.md#configuring-credentials). diff --git a/docs/home/whats-new-2-15.md b/docs/home/whats-new-2-15.md index 51fad71592..be70fcf204 100644 --- a/docs/home/whats-new-2-15.md +++ b/docs/home/whats-new-2-15.md @@ -43,7 +43,7 @@ date: 2023-Dec-3 #### Credentials -* Improved *Credentials* creation. A Run:ai scope can now be added to credentials. For more information, see [Credentials](../admin/admin-ui-setup/credentials-setup.md). +* Improved *Credentials* creation. A Run:ai scope can now be added to credentials. For more information, see [Credentials](../admin/workloads/credentials-setup.md). #### Environments @@ -55,7 +55,7 @@ date: 2023-Dec-3 #### Templates -* Added support for Run:ai a *Scope* in the template form. For configuration information, see [Creating templates](../admin/admin-ui-setup/templates.md#creating-templates). +* Added support for Run:ai a *Scope* in the template form. For configuration information, see [Creating templates](../admin/workloads/templates.md#creating-templates). #### Deployments @@ -99,9 +99,9 @@ date: 2023-Dec-3 #### Dashboards -* To ease the management of AI CPU and cluster resources, a new CPU focused dashboard was added for CPU based environments. The dashboards display specific information for CPU based nodes, node-pools, clusters, or tenants. These dashboards also include additional metrics that are specific to CPU based environments. This will help optimize visual information eliminating the views of empty GPU dashlets. For more information see [CPU Dashboard](../admin/admin-ui-setup/dashboard-analysis.md#cpu-dashboard). +* To ease the management of AI CPU and cluster resources, a new CPU focused dashboard was added for CPU based environments. The dashboards display specific information for CPU based nodes, node-pools, clusters, or tenants. These dashboards also include additional metrics that are specific to CPU based environments. This will help optimize visual information eliminating the views of empty GPU dashlets. For more information see [CPU Dashboard](../admin/performance/dashboard-analysis.md#cpu-dashboard). * Improved the Consumption report interface by moving the Cost settings to the *General* settings menu. -* Added an additional table to the Consumption dashboard that displays the consumption and cost per department. For more information, see [Consumption dashboard](../admin/admin-ui-setup/dashboard-analysis.md#consumption-dashboard). +* Added an additional table to the Consumption dashboard that displays the consumption and cost per department. For more information, see [Consumption dashboard](../admin/performance/dashboard-analysis.md#consumption-dashboard). #### Nodes diff --git a/docs/home/whats-new-2-16.md b/docs/home/whats-new-2-16.md index e67f1cf2e4..fad9843629 100644 --- a/docs/home/whats-new-2-16.md +++ b/docs/home/whats-new-2-16.md @@ -33,7 +33,7 @@ date: 2023-Dec-4 ### Run:ai Administrator -* Added the capability for administrators to configure messages to users when they log into the platform. Messages are configured using the *Message Editor* screen. For more information, see [Administrator Messages](../admin/admin-ui-setup/overview.md#administrator-messages). +* Added the capability for administrators to configure messages to users when they log into the platform. Messages are configured using the *Message Editor* screen. For more information, see [Administrator Messages](../admin/runai-setup/config/admin-messages.md). #### Monitoring and Analytics @@ -42,7 +42,7 @@ date: 2023-Dec-4 * Added a chart displaying the number of free GPUs per node. Free GPU are GPUs that have not been allocated to a workload. * Added a dashlet that displays the total vs. ready resources for GPUs and CPUs. The dashlet indicates how many total nodes are in the platform, and how many are available. - For more information, see [Total and Ready GPU or CPU Nodes](../admin/admin-ui-setup/dashboard-analysis.md#total-and-ready-gpu-or-cpu-nodes). + For more information, see [Total and Ready GPU or CPU Nodes](../admin/performance/dashboard-analysis.md#total-and-ready-gpu-or-cpu-nodes). * Added additional columns to the consumption report for both *Projects* and *Departments* tables. The new columns are: @@ -50,7 +50,7 @@ date: 2023-Dec-4 * CPU usage hours—the actual usage time of CPU. * Memory usage time—the actual usage time of CPU memory. - For more information, see [Consumption Dashboard](../admin/admin-ui-setup/dashboard-analysis.md#consumption-dashboard). + For more information, see [Consumption Dashboard](../admin/performance/dashboard-analysis.md#consumption-dashboard). #### Authentication and Authorization diff --git a/docs/home/whats-new-2-17.md b/docs/home/whats-new-2-17.md index 0c24c32110..b41968086f 100644 --- a/docs/home/whats-new-2-17.md +++ b/docs/home/whats-new-2-17.md @@ -43,7 +43,7 @@ date: 2024-Apr-14 * Added the capability to use a ConfigMap as a data source. The ability to use a ConfigMap as a data source can be configured in the *Data sources* UI, the CLI, and as part of a policy. For more information, see [Setup a ConfigMap as a data source](../Researcher/user-interface/workspaces/create/create-ds.md#create-a-configmap-data-source), [Setup a ConfigMap as a volume using the CLI](../Researcher/cli-reference/runai-submit.md#-configmap-volume-namepath), or [Setup a ConfigMap Resource description fields](../admin/workloads/policies/training-policy.md#configmap-resource-description-fields) in training policies. -* Added a *Status* column to the *Credentials* table, and the *Data sources* table. The *Status* column displays the state of the resource and provides troubleshooting information about that asset. For more information, see the [Credentials table](../admin/admin-ui-setup/credentials-setup.md#credentials-table) and the [Data sources table](../Researcher/user-interface/workspaces/create/create-ds.md#data-sources-table). +* Added a *Status* column to the *Credentials* table, and the *Data sources* table. The *Status* column displays the state of the resource and provides troubleshooting information about that asset. For more information, see the [Credentials table](../admin/workloads/credentials-setup.md#credentials-table) and the [Data sources table](../Researcher/user-interface/workspaces/create/create-ds.md#data-sources-table). * Added functionality for asset creation that validates the asset based on version compatibility of the cluster or the control plane within a specific scope. At time of asset creation, invalid scopes will appear greyed out and will show a pop-up with the reason for the invalidation. This improvement is designed to increase the confidence that an asset is created properly and successfully. @@ -85,7 +85,7 @@ date: 2024-Apr-14 #### Monitoring and Analytics -* Improved GPU Overview dashboard. This improvement provides rich and extensive GPU allocation and performance data and now has interactive tiles that provide direct links to the *Nodes*, *Workloads*, and *Departments* tables. Hover over tiles with graphs to show rich data in the selected time frame filter. Tiles with graphs can be downloaded as CSV files. The new dashboard is enabled by default. Use the *Go back to legacy view* to return to the previous dashboard style. For more information, see [Dashboard analysis](../admin/admin-ui-setup/dashboard-analysis.md). +* Improved GPU Overview dashboard. This improvement provides rich and extensive GPU allocation and performance data and now has interactive tiles that provide direct links to the *Nodes*, *Workloads*, and *Departments* tables. Hover over tiles with graphs to show rich data in the selected time frame filter. Tiles with graphs can be downloaded as CSV files. The new dashboard is enabled by default. Use the *Go back to legacy view* to return to the previous dashboard style. For more information, see [Dashboard analysis](../admin/performance/dashboard-analysis.md). * Updated the knative and autoscaler metrics. Run:ai currently supports the following metrics: diff --git a/docs/admin/admin-ui-setup/admin-ui-users.md b/graveyard/admin-ui-users.md similarity index 100% rename from docs/admin/admin-ui-setup/admin-ui-users.md rename to graveyard/admin-ui-users.md diff --git a/docs/admin/admin-ui-setup/jobs.md b/graveyard/jobs.md similarity index 100% rename from docs/admin/admin-ui-setup/jobs.md rename to graveyard/jobs.md diff --git a/graveyard/sso.md b/graveyard/sso.md index cbb1f7e038..918eae944d 100644 --- a/graveyard/sso.md +++ b/graveyard/sso.md @@ -322,7 +322,7 @@ The latter option is easier to maintain. * Go to `Tools & Settings`, then press `Users`. * Select the `Users` button at the top. -* Map users as explained [here](../../admin-ui-setup/admin-ui-users.md). +* Map users. ### Mapping Role Groups diff --git a/graveyard/whats-new-2-10.md b/graveyard/whats-new-2-10.md index 01ec25905f..3f9104a62a 100644 --- a/graveyard/whats-new-2-10.md +++ b/graveyard/whats-new-2-10.md @@ -128,7 +128,7 @@ April 2023 **Credential Manager** -This feature provides configuration for credentials that are used to unlock protected resources such as applications, containers, and other assets. For configuration information, see [Credentials](../admin/admin-ui-setup/credentials-setup.md). +This feature provides configuration for credentials that are used to unlock protected resources such as applications, containers, and other assets. For configuration information, see [Credentials](../admin/workloads/credentials-setup.md). **SSO custom URL logout** @@ -136,7 +136,7 @@ This feature configures a custom logout URL in your tenant. For configuration in **Department Administrator** -The new role of *Department Administrator* adds a layer of delegation in the administration of departments. For an explanation of the role, see [Create a user](../admin/admin-ui-setup/admin-ui-users.md#create-a-user). For Department configuration information, see [Assigning the Department Administrator role](../admin/admin-ui-setup/department-setup.md#assign-department-administrator-role). +The new role of *Department Administrator* adds a layer of delegation in the administration of departments. For an explanation of the role, see Create a user. For Department configuration information, see Assigning the Department Administrator role. **Enable SSO Using OIDC** diff --git a/graveyard/whats-new-2-12.md b/graveyard/whats-new-2-12.md index 8632444045..fa1f41f7ed 100644 --- a/graveyard/whats-new-2-12.md +++ b/graveyard/whats-new-2-12.md @@ -64,7 +64,7 @@ May 2023 **Single sign on** -When SSO is enabled, you can still create and authenticate with Local users. For configuration of local users and SSO users, see [Create a new user](../admin/admin-ui-setup/admin-ui-users.md#create-a-user). +When SSO is enabled, you can still create and authenticate with Local users. For configuration of local users and SSO users, see Create a new user ##### Researcher tools enhancements diff --git a/graveyard/whats-new-2-14.md b/graveyard/whats-new-2-14.md index c858510c6f..28fdac3746 100644 --- a/graveyard/whats-new-2-14.md +++ b/graveyard/whats-new-2-14.md @@ -42,7 +42,7 @@ TODO Add RBAC old--new conversion table here. --> ### Resource costing -* Added an additional table to the Consumption dashboard that contains the consumption per department and the cost per department. For more information, see [Consumption dashboard](../admin/admin-ui-setup/dashboard-analysis.md#consumption-dashboard). +* Added table to the Consumption dashboard that contains the consumption per department and the cost per department. For more information, see Consumption dashboard ### Deployment improvements diff --git a/graveyard/whats-new-2-9.md b/graveyard/whats-new-2-9.md index 2819f808c8..1241dc9bc2 100644 --- a/graveyard/whats-new-2-9.md +++ b/graveyard/whats-new-2-9.md @@ -71,7 +71,7 @@ Run:ai has revised the nodes table, adding new information fields and graphs. It **Consumption Dashboard** -Added a “Consumption” dashboard. When enabled by the “Show Consumption Dashboard” alpha flag under “Settings”, this dashboard allows the admin to review consumption patterns for GPUs, CPUs and RAM over time. You can segregate consumption by over or in-quota allocation in the project or department level. For more information, see [Consumption dashboard](../admin/admin-ui-setup/dashboard-analysis.md#consumption-dashboard). +Added a “Consumption” dashboard. When enabled by the “Show Consumption Dashboard” alpha flag under “Settings”, this dashboard allows the admin to review consumption patterns for GPUs, CPUs and RAM over time. You can segregate consumption by over or in-quota allocation in the project or department level. For more information, see [Consumption dashboard](../admin/performance/dashboard-analysis.md#consumption-dashboard). **Event History (Audit Log UI)** diff --git a/graveyard/whats-new-2020.md b/graveyard/whats-new-2020.md index d7a7820be4..cb79291b3f 100644 --- a/graveyard/whats-new-2020.md +++ b/graveyard/whats-new-2020.md @@ -55,7 +55,7 @@ Run:ai Now supports __Distributed Training__ and __Gang Scheduling__. For furthe ## August 4th, 2020 -There is now an optional second level of Project hierarchy called __Departments__. For further information on how to configure and use Departments, see [Working with Departments](../admin/admin-ui-setup/department-setup.md) +There is now an optional second level of Project hierarchy called __Departments__. For further information on how to configure and use Departments, see Working with Departments ## July 28th, 2020 @@ -84,13 +84,13 @@ Projects now support _Node Affinity._ This feature allows the Administrator to a * The Project team is the owner of specific hardware which was acquired with a specialized budget * We want to direct build/interactive workloads to work on weaker hardware and direct longer training/unattended workloads to faster nodes -For further information see: [Working with Projects](../admin/admin-ui-setup/project-setup.md) +For further information see: Working with Projects #### Limit Duration of Interactive Jobs Researchers frequently forget to close Interactive Job. This may lead to a waste of resources. Some organizations prefer to limit the duration of interactive Job and close them automatically. -For further information on how to set up duration limits see: [Working with Projects](../admin/admin-ui-setup/project-setup.md) +For further information on how to set up duration limits see: Working with Projects ## May 24th, 2020 diff --git a/graveyard/whats-new-2022.md b/graveyard/whats-new-2022.md index f2ec3a25be..7f4d56d26b 100644 --- a/graveyard/whats-new-2022.md +++ b/graveyard/whats-new-2022.md @@ -69,8 +69,8 @@ To upgrade to version 2.3 cluster from earlier versions, you must uninstall vers The Researcher user interface and the Administrator user interface have been unified into a single unified _Run:ai user interface_. The new user interface is served from `https://.run.ai`. The user interface capabilities are subject to the role of the individual user. -* See [instructions](../admin/admin-ui-setup/overview.md) on how to set up the unified user interface. -* See [user interface Jobs area](../admin/admin-ui-setup/jobs.md) for a description of how to submit, view and delete Jobs from the unified user interface. +* See instructions on how to set up the unified user interface. +* See user interface Jobs area for a description of how to submit, view and delete Jobs from the unified user interface. Other features: @@ -99,7 +99,7 @@ Future versions will be numbered using 2 digits (2.0, 2.1, 2.2, etc.). The numbe ### Release Contents -* To allow for better control over resource allocation, the Run:ai platform now provides the ability to define different over-quota priorities for projects. For full details see [Controlling over-quota behavior](../../admin/admin-ui-setup/project-setup/#controlling-over-quota-behavior). +* To allow for better control over resource allocation, the Run:ai platform now provides the ability to define different over-quota priorities for projects. For full details see Controlling over-quota behavior. * To help review and track resource consumption per department, the Department object was added to multiple dashboard metrics. Supportability enhancements: diff --git a/graveyard/workload-overview-admin.md b/graveyard/workload-overview-admin.md index 5e482900be..d62b12d57f 100644 --- a/graveyard/workload-overview-admin.md +++ b/graveyard/workload-overview-admin.md @@ -56,16 +56,13 @@ A Workload will typically have a list of *values* (sometimes called *flags*), su A Workload can be submitted via in the following ways: -* The Run:ai [user interface](../../admin/admin-ui-setup/jobs.md). +* The Run:ai user interface. * The Run:ai command-line interface, via the [runai submit](../../Researcher/cli-reference/runai-submit.md) command. * The Run:ai [Cluster API](../../developer/cluster-api/workload-overview-dev.md). * The Run:ai *Workloads* page. ### Submit a Workload Using the UI -!!! Important - Make sure you have the `Workloads` view enabled. To enable this view, see [Workloads toggle](../admin-ui-setup/jobs.md#workloads-toggle) - To submit a workload using the UI: 1. In the left menu press *Workloads*. diff --git a/mkdocs.yml b/mkdocs.yml index 370f1b5cd0..13a2ff1825 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,6 +116,9 @@ plugins: 'admin/admin-ui-setup/admin-ui-users.md' : 'admin/authentication/users.md' 'admin/runai-setup/authentication/authentication-overview.md' : 'admin/authentication/authentication-overview.md' 'admin/runai-setup/authentication/researcher-authentication.md' : 'admin/authentication/researcher-authentication.md' + 'admin/admin-ui-setup/credentials-setup.md' : 'admin/workloads/credentials-setup.md' + 'admin/admin-ui-setup/templates.md' : 'admin/workloads/templates.md' + 'admin/admin-ui-setup/dashboard-analysis.md' : 'admin/performance/dashboard-analysis.md' nav: - Home: - 'Overview': 'index.md' @@ -179,6 +182,7 @@ nav: - 'Backup & Restore' : 'admin/runai-setup/config/dr.md' - 'High Availability' : 'admin/runai-setup/config/ha.md' - 'Scaling' : 'admin/runai-setup/config/large-clusters.md' + - 'Administrator Messages' : 'admin/runai-setup/config/admin-messages.md' - 'Notifications System': - 'Email and System Notifications': 'admin/runai-setup/notifications/notifications.md' - 'Maintenance' : @@ -215,15 +219,12 @@ nav: # - 'Managing your resources' : # - 'Nodes' : 'admin/aiinitiatives/resources/nodes.md' # - 'Node Pools' : 'admin/aiinitiatives/resources/node-pools.md' - - 'User Interface' : - - 'Overview' : 'admin/admin-ui-setup/overview.md' + - 'Review your performance' : +# - 'Overview' : 'admin/admin-ui-setup/overview.md' # - 'Users' : 'admin/admin-ui-setup/admin-ui-users.md' # - 'Projects' : 'admin/admin-ui-setup/project-setup.md' # - 'Departments' : 'admin/admin-ui-setup/department-setup.md' - - 'Dashboard Analysis' : 'admin/admin-ui-setup/dashboard-analysis.md' - - 'Jobs' : 'admin/admin-ui-setup/jobs.md' - - 'Credentials' : 'admin/admin-ui-setup/credentials-setup.md' - - 'Templates': 'admin/admin-ui-setup/templates.md' + - 'Dashboard Analysis' : 'admin/performance/dashboard-analysis.md' - 'Workloads' : - 'admin/workloads/README.md' - 'Policies' : @@ -234,6 +235,9 @@ nav: - 'Secrets' : 'admin/workloads/secrets.md' - 'Inference' : 'admin/workloads/inference-overview.md' - 'Submitting Workloads' : 'admin/workloads/submitting-workloads.md' + - 'Credentials' : 'admin/workloads/credentials-setup.md' + - 'Templates': 'admin/workloads/templates.md' + - 'Troubleshooting' : - 'Cluster Health' : 'admin/troubleshooting/cluster-health-check.md' - 'Troubleshooting' : 'admin/troubleshooting/troubleshooting.md'