DIMS Ansible playbooks v 2.14.0

This document (version 2.14.0) describes the DIMS Ansible playbooks (ansible-dims-playbooks for short) repository contents.

Contents:

• 1. Introduction
  • 1.1. Installation Steps
• 2. Ansible and Configuration Management
  • 2.1. Ansible fundamentals
  • 2.2. Variables
  • 2.3. Configuration and Customization of ansible and ansible-playbook
    • 2.3.1. Controlling account, SSH port, etc.
  • 2.4. Lessons from the Fedora Project Ansible Playbooks
  • 2.5. Generating iptables Rules from a Template
  • 2.6. Customization of System and Service Configuration
  • 2.7. Tags on Tasks
    • 2.7.1. DIMS Tagging Methodology
    • 2.7.2. Examples of DIMS Tags
  • 2.8. Ansible Best Practices and Related Documentation
• 3. Bootstrapping a VM Host as an Ansible Controller
  • 3.1. Initial Connectivity
  • 3.2. Establishing Full Internet Connectivity
  • 3.3. Bootstrapping Full Ansible Control
  • 3.4. Integration into Working Inventory
  • 3.5. Normal Playbook Operations
  • 3.6. Validating VNC over SSH Tunnelling
• 4. Creating VMs
  • 4.1. Manual Installation of Virtual Machines
  • 4.2. Bootstrapping the New VMs
  • 4.3. Initial Provisioning of the New VMs
• 5. Customizing a Private Deployment
  • 5.1. Cookiecutter
    • 5.1.1. Top Level Files and Directories
    • 5.1.2. The dims-new-repo Cookiecutter
    • 5.1.3. The dims-private Cookiecutter
  • 5.2. Populating the Private Configuration Repository
• 6. Testing System Components
  • 6.1. Organizing Bats Tests
  • 6.2. Organizing tests in DIMS Ansible Playbooks Roles
  • 6.3. Running Bats Tests Using the DIMS test.runner
  • 6.4. Controlling the Amount and Type of Output
    • 6.4.1. Using DIMS Bash functions in Bats tests
• 7. Debugging with Ansible and Vagrant
  • 7.1. Debugging Ansible
    • 7.1.1. Examining Variables
    • 7.1.2. Debugging Filter Logic
    • 7.1.3. Developing Custom Jinja Filters
• 8. Regular System Maintenance
  • 8.1. Updating Operating System Packages
  • 8.2. Renewing Letsencrypt Certificates
  • 8.3. Updating Secondary Components
    • 8.3.1. Updating Vagrant Plugins
    • 8.3.2. Updating PyCharm Community Edition
• 9. Backups and Restoration
  • 9.1. Backup Directories and Files
  • 9.2. Creating a Backup
  • 9.3. Restoring from a Backup
  • 9.4. Scheduled Backups
  • 9.5. Other System Backups
• 10. License
• 11. Appendices
  • 11.1. Quick Steps to Restarting Squid Proxy Container
  • 11.2. Recovering From Operating System Corruption
  • 11.3. Advanced Ansible Tasks or Jinja Templating
    • 11.3.1. Multi-line fail or debug Output

Section author: Dave Dittrich dittrich@u.washington.edu

Copyright © 2017 University of Washington. All rights reserved.