diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-05-17 16:01:19 +0200 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-05-17 16:01:19 +0200 |
commit | e9d292fcc67f3b0fb3b07c97854ce05a0340aa30 (patch) | |
tree | bebe45b567c0bfc0517b9555214552aca99c45e9 | |
parent | 6a2bcb4b2ae8bed4730f3589c2693b17c57b4a75 (diff) | |
download | gitlab-ce-e9d292fcc67f3b0fb3b07c97854ce05a0340aa30.tar.gz |
Copyedit pipelines schedules docs
-rw-r--r-- | doc/ci/img/pipeline_schedules_list.png | bin | 67555 -> 14665 bytes | |||
-rw-r--r-- | doc/ci/img/pipeline_schedules_ownership.png | bin | 0 -> 12043 bytes | |||
-rw-r--r-- | doc/ci/pipeline_schedules.md | 64 |
3 files changed, 41 insertions, 23 deletions
diff --git a/doc/ci/img/pipeline_schedules_list.png b/doc/ci/img/pipeline_schedules_list.png Binary files differindex 9388fac98eb..50d9d184b05 100644 --- a/doc/ci/img/pipeline_schedules_list.png +++ b/doc/ci/img/pipeline_schedules_list.png diff --git a/doc/ci/img/pipeline_schedules_ownership.png b/doc/ci/img/pipeline_schedules_ownership.png Binary files differnew file mode 100644 index 00000000000..31ed83abb4d --- /dev/null +++ b/doc/ci/img/pipeline_schedules_ownership.png diff --git a/doc/ci/pipeline_schedules.md b/doc/ci/pipeline_schedules.md index 73451da6c0c..641876f948f 100644 --- a/doc/ci/pipeline_schedules.md +++ b/doc/ci/pipeline_schedules.md @@ -1,44 +1,62 @@ # Pipeline Schedules -> **Note**: -- This feature was introduced in 9.1 as [Trigger Schedule][ce-105533] -- In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853] +> **Notes**: +- This feature was introduced in 9.1 as [Trigger Schedule][ce-10533]. +- In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853]. +- Cron notation is parsed by [Rufus-Scheduler](https://github.com/jmettraux/rufus-scheduler). Pipeline schedules can be used to run pipelines only once, or for example every month on the 22nd for a certain branch. -## Using Pipeline Schedules +## Using Pipeline schedules + +In order to schedule a pipeline: -In order to schedule pipelines, navigate to your their pages **Pipelines ➔ Schedules** -and click the **New Schedule** button. +1. Navigate to your project's **Pipelines ➔ Schedules** and click the + **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) -After entering the form, hit **Save Schedule** for the changes to have effect. -You can check a next execution date of the scheduled trigger, which is automatically calculated by a server. +>**Attention:** +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. -## Taking ownership +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) -Pipelines are executed as a user, which owns a schedule. This influences what +## 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. -> **Notes**: -- Those pipelines won't be executed precicely. Because schedules are handled by -Sidekiq, which runs according to its interval. For exmaple, if you set a schedule to -create a pipeline every minute (`* * * * *`) and the Sidekiq worker performs 00:00 -and 12:00 o'clock every day (`0 */12 * * *`), only 2 pipelines will be created per day. -To change the Sidekiq worker's frequency, you have to edit the `trigger_schedule_worker_cron` -value in your `gitlab.rb` and restart GitLab. The Sidekiq worker's configuration -on GiLab.com is able to be looked up at [here](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example#L185). -- Cron notation is parsed by [Rufus-Scheduler](https://github.com/jmettraux/rufus-scheduler). -- When the owner of the schedule does not have the ability to create pipelines -anymore, due to e.g. being blocked or removed from the project, the schedule is -deactivated. Another user can take ownership and activate it, so the schedule is -run again. +![Schedules list](img/pipeline_schedules_ownership.png) + +>**Note:** +When the owner of the schedule doesn't have the ability to create pipelines +anymore, due to e.g., being blocked or removed from the project, the schedule +is deactivated. Another user can take ownership and activate it, so the +schedule can be run again. + +## 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 +`trigger_schedule_worker_cron` value in your `gitlab.rb` and restart GitLab. +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 +[settings]: https://about.gitlab.com/gitlab-com/settings/#cron-jobs |