Validation Checklist
Open
Nobody has claimed this yet.
pai-dev
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 554
- Avg merge
- 20h 42m
- Merged PRs (30d)
- 14
Description
Validation Checklist
The validation checklist after deploy.
Alert
- Test item completed. @Binyang2014
- Check if the new bits trigger any alert!
Version
- Test item completed. @hzy46
- Version beside the "Feedback" menu item in web portal, can be modified in "version" field of "src/webportal/package.json"
User Management
- Test item completed. @abuccts
Username and password can be found in services-configuration config file: restserver->default-pai-admin-{username, password}
- Login:
- Correct username/password => login success
- Incorrect username/password => login fails with corresponding error message
- Logout:
- Login user can logout
- Change own password
- Admin user:
- List users
- Add users
- Update users VC, password
Virtual Clusters
- Test item completed. @abuccts
- Displayed VC names, capacity, memory, CPU, GPU consist with configuration
- “View Jobs” can be accessed and content correct
- Add a new vc
- Delete a vc
Dashboard view
- Test item completed. @Binyang2014
- Landing page dashboard
- The Grafana page shown correctly (e.g., no "N/A", "no data point")
- K8s dashboard: (admin user only)
- All pods and daemon sets are running well
- User can view pod's log and exec command from kubernetes dashboard
- Service view: (admin user only)
- Node name, role and count consist with configuration file, PAI_TASK_ROLE_COUNT
- Service status green
- Hardware view: (admin user only)
- IP address, machine name correct
- No ‘N/A’ value in CPU/Memory/GPU/GPU Mem/Disk/Ethernet status
- Grafana view:
- Cluster metrics
- Node metrics
- Job level metrics (go to jobs page, and select one running job then click "Go to Job Metrics Page")
- Task level metrics (go to jobs page, and select one running job then click "Go to Job Metrics Page")
- Task role level metrics (go to jobs page, and select one running job then click "Go to Job Metrics Page")
Jobs Page
- Test item completed. @yiyione
- Job list
- Job search
- Job sorting according to each column
- Job can be stopped by job owner and button disabled to other users
- View job config
- SSH infos
- Job logs can be accessed during job running and after job finishes.
Submit job
- Test item completed. @abuccts
- Submit form can import job config file and fill in corresponding fields.
- Incorrect json format jobs cannot be accepted.
- Non-login user has no permission to submit job
- Submit jobs to different VCs with/without permission and check result
- Submit sample cntk/tensorflow/etc. jobs and check whether jobs can finish successfully.
Azure RDMA
- Test item completed. @abuccts
- Based on this knowledge, please ensure all worker machines in your cluster is rdma-capable and they are all in the same available set.
- Build the intel-mpi bench marking image. https://github.com/Microsoft/pai/tree/v0.14.0/examples/azure-rdma-inte-mpi-benchmark-with-horovod-image
- Make sure AZ_RDMA is enabled in rest-server env variables
- Submit the job through the webportal with the json in this link.Note: Please change the "image" field with yours image url.
Storage
- Test item completed. @Binyang2014
- Make sure teamwise storage is well set. Go to job submit page, open Data section on the right. Check if "DEFAULT" teamwise config exists and selected
- Add job name, use any docker image, fill Command with
mkdir -p /mnt/data/${PAI_USERNAME} && echo ${PAI_JOB_NAME} > /mnt/data/${PAI_USERNAME}/${PAI_JOB_NAME}.txt - Open folder on teamwise storage machine, enter PAI user's folder and check if new file with job name created.
Client
- Test item completed. @yiyione
- Test NNI tool and try to submit job from NNI to OpenPAI cluster and make sure the job can be submitted and run correctly.
- In Openmind tool launch a job on OpenPAI and check the job can be run correctly.
- Submit jobs in VSCode Client.
Marketplace
- Test item completed. @debuggy
// TODO
Test Scripts
- Test item completed. @yiyione
// TODO
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the validation checklist, src/webportal/package.json, the services-configuration settings, and the Azure RDMA example linked in the issue. Run through the deployment, portal, Kubernetes, dashboard, job, storage, and client checks. Done means the checklist items are completed and the Marketplace and Test Scripts TODOs are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, docker, grafana, javascript, jupyter, kubernetes, pytorch, tensorflow, vscode
- Domain
- cloud, devops, documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100