Merge pull request #54920 from tengqm/improve-cronjob-doc

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https:/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Improve cronjob concurrency policy doc

**What this PR does / why we need it**:
The CronJob API documentation (https://kubernetes.io/docs/api-reference/v1.8/#cronjobspec-v1beta1-batch) did not clearly state what can be used as `concurrencyPolicy`. Instead, it only says that the default value is "Raw".

**Which issue(s) this PR fixes**:

**Special notes for your reviewer**:
This patch is not changing any code logic but it involves generated "code".

**Release note**:
```release-note
NONE
```

Kubernetes-commit: 84f2bf3a68d3ec0c7b1c06c9e3fde7f5d7aafa28

batch/v1beta1/types.go

@@ -100,7 +100,10 @@ type CronJobSpec struct {
  StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`
 
  // Specifies how to treat concurrent executions of a Job.
- // Defaults to Allow.
+ // Valid values are:
+ // - "Allow" (default): allows CronJobs to run concurrently;
+ // - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
+ // - "Replace": cancels currently running job and replaces it with a new one
  // +optional
  ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`
 

batch/v1beta1/types_swagger_doc_generated.go

@@ -52,7 +52,7 @@ var map_CronJobSpec = map[string]string{
  "": "CronJobSpec describes how the job execution will look like and when it will actually run.",
  "schedule": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
  "startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.",
- "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
+ "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Valid values are: - \"Allow\" (default): allows CronJobs to run concurrently; - \"Forbid\": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - \"Replace\": cancels currently running job and replaces it with a new one",
  "suspend": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
  "jobTemplate": "Specifies the job that will be created when executing a CronJob.",
  "successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.",

batch/v2alpha1/types.go

@@ -100,7 +100,10 @@ type CronJobSpec struct {
  StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`
 
  // Specifies how to treat concurrent executions of a Job.
- // Defaults to Allow.
+ // Valid values are:
+ // - "Allow" (default): allows CronJobs to run concurrently;
+ // - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
+ // - "Replace": cancels currently running job and replaces it with a new one
  // +optional
  ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`
 

batch/v2alpha1/types_swagger_doc_generated.go

@@ -52,7 +52,7 @@ var map_CronJobSpec = map[string]string{
  "": "CronJobSpec describes how the job execution will look like and when it will actually run.",
  "schedule": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
  "startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.",
- "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
+ "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Valid values are: - \"Allow\" (default): allows CronJobs to run concurrently; - \"Forbid\": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - \"Replace\": cancels currently running job and replaces it with a new one",
  "suspend": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
  "jobTemplate": "Specifies the job that will be created when executing a CronJob.",
  "successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.",