doc: updated design docs#252
Conversation
Signed-off-by: pggdev <princegupta.ns153@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the design documentation for the Volcano dashboard to reflect the current backend architecture, frontend tech stack (including Vite and MUI), and UI layout. It also adds sections on deployment and RBAC permissions. Feedback suggests standardizing the UI library branding to 'MUI', ensuring the Queues module description includes the details view functionality, and clarifying the permissions section by explicitly listing the Kubernetes API verbs.
| - Use Material-UI component library to design a modern, responsive user interface | ||
| - Implement dynamic rendering and frontend route management through React Router | ||
| - Use Vite for frontend development and build tooling | ||
| - Use Material UI component library to design a modern, responsive user interface |
There was a problem hiding this comment.
For consistency with the official branding and the project's dependencies (@mui/material), it's recommended to refer to the component library as 'MUI' or 'Material-UI'. The current phrasing 'Material UI' is slightly informal and less precise.
| - Use Material UI component library to design a modern, responsive user interface | |
| - Use MUI (Material-UI) component library to design a modern, responsive user interface |
| | Node | Displays cluster node information and resource usage | No newline at end of file | ||
| | Dashboard | Provides a high-level overview of cluster resources, including jobs, queues, pods, status summaries, and charts. | | ||
| | Jobs | Displays Volcano jobs and their statuses, with support for filtering, details, YAML view, and management actions where supported. | | ||
| | Queues | Displays Volcano queues, with support for filtering, YAML view, and management actions where supported. | |
There was a problem hiding this comment.
The description for the Queues module appears to be missing the "details" functionality. The backend provides an endpoint to fetch details for a specific queue, so the documentation should reflect that a detail view is supported, similar to Jobs and PodGroups.
| | Queues | Displays Volcano queues, with support for filtering, YAML view, and management actions where supported. | | |
| | Queues | Displays Volcano queues, with support for filtering, details, YAML view, and management actions where supported. | |
| - Expose the dashboard through the `volcano-dashboard` Service | ||
| - Use a dedicated `volcano-dashboard` ServiceAccount for in-cluster Kubernetes API access | ||
| - Use ClusterRole and ClusterRoleBinding resources to grant the dashboard access to required Volcano and Kubernetes resources | ||
| - Current permissions include read access to Volcano Jobs, Queues, PodGroups, Kubernetes Pods, and Namespaces, with create and delete permissions for Jobs and create, update, patch, and delete permissions for Queues |
There was a problem hiding this comment.
This sentence is quite long and combines many details, which can make it difficult to read. For better clarity, consider rephrasing to separate the read and write permissions more distinctly. Explicitly mentioning the verbs for read access (get, list, watch) would also add valuable detail.
| - Current permissions include read access to Volcano Jobs, Queues, PodGroups, Kubernetes Pods, and Namespaces, with create and delete permissions for Jobs and create, update, patch, and delete permissions for Queues | |
| - Current permissions include read access (`get`, `list`, `watch`) for Jobs, Queues, PodGroups, Pods, and Namespaces, plus write permissions for Jobs (`create`, `delete`) and Queues (`create`, `update`, `patch`, `delete`). |
2 participants
Description
#251
Updated
docs/design.mdto better reflect the current Volcano Dashboard implementation.Changes
Nodemodule reference with current modules such as Pods and PodGroups