de08460ef6
Without this patch the control repository does not contain any scripts to execute CI jobs for Puppet code deployment. This patch addresses the problem by adding a Gitlab CI job configuration with three jobs defined across two stages. The test stage executes first with a Syntax and a Lint job executing in parallel. If an environment branch has been pushed, one matching `developemnt`, `testing`, `production` or starting with the prefix `playground`, the deploy stage is executed. The deploy stage requires a Gitlab secret environment variable, PUPPET_TOKEN. This environment variable is the puppet access token configured with Code Manager. The test stage runs the following syntax checks: * yaml files (*.yml, *.yaml) * json files (*.json) * bash scripts (*.sh) * ruby scripts (*.rb) * puppet manifests (*.pp) * erb files (*.erb) The behavior of the checks are to check only files modified relative to a base branch, defaulting to `production`. This avoids running syntax checks against files which have not been modified by the merge request. The check uses `git diff --name-status` to identify changed files across multiple commits in a topic branch. The lint checks rely on bundler and the Gemfile to install numerous lint checks. Gem libraries are installed in a per-job location in $HOME. This is an intentional compromise between installing into a system GEM_PATH element, which would create library conflicts with other jobs, and the job workspace, which would cause gem libraries to be installed from the network on each job invocation. |
||
|---|---|---|
| hieradata | ||
| manifests | ||
| scripts | ||
| site | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| environment.conf | ||
| Gemfile | ||
| LICENSE | ||
| Puppetfile | ||
| README.md | ||
Table of Contents
Created by gh-md-toc
Where Did All The Previous Code Go?
Initially, the control-repo project began as a 'starter' template for anyone who wanted to get started with r10k. As time passed, and Code Manager was integrated into Puppet Enterprise, the scope of this project grew to include opinionated Puppet profiles to set up many Puppet Enterprise components. As the code increased, so did the complexity of the control-repo project. To reduce that complexity, as well as continuing to meet the needs of individuals who would like a more minimal template, this repository was stripped of anything other than the bare minimum files necessary to get started with a functioning control-repo.
All of the code that was previously in this repository still exists in separate repositories under the Puppet Ramp Up Program namespace within Github and can be re-connected to an existing control-repo if that is required by adding the modules to the Puppetfile. Alternatively, if that previously opinionated control-repo is desired, it still exists on Github under the Puppet Ramp Up Program namespace. This control-repo project will remain a template for anyone who would like a minimal 'starter' template.
What You Get From This control-repo
This repository is a template control-repo that can be used with r10k or Puppet Enterprise Code Manager.
The major points are:
- An environment.conf that correctly implements:
- A site directory for roles, profiles, and any custom modules for your organization.
- A config_version script.
- Provided config_version scripts to output the commit of code that your agent just applied.
- Basic example of roles/profiles code.
- Example hieradata directory with pre-created common.yaml and nodes directory.
- These match the default hierarchy that ships with PE.
Copy This Repo Into Your Own Git Server
GitLab
- Install GitLab.
-
After GitLab is installed you may sign if with the
rootuser and password5iveL!fe. -
Make a user for yourself.
-
Make an SSH key to link with your user. You’ll want to do this on the machine you intend to edit code from (most likely not your Puppet master, but your local workstation or laptop).
- Create a group called
puppet(this is case sensitive).
-
Add your user to the
puppetgroup as well. -
Create a project called
control-repo, and set the Namespace to be thepuppetgroup. -
Clone this control repository to your laptop/workstation:
git clone <repository url>cd control-repo
- Remove this repository as the origin remote:
git remote remove origin
- Add your internal repository as the origin remote:
git remote add origin <url of your gitlab repository>
- Push the production branch of the repository from your machine up to your git server
git push origin production
Stash
Coming soon!
GitHub
- Prepare your local git client to authenticate with GitHub.com or a local GitHub Enterprise instance.
- https://help.github.com/articles/generating-ssh-keys/
- https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/
- Create a repository called
control-repoin your user account or organization. Ensure that "Initialize this repository with a README" is not selected.
-
Make a note of your repository URL (HTTPS or SSH, depending on your security configuration).
-
Clone this control repository to your laptop/workstation:
git clone <repository url>cd control-repo
- Remove this repository as the origin remote:
git remote remove origin
- Add your internal repository as the origin remote:
git remote add origin <url of your github repository>
- Push the production branch of the repository from your machine up to your git server
git push origin production