Forge Home

atlantis

Install and configure Atlantis

5,174 downloads

4,309 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

  • 0.2.0 (latest)
  • 0.1.0
released May 30th 2019
This version is compatible with:
  • Puppet Enterprise 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 < 7.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'walkamongus-atlantis', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add walkamongus-atlantis
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install walkamongus-atlantis --version 0.2.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

walkamongus/atlantis — version 0.2.0 May 30th 2019

atlantis

Table of Contents

  1. Description
  2. Setup - The basics of getting started with atlantis
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.

Description

This module installs and configures Atlantis (https://www.runatlantis.io). Atlantis is a central automation server for Terraform focused on source code pull requests.

Setup

Setup Requirements

This module installs and configures Atlantis, and expects that any Atlantis prerequisites have already been met. As an example, this module will not download Terraform and place it in the $PATH. A good list of these prerequisites may be found at https://www.runatlantis.io/guide/testing-locally.html

Beginning with atlantis

You should have installed Terraform and made it available in the Atlantis user's $PATH as well as set up any webhook secrets, webhooks, and access tokens required. Atlantis configuration parameters are set as key/value pairs in the module's config parameter.

Any command line options may be set as keys in the config parameter (minus the leading --). For a full list of the available parameters, run atlantis server --help.

Usage

Once prerequisites are met, the relevant config data may be passed in the module's config hash.

Example github config:

class { '::atlantis':
  config       => {
    'gh-user'           => 'myuser',
    'gh-token'          => 'token',
    'gh-webhook-secret' => 's3cr3t',
    'repo-whitelist'    => 'github.com/runatlantis/atlantis',
    'require-approval'  => true,
  },
}

Limitations

Supported Puppet versions and OS versions are listed in metadata.json.