Add Cron VolcanoJob Concept #431

GoingCharlie · 2025-11-19T07:43:38Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines

What kind of change does this PR introduce?

/kind documentation

What this PR does / why we need it:

This PR adds comprehensive documentation for the newly introduced Cron VolcanoJob feature in Volcano v1.13, including both Chinese and English versions.

Changes included:

Add Chinese documentation
Add English documentation
Introduce Cron VolcanoJob definition, purpose and use cases
Explain all key fields (schedule, timeZone, concurrencyPolicy, startingDeadlineSeconds, history limits, etc.)
Provide usage examples with YAML manifests
Include kubectl commands for managing Cron VolcanoJobs

Which issue(s) this PR fixes:

Fixes #429

Special notes for your reviewer:

Documentation follows Volcano Job documentation style
Both Chinese and English versions are provided

volcano-sh-bot · 2025-11-19T07:43:49Z

Welcome @GoingCharlie! It looks like this is your first PR to volcano-sh/website 🎉

gemini-code-assist · 2025-11-19T07:43:52Z

Summary of Changes

Hello @GoingCharlie, I'm Gemini Code Assist¹! 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 introduces detailed documentation for the new Cron VolcanoJob feature within Volcano v1.13. This feature allows users to schedule batch computing tasks, such as AI and big data workloads, to run periodically based on predefined schedules, similar to Kubernetes native CronJobs. The documentation covers the concept, configuration fields, and practical usage scenarios, ensuring users can effectively leverage this new capability.

Highlights

New Feature Documentation: Comprehensive documentation for the recently introduced Cron VolcanoJob feature in Volcano v1.13, enabling scheduled execution of batch computing tasks.
Dual Language Support: The documentation is provided in both English and Chinese versions to cater to a broader audience.
Detailed Explanations and Examples: The documentation includes definitions, purpose, use cases, explanations of key fields (schedule, timeZone, concurrencyPolicy, startingDeadlineSeconds, history limits, suspend, jobTemplate), and practical usage examples with YAML manifests and kubectl commands.

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
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

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 👍 and 👎 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.

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. ↩

gemini-code-assist

Code Review

This pull request adds documentation for the new Cron VolcanoJob feature in both English and Chinese. The documentation is comprehensive, covering the definition, key fields, and usage examples. I've found a few minor issues related to formatting, consistency, and clarity that could improve the documentation. Specifically, there's some inconsistent formatting in YAML examples and some trailing whitespace. More importantly, I've suggested adding a clarification about the resource kind (CronJob) and its short name (cronvcjob) to avoid potential confusion for users. I also noticed that doc/concepts/cron_volcanoJob.md seems to be a duplicate of the Chinese documentation for the website, which could be a maintenance concern.

gemini-code-assist · 2025-11-19T07:45:10Z

content/en/docs/cron_volcanoJob.md

+++
+
+### Introduction
+Cron VolcanoJob, also known as cronvcjob or cronvj, is a custom resource type in Volcano. Users can now periodically create and run Volcano Jobs based on predefined schedules, similar to Kubernetes native CronJobs, enabling scheduled execution of batch computing tasks (such as AI and big data workloads).


To avoid confusion with the native Kubernetes CronJob, it would be helpful to add a note clarifying that this is a Volcano-specific custom resource. For example, you could add:

'Note: While the resource kind is CronJob, it is a custom resource defined by Volcano under the batch.volcano.sh/v1alpha1 API group, distinct from the native Kubernetes CronJob. It can be managed using kubectl with its short names cronvcjob or cronvj.'

gemini-code-assist · 2025-11-19T07:45:10Z

content/en/docs/cron_volcanoJob.md

+Optional. Deadline in seconds for starting the job if it misses its scheduled time.
+
+* suspend
+


This line contains only whitespace. Please remove it for better formatting and readability.

gemini-code-assist · 2025-11-19T07:45:10Z

content/en/docs/cron_volcanoJob.md

+  name: daily-model-training
+spec:
+  schedule: "0 2 * * *"  # Run daily at 2 AM
+  concurrencyPolicy: "Forbid"


For consistency with the first example (line 26), it's better to use an unquoted value for concurrencyPolicy. YAML syntax allows it, and it improves readability and consistency across the document.

Suggested change

concurrencyPolicy: "Forbid"

concurrencyPolicy: Forbid

gemini-code-assist · 2025-11-19T07:45:11Z

content/en/docs/cron_volcanoJob.md

+Clean up temporary data and log files every Sunday evening to free up cluster storage space.
+```shell
+apiVersion: batch.volcano.sh/v1alpha1
+kind: CronJob  


There is trailing whitespace on this line. Please remove it.

Suggested change

kind: CronJob

kind: CronJob

gemini-code-assist · 2025-11-19T07:45:11Z

content/zh/docs/cron_volcanoJob.md

+++
+
+### 定义
+Cron VolcanoJob, 简称cronvcjob，cronvj，是Volcano自定义的资源类型。用户现在可以根据预定义的调度计划定期创建和运行Volcano Job，类似于Kubernetes原生的CronJob，以实现批量计算任务(如AI和大数据)的定期执行。


To avoid confusion with the native Kubernetes CronJob, it would be helpful to add a note clarifying that this is a Volcano-specific custom resource. A translated note would be beneficial for Chinese readers.

gemini-code-assist · 2025-11-19T07:45:11Z