Version information
This version is compatible with:
- Puppet Enterprise >= 2015.3.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'beersy-pe_code_manager_easy_setup', '0.1.3'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
- Description
- Setup - The basics of getting started with pe_code_manager_easy_setup
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module makes it easy to install code manager.
Setup
What pe_code_manager_easy_setup affects OPTIONAL
This module will:
- create the appropriate RBAC users for code manager
- configure the PE Master node group for code manager
- generate the deployment key to be placed into github/gitlab
- generate the webhook URL to placed into github/gitlab
Setup Requirements
This module assumes gem, git, and Puppet Enterprise are already installed.
Usage
Install this module by running these command on the master as root:
puppet module install beersy-pe_code_manager_easy_setup --version 0.1.2
puppet apply -e "class { 'pe_code_manager_easy_setup': r10k_remote_url => 'GIT_REPO_URL', git_management_system => 'GMS'}"
Replace these values before running:
- GIT_REPO_URL: set to git url of control repo (default: git@gitlab:puppet/control-repo.git)
- GMS: set to 'gitlab' or 'github' (default:'gitlab')
Post-Install steps
If successful, this module generates 2 files on the master:
1 /etc/puppetlabs/puppetserver/ssh/id-control_repo.rsa.pub
Paste the contents of file as a deploy key:
Gitlab: http://PATH_TO_CONTROL_REPO/deploy_keys (ex: http://gitlab/puppet/control-repo/deploy_keys)
Github: https://PATH_TO_CONTROL_REPO/settings/keys (ex: https://github.com/puppetlabs/control-repo/settings/keys)
2 /etc/puppetlabs/puppetserver/.puppetlabs/webhook_url.txt
Gitlab instructions:
- Go to:
http://PATH_TO_CONTROL_REPO/hooks
- URL: URL from webhook_url.txt
- Trigger: Enable "Push events"
- SSL verification: Enable "Enable SSL verification"
Github instructions:
- Go to:
https://PATH_TO_CONTROL_REPO/settings/hooks/new
- Payload URL: URL from webhook_url.txt
- Content type: "application/json"
- Which events would you like to trigger this webhook?:"Just the push event."
Limitations
This modules assumes that you are running:
- Puppet Enterprise 2015.3 or higher
- Gitlab 8.5 or higher
- gem, git are already installed
Release Notes/Contributors/Etc. Optional
0.1.3 - Typo fix
0.1.2 - Readme fix
0.1.1 - Code cleanup, added readme and other docs
0.1.0 - Initial Release
Dependencies
- npwalker-pe_code_manager_webhook (2.0.1)
- geoffwilliams-chown_r (0.2.0)
- WhatsARanjit-node_manager (0.3.1)
- puppetlabs-pe_gem (0.1.2)
- puppetlabs-stdlib (>= 4.1.0 < 5.0.0)
- pltraining-rbac (>= 0.0.5 < 0.0.6)
- abrader-gms (>= 1.0.2 < 2.0.0)