Commit d721f8df authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Add steps to LDAP sync schedule docs

parent 25c7507f
......@@ -8,7 +8,7 @@ membership syncing.
## GitLab EE
The information on this page is relevent for both GitLab CE and EE. For more
The information on this page is relevant for both GitLab CE and EE. For more
details about EE-specific LDAP features, see [LDAP EE Documentation](ldap-ee.md).
[//]: # (Do *NOT* modify this file in EE documentation. All changes in this)
......@@ -287,50 +287,71 @@ LDAP email address, and then sign into GitLab via their LDAP credentials.
## Adjusting LDAP user and group sync schedules
You can manually configure LDAP user and group sync times by setting the following configuration values. _These are cron formatted values_. You can use a crontab generator to create these values, for example http://www.crontabgenerator.com/.
You can manually configure LDAP user and group sync times by setting the
following configuration values.
>**Note:**
These are cron formatted values. You can use a crontab generator to create
these values, for example http://www.crontabgenerator.com/.
### Adjusting LDAP user sync schedule
By default, GitLab will run a worker once per day at 01:30 a.m. server time to check and update GitLab users against LDAP.
By default, GitLab will run a worker once per day at 01:30 a.m. server time to
check and update GitLab users against LDAP.
**Omnibus installations**
```ruby
gitlab_rails['ldap_sync_worker_cron'] = "* */12 * * *"
```
[Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
1. Edit `/etc/gitlab/gitlab.rb`:
```ruby
gitlab_rails['ldap_sync_worker_cron'] = "* */12 * * *"
```
1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
**Source installations**
```yaml
cron_jobs
ldap_sync_worker_cron:
"* */12 * * *"
```
[Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.
1. Edit `config/gitlab.yaml`:
```yaml
cron_jobs
ldap_sync_worker_cron:
"* */12 * * *"
```
1. [Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.
### Adjusting LDAP group sync schedule
By default, GitLab will run a group sync process every hour, on the hour.
>**Note**: It's recommended not to run group sync at too short intervals as this could lead to multiple syncs running concurrently. This is primarily a concern for installations with a large number of LDAP users. Please review the [LDAP group sync benchmark metrics](../auth/ldap-ee.md#benchmarks) to see how your installation compares before proceeding.
>**Note**: It's recommended not to run group sync at too short intervals as this
could lead to multiple syncs running concurrently. This is primarily a concern
for installations with a large number of LDAP users. Please review the
[LDAP group sync benchmark metrics](../auth/ldap-ee.md#benchmarks) to see how
your installation compares before proceeding.
**Omnibus installations**
```ruby
gitlab_rails['ldap_group_sync_worker_cron'] = "*/30 * * * *"
```
[Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
1. Edit `/etc/gitlab/gitlab.rb`:
```ruby
gitlab_rails['ldap_group_sync_worker_cron'] = "*/30 * * * *"
```
1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
**Source installations**
```yaml
cron_jobs
ldap_group_sync_worker_cron:
"*/30 * * * *"
```
1. Edit `config/gitlab.yaml`:
```yaml
cron_jobs
ldap_group_sync_worker_cron:
"*/30 * * * *"
```
[Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.
1. [Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.
## Limitations
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment