Ready, Set, Develop

Ready, Set, Develop™ is a collection of automation scripts to streamline setting up new machines (almost) from scratch or to synchronising configs across computers, powered by Ansible.

Motivation

Throughout my journey as a human being, I've setup enough servers and computers to ignite a profound appreciation for automation. I treat all my machines like trusty tools, but I'm not one to rely entirely on them. In case Murphy's Law pays a visit, I take comfort in knowing my data is backed up, and I can bounce back in no time.

Now, this repository? It's all about automating setting up my personal computers and synchronise configurations across them, so that I have the same dev environment across computers.

Features

• dotfiles setup (afonsoc12/dotfiles)
• Install homebrew and packages (formulae and casks)
• Mac App Store apps
• Python environment (pyenv, it's plugins and pip packages)
• git configuration and git clone
• macOS defaults configuration
• macOS Dock icons setup and order
• Oh My Zsh installation
• Configure code editors/IDEs/terminal

Installation (virgin machine)

1. Install Apple's Command Line Tools:

   xcode-select --install
   # Agree with Xcode's license

2. Setup environment variables:

   export PATH="$HOME/Library/Python/3.9/bin:/opt/homebrew/bin:$PATH"
   export ANSIBLE_HOME="$HOME/.local/share/ansible"

3. Install Ansible using the system Python:

   sudo pip3 install --upgrade pip
   pip3 install ansible

4. Clone or download this repository

   git clone https://github.com/afonsoc12/ready-set-develop.git

5. Install Ansible requirements

   ansible-galaxy install -r requirements.yml

6. Run playbook

   ansible-playbook main.yml --ask-become-pass --ask-vault-password
   # Enter your macOS account password

Note: Alternatively, the Ansible Vault password file can be passed by the environment variable ANSIBLE_VAULT_PASSWORD_FILE. However, since this is likely not in the new machine, it will be prompted at runtime.

Usage

By default, the playbook will look for a config.yml variables file in the root of the repository. It contains my default settings for most of my machine. However, since some of these cannot be shared, they are encrypted with ansible-vault.

To override these, you can either replace the config.yml with the contents of config.default.yml or append the argument -e myconfig.yml to ansible-playbook command, pointing to your new config file.

Extra Tasks

These extras tasks that can be placed in extra_tasks/, will be executed after all roles in the playbook, without any particular order. To skip all roles and jump straight to the extra tasks, the flag --tags extra can be added to the playbook. This folder is excluded in .gitignore. This is where I specify a few tasks that are only specific to one machine, if any.

Potential Problems

• Issues with docker plugins not linked: GitHub Issue

Roles Overview

TODO

Testing

This repo uses GitHub Actions for CI. This workflow runs linting and integration tests against macOS 12 and 13. I cannot guarantee this will work in Linux, and it will definitely not work in windows.

Linting and tests overview:

• yamllint
• ansible-lint
• ansible's --syntax-check
• ansible-playbook with default vars
• ansible-playbook with vars from test/config.yml
• Idempotence test

Credits

Copyright 2023 Afonso Costa

Licensed under the Apache License, Version 2.0 (the "License")

Thanks to Jeff Geerling for two excellent books: Ansible for DevOps and Ansible for Kubernetes. Also, for unknowingly allowing me to borrow some pieces from geerlingguy/mac-dev-playbook. The perks of OSS!