Forge Home

gitlabinstall

Dedicated GitLab installation

7,723 downloads

19 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.15.0 (latest)
  • 1.12.2
  • 1.10.0
  • 1.9.6
  • 1.9.5
  • 1.9.4
  • 1.7.3
  • 1.7.2
  • 1.7.1
  • 1.6.0
  • 1.5.1
  • 1.4.0
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.5
  • 1.1.2
  • 1.1.1
  • 1.1.0
  • 1.0.2
  • 1.0.1
released Nov 27th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 9.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'aursu-gitlabinstall', '1.15.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add aursu-gitlabinstall
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install aursu-gitlabinstall --version 1.15.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

aursu/gitlabinstall — version 1.15.0 Nov 27th 2024

gitlabinstall

Table of Contents

  1. Description
  2. Setup - The basics of getting started with gitlabinstall
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

The primary goal of this module is to install GitLab and enable its integration with externally managed Nginx, PostgreSQL, and Docker Registry.

Setup

What gitlabinstall affects

The gitlabinstall Puppet module installs the gitlab-ce Omnibus package from packages.gitlab.com/gitlab/gitlab-ce. The exact package version should be specified.

Additionally, it can manage the setup of Nginx (non-bundled) and PostgreSQL (also non-bundled).

SSL certificates management is also included.

Setup Requirements

It requires to use custom fork of Puppet Nginx module located on GitHub.

For .fixtures.yml

nginx:
  repo: https://github.com/aursu/puppet-nginx.git
  ref: tags/v5.0.1-1

and for Puppetfile:

mod 'nginx',
  :git => 'https://github.com/aursu/puppet-nginx.git',
  :tag => 'v5.0.1-1'

Also requires non-published on Puppet Forge module aursu::lsys which is set of different basic profiles

Puppetfile setup:

mod 'lsys',
  :git => 'https://github.com/aursu/puppet-lsys.git',
  :tag => 'v0.21.0'

Beginning with gitlabinstall

Main class for GitLab installation is gitlabinstall::gitlab:

class { 'gitlabinstall':
  external_url          => 'https://gitlab.domain.tld',
}
class { 'gitlabinstall::gitlab':
  database_password     => 'secret',
  gitlab_package_ensure => '13.3.5-ce.0.el7',
}

Usage

External container registry integration

Use it with registry installed on separate host and on the same host as PuppetDB:

  class { 'gitlabinstall':
    external_url          => 'https://gitlab.domain.tld',
  }

  class { 'gitlabinstall::gitlab':
    cert_identity             => '*.domain.tld',
    # DevCI has PuppetDB which listen on 8080, PuppetDB could be used
    # externally but not GitLab Unicorn
    gitlab_rails_port         => 8008,
    monitoring                => false,
    external_registry_service => true,
    registry_host             => 'registry.domain.tld',
    registry_api_url          => 'http://registry.domain.tld:5000',
    gitlab_package_ensure     => '12.10.14-ce.0.el7',
  }

Use it with registry on the same host:

  class { 'gitlabinstall':
    external_url          => 'https://gitlab.domain.tld',
  }

  class { 'gitlabinstall::gitlab':
    cert_identity             => '*.domain.tld',
    external_registry_service => true,
    registry_host             => 'registry.domain.tld',
  }

LDAP settings

Basic setup:

  class { 'gitlabinstall':
    external_url          => 'https://gitlab.domain.tld',
    ldap_enabled          => true,
    ldap_host             => 'ldap.mydomain.com',
    ldap_password         => 'secret',
    ldap_base             => 'ou=people,dc=gitlab,dc=example',
  }

  class { 'gitlabinstall::gitlab':
    cert_identity             => '*.domain.tld',
    external_registry_service => true,
    registry_host             => 'registry.domain.tld',
  }

With more LDAP settings:

  class { 'gitlabinstall':
    external_url          => 'https://gitlab.domain.tld',
  }

  class { 'gitlabinstall::ldap':
    host                  => 'ldap.mydomain.com',
    password              => 'secret',
    base                  => 'ou=people,dc=gitlab,dc=example',

    bind_dn               => 'CN=Gitlab,OU=Users,DC=domain,DC=com',
  }

  class { 'gitlabinstall::gitlab':
    cert_identity             => '*.domain.tld',
    external_registry_service => true,
    registry_host             => 'registry.domain.tld',
    ldap_enabled              => true,
  }

Reference

See REFERENCE.md

Limitations

Development

Release Notes/Contributors/Etc. Optional