schedules.md 3.92 KB
Newer Older
Evan Read's avatar
Evan Read committed
1
# Pipeline schedules
2 3

> **Notes**:
4 5
> - This feature was introduced in 9.1 as [Trigger Schedule][ce-10533].
> - In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853].
6
> - Cron notation is parsed by [Fugit](https://github.com/floraison/fugit).
7

8
Pipeline schedules can be used to run a pipeline at specific intervals, for example every
9 10 11 12 13 14
month on the 22nd for a certain branch.

## Using Pipeline schedules

In order to schedule a pipeline:

15
1. Navigate to your project's **CI / CD ➔ Schedules** and click the
16 17 18 19 20 21
   **New Schedule** button.
1. Fill in the form
1. Hit **Save pipeline schedule** for the changes to take effect.

![New Schedule Form](img/pipeline_schedules_new_form.png)

22
> **Attention:**
23 24 25 26 27 28 29 30 31 32 33
The pipelines won't be executed precisely, because schedules are handled by
Sidekiq, which runs according to its interval.
See [advanced admin configuration](#advanced-admin-configuration) for more
information.

In the **Schedules** index page you can see a list of the pipelines that are
scheduled to run. The next run is automatically calculated by the server GitLab
is installed on.

![Schedules list](img/pipeline_schedules_list.png)

34 35 36 37 38 39 40 41 42 43 44 45 46 47
### Running a scheduled pipeline manually

> [Introduced][ce-15700] in GitLab 10.4.

To trigger a pipeline schedule manually, click the "Play" button:

![Play Pipeline Schedule](img/pipeline_schedule_play.png)

This will schedule a background job to run the pipeline schedule. A flash
message will provide a link to the CI/CD Pipeline index page.

To help avoid abuse, users are rate limited to triggering a pipeline once per
minute.

48 49 50 51 52 53 54 55 56
### Making use of scheduled pipeline variables

> [Introduced][ce-12328] in GitLab 9.4.

You can pass any number of arbitrary variables and they will be available in
GitLab CI so that they can be used in your `.gitlab-ci.yml` file.

![Scheduled pipeline variables](img/pipeline_schedule_variables.png)

57 58 59 60
## Using only and except

To configure that a job can be executed only when the pipeline has been
scheduled (or the opposite), you can use
61
[only and except](../../../ci/yaml/README.md#only-and-except-simplified) configuration keywords.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

```
job:on-schedule:
  only:
    - schedules
  script:
    - make world

job:
  except:
    - schedules
  script:
    - make build
```

77 78 79 80 81 82 83 84 85
## Taking ownership

Pipelines are executed as a user, who owns a schedule. This influences what
projects and other resources the pipeline has access to. If a user does not own
a pipeline, you can take ownership by clicking the **Take ownership** button.
The next time a pipeline is scheduled, your credentials will be used.

![Schedules list](img/pipeline_schedules_ownership.png)

86 87 88 89 90 91
NOTE: **Note:**
If the owner of a pipeline schedule doesn't have the ability to create pipelines
on the target branch, the schedule will stop creating new pipelines. This can
happen if, for example, the owner is blocked or removed from the project, or
the target branch or tag is protected. In this case, someone with sufficient
privileges must take ownership of the schedule.
92 93 94 95 96 97 98 99

## Advanced admin configuration

The pipelines won't be executed precisely, because schedules are handled by
Sidekiq, which runs according to its interval. For example, if you set a
schedule to create a pipeline every minute (`* * * * *`) and the Sidekiq worker
runs on 00:00 and 12:00 every day (`0 */12 * * *`), only 2 pipelines will be
created per day. To change the Sidekiq worker's frequency, you have to edit the
100
`pipeline_schedule_worker_cron` value in your `gitlab.rb` and restart GitLab.
101 102 103 104 105
For GitLab.com, you can check the [dedicated settings page][settings]. If you
don't have admin access to the server, ask your administrator.

[ce-10533]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10533
[ce-10853]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10853
106
[ce-12328]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12328
107
[ce-15700]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15700
108
[settings]: https://about.gitlab.com/gitlab-com/settings/#cron-jobs