diff options
| author | Harish Ramachandran <harish@gitlab.com> | 2019-07-26 11:36:48 -0400 |
|---|---|---|
| committer | Harish Ramachandran <harish@gitlab.com> | 2019-07-26 11:36:48 -0400 |
| commit | 65d8e39dc49a25bc25fae71e19b51edd53fb091e (patch) | |
| tree | f44dd4454a379a39da28fadca35ef99f7aa6bc12 | |
| parent | fc3d0595c48095450bc6495ab643e98c5661888f (diff) | |
| download | gitlab-ce-harishsr-ldap-groupsync-rake-task-docs.tar.gz | |
Document how to use the GroupSync rake taskharishsr-ldap-groupsync-rake-task-docs
| -rw-r--r-- | doc/administration/raketasks/ldap.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/administration/raketasks/ldap.md b/doc/administration/raketasks/ldap.md index 91fc0133d56..e880d76e756 100644 --- a/doc/administration/raketasks/ldap.md +++ b/doc/administration/raketasks/ldap.md @@ -28,6 +28,31 @@ limit by passing a number to the check task: rake gitlab:ldap:check[50] ``` +## Run a Group Sync + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. + +The following task will run a [group sync](../auth/ldap-ee.md#group-sync) immediately. This is valuable +when you'd like to update all configured group memberships against LDAP without +waiting for the next scheduled group sync to be run. + +NOTE: **NOTE:** +If you'd like to change the frequency at which a group sync is performed, +[adjust the cron schedule](../auth/ldap-ee.md#adjusting-ldap-group-sync-schedule) +instead. + +**Omnibus Installation** + +``` +sudo gitlab-rake gitlab:ldap:group_sync +``` + +**Source Installation** + +```bash +bundle exec rake gitlab:ldap:group_sync +``` + ## Rename a provider If you change the LDAP server ID in `gitlab.yml` or `gitlab.rb` you will need |