Forge Home

twlight

Puppet TWLight management module.

26,051 downloads

4,684 latest version

3.1 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.5.13 (latest)
  • 0.5.12
  • 0.5.11
  • 0.5.10
  • 0.5.9
  • 0.5.8
  • 0.5.7
  • 0.5.6
  • 0.5.4
  • 0.5.3
  • 0.5.2
  • 0.5.1
  • 0.5.0
  • 0.4.1
  • 0.4.0
  • 0.3.2
  • 0.3.1
  • 0.2.13
  • 0.2.12
  • 0.2.11
  • 0.2.10
  • 0.2.9
  • 0.2.8
  • 0.2.7
  • 0.2.6
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.25
  • 0.1.24
  • 0.1.23
  • 0.1.22
  • 0.1.21
  • 0.1.20
  • 0.1.19
  • 0.1.18
  • 0.1.17
  • 0.1.16
  • 0.1.15
  • 0.1.14
  • 0.1.13
  • 0.1.12
  • 0.1.11
  • 0.1.10
  • 0.1.9
  • 0.1.8
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1 (deleted)
  • 0.1.0
released Feb 6th 2019
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.5.0 < 5.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'jsnshrmn-twlight', '0.5.13'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jsnshrmn-twlight
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jsnshrmn-twlight --version 0.5.13

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

jsnshrmn/twlight — version 0.5.13 Feb 6th 2019

twlight_puppet

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with twlight
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.

Overview

This puppet module deploys and configures the Library Card Platform for The Wikipedia Library to Debian 8 systems. It is a work in progress.

Module Description

As it stands, this module is somewhat amature attempt to puppetize TWLight. It does the following sorts of things:

  • directly installs and configures packages
  • checks stuff out from git
  • runs dumb shell scripts to manage django
  • writes secrets to files

You probably only want to use this if you are developing or operating TWLight.

Setup

What twlight affects

The initial goal of this module is to install and configure TWLight as described in the project Sysadmin docs. Most of that doc content will get migrated here. Beyond that, this module

  • Runs any uncommitted django migrations
  • Imports a db dump if one exists at the specified location
  • Adds a daily mysql dump cron job

Beginning with twlight

Give twlight_vagrant a go

Usage

The classes, types, and resources for customizing, configuring, and doing the fancy stuff with this module are all shifting around rapidly since it's very immature. Check out the default manifest in the vagrant environment for now.

The only intended production environment for this is the wikimedia tools infrastructure. It's such a narrow-use module, that there's not much point in investing the effort to split it out into role modules + scap code deployment.

So, to do a headless deploy on tools:

  1. new instance on horizon, with appropriate host-specific hiera config to allow access to the project share
  2. dump db on current site
  3. Do a local puppet run
puppet module install jsnshrmn/twlight --version x.x.x
puppet apply some-manifest.pp
  1. delete the proxy pointing to the old site
  2. create a proxy pointing to a new site

Reference

Limitations

Debian 8,9 only

Development

twlight_vagrant is an adequate environment to develop this module in. Beyond the typical github workflow, you may wish to build the module to publish updates to puppet forge. You'll need to feed all of the right options to the installation of puppet in that environment, like:

/opt/puppetlabs/bin/puppet module build /vagrant/puppet/modules/twlight --codedir /vagrant/puppet