Skip to content

Commit

Permalink
DEVOPS-224 update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
@kalinon
kalinon committed Jun 9, 2021
1 parent 1aacb3b commit 9951f01
Show file tree
Hide file tree
Showing 6 changed files with 338 additions and 23 deletions.
37 changes: 19 additions & 18 deletions ndustrial/cronjob/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,29 @@

### CronJob parameters

| Name | Description | Value |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `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 | `Forbid` |
| `failedJobsHistoryLimit` | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | `1` |
| `successfulJobsHistoryLimit` | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. | `3` |
| `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. | `nil` |
| `activeDeadlineSeconds` | Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer | `nil` |
| `backoffLimit` | Specifies the number of retries before marking this job failed. Defaults to 6 | `6` |
| `completions` | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `nil` |
| `parallelism` | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `nil` |
| `ttlSecondsAfterFinished` | Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. | `nil` |
| Name | Description | Value |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `schedule` | String to set cronjob's schedule | `0 0 * * *` |
| `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 | `Forbid` |
| `failedJobsHistoryLimit` | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | `1` |
| `successfulJobsHistoryLimit` | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. | `3` |
| `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. | `nil` |
| `activeDeadlineSeconds` | Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer | `nil` |
| `backoffLimit` | Specifies the number of retries before marking this job failed. Defaults to 6 | `6` |
| `completions` | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `nil` |
| `parallelism` | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `nil` |
| `ttlSecondsAfterFinished` | Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. | `nil` |


### Pod Image parameters

| Name | Description | Value |
| ------------------- | ------------------------------------------------- | ---------------------------- |
| `image.registry` | CronJob image registry | `quay.io` |
| `image.repository` | CronJob image repository | `ndustrialio/cronjobexample` |
| `image.tag` | CronJob image tag (immutabe tags are recommended) | `latest` |
| `image.pullPolicy` | CronJob image pull policy | `IfNotPresent` |
| `image.pullSecrets` | CronJob image pull secrets | `[]` |
| Name | Description | Value |
| ------------------- | ------------------------------------------------- | -------------- |
| `image.registry` | CronJob image registry | `docker.io` |
| `image.repository` | CronJob image repository | `busybox` |
| `image.tag` | CronJob image tag (immutabe tags are recommended) | `latest` |
| `image.pullPolicy` | CronJob image pull policy | `IfNotPresent` |
| `image.pullSecrets` | CronJob image pull secrets | `[]` |


### Pod parameters
Expand Down
Loading

0 comments on commit 9951f01

Please sign in to comment.