Skip to content

Commit ad9fb9e

Browse files
committed
Rename Scheduled Job to Cron Job
1 parent 2b48f59 commit ad9fb9e

File tree

2 files changed

+17
-39
lines changed

2 files changed

+17
-39
lines changed

_topic_map.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -681,8 +681,8 @@ Topics:
681681
File: environment_variables
682682
- Name: Jobs
683683
File: jobs
684-
- Name: Scheduled Jobs
685-
File: scheduled_jobs
684+
- Name: Cron Jobs
685+
File: cron_jobs
686686
- Name: Revision History
687687
File: revhistory_dev_guide
688688
Distros: openshift-enterprise,openshift-dedicated
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[[dev-guide-scheduled-jobs]]
2-
= Scheduled Jobs
1+
[[dev-guide-cron-jobs]]
2+
= Cron Jobs
33
{product-author}
44
{product-version}
55
:data-uri:
@@ -13,53 +13,53 @@ toc::[]
1313

1414
== Overview
1515

16-
A _scheduled job_ builds on a regular
16+
A _cron job_ builds on a regular
1717
xref:../dev_guide/jobs.adoc#dev-guide-jobs[job] by allowing you to specifically
18-
schedule how the job should be run. Scheduled jobs are part of the
19-
link:http://kubernetes.io/docs/user-guide/scheduled-jobs[Kubernetes] API, which
18+
schedule how the job should be run. Cron jobs are part of the
19+
link:http://kubernetes.io/docs/user-guide/cron-jobs[Kubernetes] API, which
2020
can be managed with `oc` commands like other
2121
xref:../cli_reference/basic_cli_operations.adoc#object-types[object types].
2222

2323
ifdef::openshift-enterprise[]
2424
[NOTE]
2525
====
26-
As of {product-title} 3.3.1, Scheduled Jobs is a feature in Technology Preview.
26+
As of {product-title} 3.3.1, Cron Jobs is a feature in Technology Preview.
2727
====
2828
endif::[]
2929

30-
[[creating-a-scheduledjob]]
31-
== Creating a Scheduled Job
30+
[[creating-a-cronjob]]
31+
== Creating a Cron Job
3232

33-
A scheduled job configuration consists of the following key parts:
33+
A cron job configuration consists of the following key parts:
3434

3535
* A schedule specified in link:https://en.wikipedia.org/wiki/Cron[cron format].
3636
* A job template used when creating the next job.
3737
* An optional deadline (in seconds) for starting the job if it misses its
3838
scheduled time for any reason. Missed jobs executions will be counted as failed
3939
ones. If not specified, there is no deadline.
4040
* `*ConcurrencyPolicy*`: An optional concurrency policy, specifying how to treat
41-
concurrent jobs within a scheduled job. Only one of the following concurrent
41+
concurrent jobs within a cron job. Only one of the following concurrent
4242
policies may be specified. If not specified, this defaults to allowing
4343
concurrent executions.
44-
** `Allow` allows Scheduled Jobs to run concurrently.
44+
** `Allow` allows Cron Jobs to run concurrently.
4545
** `Forbid` forbids concurrent runs, skipping the next run if the previous has not
4646
finished yet.
4747
** `Replace` cancels the currently running job and replaces
4848
it with a new one.
49-
* An optional flag allowing the suspension of a scheduled job. If set to `true`,
49+
* An optional flag allowing the suspension of a cron job. If set to `true`,
5050
all subsequent executions will be suspended.
5151

52-
The following is an example of a `*ScheduledJob*` resource:
52+
The following is an example of a `*CronJob*` resource:
5353

5454
====
5555
[source,yaml]
5656
----
5757
apiVersion: batch/v2alpha1
58-
kind: ScheduledJob
58+
kind: CronJob
5959
metadata:
6060
name: pi
6161
spec:
62-
schedule: */1 * * * ? <1>
62+
schedule: "*/1 * * * *" <1>
6363
jobTemplate: <2>
6464
spec:
6565
template:
@@ -74,25 +74,3 @@ spec:
7474
1. Schedule for the job. In this example, a job will run every minute.
7575
2. Job template. This is similar to the xref:../dev_guide/jobs.adoc#creating-a-job[job example].
7676
====
77-
78-
ifdef::openshift-enterprise[]
79-
[[scheduledjob-known-issues]]
80-
== Known Issues
81-
82-
[[scheduledjob-known-issues-unable-to-edit]]
83-
=== Unable to Edit a Scheduled Job
84-
85-
There is a link:https://bugzilla.redhat.com/show_bug.cgi?id=1378368[known issue]
86-
when invoking `oc edit scheduledjob` due to an error that was already fixed in
87-
the latest version. However, due to significant code changes, this was not
88-
backported.
89-
90-
One possible solution is to use `oc patch` command instead of `oc edit`.
91-
92-
[[scheduledjob-known-issues-change-concurrency]]
93-
=== Unable to Change Concurrency Policy
94-
95-
There is a link:https://bugzilla.redhat.com/show_bug.cgi?id=1386463[known issue]
96-
when changing concurrency policy where no new jobs are created after that
97-
operation is run. The issue is still under investigation in the latest version.
98-
endif::[]

0 commit comments

Comments
 (0)