Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 9.88 KB

README.md

File metadata and controls

169 lines (113 loc) · 9.88 KB
Raw

PSICK

Puppet Systems Infrastructure Construction Kit

Build Status Codacy Badge

A Puppet control-repo [generator] on steroids, featuring:

  • A modern, opinionated, general purpose, full featured, reusable control-repo
  • Multiple ways to test local Puppet code (on Docker, Vagrant or directly remote hosts)
  • Gitlab CI pipeline to control Puppet code deployment
  • Usable in any Puppet setup, based on Puppet OSS, PE, Foreman...
  • Toolset to create and maintain a new control-repo based on PSICK (WIP)

This control repo, among the other third party modules, uses the companion psick module which provides:

  • A robust interface for Hiera driven nodes classification
  • Ready to use profiles for common system baselines
  • Standardised tp profiles to manage applications
  • Support and integration with common third party modules
  • Automatic firewalling and monitoring management

Sample Hiera data for the PSICK control-repo is available via the psick-hieradata module.

PSICK is a Puppet control-repo itself, you can use this repository directly in a Puppet environment, and basically have a full PSICK setup, or run the psick command to generate a new Puppet control-repo based on the components you need.

For more details check the automatically generated Control repo documentation.

See PSICK in action

You can see a sample PSICK based setup by accessing to Psick Lab servers.

They are configured using this same repository. All the lab servers are Vagrant virtual machines running on a single physical server, where an NGINX proxies requests to the internal VMs.

You can reproduce the same by running vagrant up under vagrant/environments/lab (some integrations between Puppet Enterprise and GitLab have been done manually):

Note that this is a non High Available testing and development infrastructure, some of these services might not always be available (an NGINX bad gateway error implies that the backend server is down):

  • Puppet Enterprise Login: guest:puppet. Is the Puppet Master of the lab environment nodes. There it runs directly our development code.
  • GitLab. A GitLab instance, integrated with Code Mabaner to automatically deploy code PE and run our CI pipelines
  • Sensu. Login: sensu:sensu. An Uchiwa installation as frontend for the Sensu installation.
  • Icinga. Login: guest:guest. An Icinga installation, with Icinga Web 2 interface.
  • Graphite. Graphite and grafana frontends (not active by default).
  • ManageIQ. A ManageIQ installation (not active by default).
  • RabbitMQ. RabbitMQ installation (not active by default).
  • Rundeck. Rundeck installation (not active by default).
  • Foreman. Foreman installation (not active by default).
  • Jenkins. Jenkins instance using PSICK Jenkinsfile.

Note: While the setup of the whole PSICK lab infrastructure is automated and may be restored from scratch, that's not something we would like to do frequently. We give you credentials and access to these services, please behave.

Setup of a new control-repo

Download this repository:

git clone https://github.com/example42/psick
cd psick
./psick create

The psick command currently it just allows you to create a new control-repo and populate it either with a bare minimal skeleton, or with the full PSICK contents. In the future it will provide the possibility to pick single components (integrations, profiles...), see how they diff compared to your own control-repo and eventually update them on your local control-repo.

Once you have created your own control-repo, you can start to work with it. If you have chosen to copy the full PSICK contents in your control repo, you can run the following commands from your own control-repo directory, otherwise run them from the PSICK directory.

This applies to all the scripts and paths referenced in the docs, just be aware that some of the scripts in bin/ and other integrations might not work correctly in a not full PSICK setup.

Setup of a Puppet environment

This control-repo requires Puppet 4 or later, if it's not already installed, you can install it with this cross OS Puppet 4 install script (it uses the official Puppet repos):

sudo bin/puppet_install.sh # Only if you don't have Puppet 4 installed

Before starting to use it, you have to populate the modules/ directory of the control-repo.

You need to do this both on your development workstation, and on your Puppet server (after having placed your control-repo into the /etc/puppetlabs/code/environments/ directory).

To install the prerequequisite gems (hiera-eyaml, deep_merge, r10k) and populate the external modules directory via r10k, you can run:

bin/puppet_setup.sh        # Only if you don't have the prerequisites gems

If you have already r10k and the prerequisite gems, just run:

r10k puppetfile install -v

If you also want to install the recommended (Fabric, Vagrant, Docker) tools that can be used with the repo, run:

bin/setup.sh               # Only if you want to install Fabric, Vagrant and Docker

The script, installs and runs r10k and then uses Puppet to install the other software.

Notes:

  • You will always be asked to confirm or skip each step.

  • The script will use sudo for the operations that need root privileges.

  • Scripts are mostly tested on Mac and Linux environments. On Mac some packages installations don't work.

  • You can safely interrupt the scripts with CTRL+C at any time

  • For unattended setups (typically in CI pipelines) you can skip confirmation requests passing the argument auto:

      bin/puppet_setup.sh auto
  bin/setup.sh auto

Directory structure

PSICK has the common set of files and directories of a Puppet control-repo:

  • environment.conf - The Puppet environment configuration file
  • manifests/ - Directory with the main manifests. Here we have just site.pp
  • Puppetfile - File that defines the external modules to add via r10k
  • modules/ - Directory where modules defined in Puppetfile are placed (it's .gitignored)
  • hiera.yaml - Hiera 5 environment configuration file. An equivalent Hiera 3 file is hiera3.yaml (was linked to /etc/puppetlabs/puppet/hiera.yaml)
  • hieradata/ - This directory (or one called data) is usually used to store Hiera data, when is decided to keep Hiera data inside the control-repo. Since version 0.9.3 PSICK's default datadir is loaded from a module in modules/hieradata/data.

Some extra directories are added in PSICK for integrations and tools:

  • bin/ - Directory containing tools and scripts for various Puppet related operations
  • docs/ - Directory with extra docs
  • site/ - An additional modules directory, with local profiles and tools.
  • docker/ - Files used for building Docker images for multiple OS
  • vagrant/ - Various Vagrant environments where is possible to test local Puppet code
  • fabfile/ - Fabric integration and scripts
  • .gitlab-ci.yaml - (Sample) GitLab Continuous Integration pipeline for code testing and deployment

Compatibility

PSICK uses cutting edge Puppet technology and all its components are expected to work on these versions:

  • Puppet OSS 4.9 or later.
  • Puppet Enterprise 2017.1.0 or later

In particular the psick separated module uses data in modules and requires a relatively modern Puppet.

For most of the other parts of the control repo you can use, compatibility is enlarged to:

  • Puppet OSS >= 4.4 or later
  • Puppet Enterprise >= 2016.1.1 or later

Documentation

PSICK is full of more or less hidden stuff, which ease a lot Puppet code development, testing and deployment. Here is where you can find more info:

General Puppet documentation:

About this control-repo:

  • Control-repo structure - A description of the control-repo structure and most important paths
  • Control-repo logic - An overview of the design choices and the logic of this control repo.
  • Prerequisites - A more detailed view of the prerequisites needed to fully use the control-repo
  • Noop Mode - An overview on how to manage noop and no-noop with PSICK
  • Vagrant Integration - How to use Vagrant to test the control-repo during development
  • Docker Integration - How to use Docker to test Puppet code and to build images based on the existing Puppet code
  • Fabric - A review of Puppet tasks available with Fabric

Managing changes:

  • Git tasks - An overview on how to use Git
  • Change Process - A step by step guide on how to manage changes in Puppet code