website
website copied to clipboard
Add admission policy documentation
- Please check if the PR fulfills these requirements
- [x] The commit message follows our guidelines
- What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
/kind documentation
-
What this PR does / why we need it:
-
Which issue(s) this PR fixes:
Welcome @suyiiyii!
It looks like this is your first PR to volcano-sh/website.
Thank you, and welcome to Volcano. :smiley:
Summary of Changes
Hello @suyiiyii, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request adds new documentation for Volcano's Validating Admission Policy (VAP) and Mutating Admission Policy (MAP). The documentation clarifies how these policies enhance resource validation and modification within Volcano, offering detailed guides on their installation via Helm or YAML, configuration, and usage. It also covers essential prerequisites and notes on the interplay between these new policies and existing webhooks, ensuring users can effectively implement and manage them.
Highlights
- New Admission Policy Documentation: Introduced comprehensive documentation for Volcano's Validating Admission Policy (VAP) and Mutating Admission Policy (MAP), explaining their role in validating and modifying Volcano resources.
- Installation and Configuration Guidance: Provided detailed instructions on how to enable VAP and MAP during Volcano installation using both Helm and direct YAML manifests, including specific configuration options.
- Usage and Verification Steps: Included practical steps for users to verify that VAP and MAP are active post-installation and demonstrated how to test validation with an example of an invalid job creation.
- Prerequisites and Limitations: Outlined the Kubernetes version prerequisites for VAP (1.30+) and MAP (1.32+) and highlighted important notes regarding MAP's partial functionality and its coexistence with existing Volcano webhooks.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by:
To complete the pull request process, please assign william-wang
You can assign the PR to them by writing /assign @william-wang in a comment when ready.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by:
To complete the pull request process, please assign william-wang
You can assign the PR to them by writing /assign @william-wang in a comment when ready.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment