Skip to content

Update doc: Add an example of 'LDAP authentication' #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update doc: Add an example of 'LDAP authentication' #241

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d4c9f4
Update doc: Add an example of 'LDAP authentication'
Mar 3, 2016
2074465
Update README.md
abraham1901 May 25, 2016
9876f37
Merge pull request #1 from abraham1901/patch-1
mtulio Jul 20, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 55 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
2. [Module description](#module-description)
3. [Parameters](#parameters)
4. [Usage](#usage)
* [Basic usage](#basic-usage)
* [With LDAP](#with-ldap)
* [example class gitlab](#example-class-gitlab)
* [example class gitlab::ci](#example-class-gitlab-ci)
* [example class gitlab::runner](#example-class-gitlab-runner)
* [A complete example](#a-complete-example)
* [A complete example with LDAP authentication](#a-complete-usage-with-ldap-authentication)
5. [Limitation](#limitation)
6. [Development](#development)

Expand Down Expand Up @@ -52,7 +55,7 @@ See [manifest/init.pp](https://github.com/sbadia/puppet-gitlab/blob/master/manif

_Note:_ Assume that a database server is already installed on your server/infrastructure (see: [vagrant-gitlab](https://github.com/sbadia/vagrant-gitlab/blob/master/examples/gitlab.pp)).

## class gitlab
## example: class gitlab

```puppet
class {
Expand All @@ -68,7 +71,7 @@ class {
}
```

## class gitlab::ci
## example: class gitlab::ci

```puppet
class { 'gitlab::ci':
Expand All @@ -83,7 +86,7 @@ class { 'gitlab::ci':
}
```

## class gitlab::ci::runner
## example: class gitlab::ci::runner

```puppet
# The registration token can be found at: http://ci.example.com/admin/runners, accessible through Header > Runners.
Expand All @@ -92,7 +95,7 @@ class { 'gitlab::ci::runner':
registration_token => 'replaceme',
}
```
## A Complete example
## A complete example

```puppet
include redis
Expand Down Expand Up @@ -121,6 +124,52 @@ class {'gitlab':
}
```

## A complete example with LDAP authentication

```puppet
include redis
include nginx
include mysql::server
include git
include nodejs
include logrotate

mysql::db {'gitlab':
user => 'user',
password => 'password',
}

class { 'gitlab':
git_user => 'git',
git_home => '/home/gitlab',
git_email => '[email protected]',
git_comment => 'GitLab',
gitlab_sources => 'https://github.com/gitlabhq/gitlabhq.git',
gitlab_domain => 'gitlab.localdomain.local',
gitlab_http_timeout => '300',
gitlab_dbtype => 'mysql',
gitlab_backup => true,
gitlab_dbname => 'gitlab',
gitlab_dbuser => 'user',
gitlab_dbpwd => 'password',
ldap_enabled => true,
ldap_host => 'ads.localdomain.local',
ldap_base => 'DC=localdomain,DC=local',
ldap_uid => 'sAMAccountName',
ldap_user_filter => '(&(objectClass=*)(memberOf=CN=ACCESS_GIT,OU=groups,DC=localdomain,DC=local))',
ldap_port => '389',
ldap_method => 'plain',
ldap_bind_dn => '[email protected]',
ldap_bind_password => 'change_me-GIT_ADMIN_password',
ldap_active_directory => true,
ldap_block_auto_created_users => false,
ldap_sync_time => '1800',
ldap_group_base => 'CN=ACCESS_GIT,OU=groups,DC=localdomain,DC=local',
ldap_sync_ssh_keys => false,
ldap_admin_group => 'CN=ADMIN_GIT,OU=groups,DC=localdomain,DC=local',
}
```

# Limitations

This module has been built on and tested against Puppet 2.7 and higher.
Expand Down