Development Linux Setup

Branch	Build Status	Coding Style
master
develop

This is a collection of Ansible roles and tasks to setup a Linux development machine.

Read my Machine Setup Guide for instructions.

Requirements

• Ubuntu or Debian Linux
• Git installed
• Bash shell
• Ansible 2.8 or newer
• Python 3.7 or newer as required by Ansible

See markosamuli/macos-machine for my macOS setup.

Ubuntu

This setup has been tested on the following Linux releases:

• Ubuntu 20.04 LTS (Focal Fossa)
• Debian 10 "buster"

Older releases are only tested using Travis CI builds and might not be fully supported:

• Ubuntu 18.04 LTS (Bionic Beaver)
• Ubuntu 16.04 LTS (Xenial Xerus)

Ubuntu on WSL

I've used this playbook to install packages on Ubuntu running on Windows Subsystem for Linux on Windows 10.

I'm currently running Ubuntu 20.04 LTS on WSL2 and will not be testing any future configuration on WSL1.

Some packages are known not to work so I've added custom fact is_wsl that can be used to check if we're running Linux on Windows and these will be skipped during the set up.

Pengwin on WSL

I'm no longer using or testing the playbooks on Pengwin Linux since I've upgraded to WSL2 and Ubuntu 20.04 LTS and Debian buster on my Windows 10 environment.

Install

Install Git and curl:

sudo apt update
sudo apt install curl git

You can run the installer script that will clone the code from GitHub and run the setup script.

curl -s https://raw.githubusercontent.com/markosamuli/linux-machine/master/install.sh | bash -

Getting Started

Clone this project locally and run the ./setup script.

git clone https://github.com/markosamuli/linux-machine
cd linux-machine
./setup

Local options

You can pass custom variables to the Ansible playbook and roles by creating a machine.yaml file to customise your configuration.

cp machine.yaml.example machine.yaml

You can also use my customizations:

ln -s machine.msk.yaml machine.yaml

The setup script will detect if this file exists and passes it to the Ansible Playbook with --extra-vars.

Ansible

The setup script will try to install Ansible

Ansible version

Ansible version 2.9 is installed by default.

You can define MACHINE_ANSIBLE_VERSION environment variable to change the installed version.

Example to use Ansible 2.8 instead of Ansible 2.9:

export MACHINE_ANSIBLE_VERSION=2.8

Force Ansible reinstall

To remove existing Ansible versions and force installation of Ansible, you can use the --reinstall-ansible argument, for example:

./setup --reinstall-ansible

Installing Ansible with APT

The setup script will install Ansible using APT from Ansible PPAs if the ansible command is not found on your system.

Ubuntu 20.04 LTS will not use Ansible PPAs as the builds for this release are missing.

Version	PPA
2.8	ansible/ansible-2.8
2.9 (default)	ansible/ansible-2.9

Installing Ansible from PyPI into virtualenv

If an acceptable Ansible APT package installation candidate can't be found the setup script will try to install Ansible with pip in a local virtuelenv.

If virtuelenv can't be found the setup script the setup will fail.

You can disable installation from PyPI with --disable-ansible-pypi argument, for example:

./setup --disable-ansible-pypi

Installing Ansible from PyPI into pyenv environment

If the user has set up a local development environment with pyenv and this is defined in a .python-version file in the repository root, the setup script will install Ansible into this environment.

Same as with the local virtualenv, you can disable installation from PyPI with --disable-ansible-pypi argument, for example:

./setup --disable-ansible-pypi

Software installed by the playbooks

Zsh

Zsh is installed by default. You can disable this in the configuration:

install_zsh: false

Homebrew on Linux (aka Linuxbrew)

Homebrew can be installed on Linux by enabled the following option:

install_linuxbrew: true

To enable and install:

make install-linuxbrew

Installation will be done using markosamuli.linuxbrew Ansible role.

Terminals for desktop environments

Installed on all non-WSL environments:

• Terminator
• Hyper
• Terminus

Developer tools

Installed on all non-WSL environments:

• Meld, a visual diff and merge tool

Slack

To install Slack desktop application via Snap package:

install_slack: true

Productivity applications

Installed on non-WSL environments:

• LibreOffice

To enable and install:

make install-productivity

To disable:

install_productivity: false

Antivirus

Antivirus software can be installed:

• ClamAV

To enable and install:

make install-antivirus

To enable manually:

install_antivirus: true

Security tools

Security tools that can be installed:

• Lynis security tool

To enable and run the security playbook:

make install-security

To enable manually:

install_security: true

Security hardening

Install optional security hardening tools:

• passwdqc for password/passphrase strength checking and enforcement
• USBGuard for protecting system against rogue USB devices
• debsums tool for verification of installed package files against MD5 checksums

To enable and run the security hardening playbook:

make install-security-hardening

To enable manually:

install_security_hardening: true

Monitoring

Install optional system monitoring tools:

• GNU Accounting utilities for process and login accounting
• sysstat - Performance monitoring tools for Linux

To enable and run the monitoring playbook:

make install-monitoring

To enable manually:

install_monitoring: true

Command line tools

• GNU Wget
• curl
• jq command-line JSON processor
• The Silver Searcher (ag command) code searching utility similar to ack
• htop process viewer for console
• pass — the standard unix password manager
• ShellCheck, a static analysis tool for shell scripts

Run the tools playbook:

make install-tools

Visual Studio Code

Visual Studio Code will be installed on non-WSL environments via Snap package.

See Developing on WSL for instructions how to install and use Visual Studio Code Remote - WSL extension.

Vim

Latest version of Vim will be installed using the package manager.

To install Neovim enable it in machine.yaml:

install_neovim: true

asdf version manager

You can install asdf version manager by adding the following option to your machine.yaml:

install_asdf: true

To configure asdf plugins and package versions to install, add them into your machine.yaml configuration.

asdf_plugins:
  - name: kubectl
  - name: concourse

Python

Use Ubuntu/Debian packages to install Python on the system:

• Python with python3 package — installed Python version will depend on the OS release version
• pip with python3-pip package
• [virtualenv] from PyPI

Use pyenv to install and manage Python versions for the current user:

• pyenv
• pyenv-virtualenv
• Python 3.7 and 3.8 installed with pyenv

Run Python playbook:

make install-python

You can disable installation by adding the following option to your machine.yaml:

install_python: false

The markosamuli.pyenv role will modify your .bashrc and .zshrc files during the setup. If you want to disable this, edit machine.yaml file and disable the following configuration option.

pyenv_init_shell: false

Ruby

To install Ruby for development, enable it in your machine.yaml configuration:

install_ruby: true

This will install:

• rbenv using zzet.rbenv role
• Ruby version 2.6.3 with rbenv

Run Ruby playbook:

make install-ruby

To change the installed rubies and default version, add the following to your machine.yaml file and customize it to your needs:

rbenv:
  env: user
  version: v1.1.2
  default_ruby: 2.6.3
  rubies:
    - version: 2.6.3

The role doesn't update your .bashrc or .zshrc files but adds a global initialization script in /etc/profile.d/rbenv.sh. If this doesn't work on your environment, add something like below to initialize rbenv in your shell:

if [ -z "${RBENV_ROOT}" ]; then
  if [ -d "$HOME/.rbenv" ]; then
    export PATH=$HOME/.rbenv/bin:$PATH;
    export RBENV_ROOT=$HOME/.rbenv;
    eval "$(rbenv init -)";
  fi
fi

Rust

Install Rust programming language with markosamuli.rust role.

Enable with:

install_rust: true

To avoid modifying path during install:

rust_modify_path: false

Run Rust playbook:

make install-rust

To uninstall Rust, run:

rustup self uninstall

Node.js

• Node Version Manager
• Node.js LTS installed with NMV

Run Node.js playbook:

make install-node

You can disable installation by adding the following option to your machine.yaml:

install_nodejs: false

Go

Go programming language installed using markosamuli.golang Ansible role.

Run Go playbook:

make install-golang

You can disable installation by adding the following option to your machine.yaml:

install_golang: false

Go tools installed for development:

• golint is a linter for Go source code
• goimports is a tool for updating your Go import lines
• errcheck is a program for checking for unchecked errors in go programs
• go-callvis is a development tool to help visualize call graph of a Go program using interactive view
• gopkgs is a tool that provides list of available Go packages that can be imported
• Stringer is a tool to automate the creation of methods that satisfy the fmt.Stringer interface
• guru is a tool for answering questions about Go source code
• staticcheck is a linter for Go source code

Lua

You can install Lua programming language by adding the following option to your machine.yaml file:

install_lua: true

Run Lua playbook:

make install-lua

This will also install LuaRocks package manager and luacheck rock using the custom luarocks module.

Git

Latest version of Git will be installed.

Vagrant and VirtualBox

Vagrant and VirtualBox are no longer installed by default, but you can enable them by adding:

install_vagrant: true

Docker

Docker will be installed by default.

Run Docker playbook:

make install-docker

To disable installation, add:

install_docker: false

Packer

To install Packer add:

install_packer: true

Terraform

Terraform is installed using tfenv Terraform version manager.

Run Terraform playbook:

make install-terraform

Disable Terraform installation with:

install_terraform: false

Amazon Web Services

• AWS CLI
• aws-shell - interactive shell for AWS CLI
• AWS Vault - a vault for securely storing and accessing AWS credentials in development environments
• cli53 - command line tool for Amazon Route 53

You can disable installation by adding the following option to your machine.yaml:

install_aws: false

Google Cloud Platform

Google Cloud SDK installed from the archive file under user home directory.

Run Google Cloud SDK playbook:

make install-gcloud

Default install path is in ~/google-cloud-sdk, but you can install it to another location, for example if you prefer ~/opt/google-cloud-sdk add the following option:

gcloud_install_path: ~/opt

To prefer python3 over python2 during Google Cloud SDK install:

gcloud_prefer_python3: true

The markosamuli.gcloud role will modify your .bashrc and .zshrc files. To disable this and manage the configuration yourself, disable the following configuration option in the machine.yaml file:

gcloud_setup_shell: false

You can disable installation by adding the following option to your machine.yaml:

install_gcloud: false

If you prefer to install Google Cloud SDK using package manager, enable it in the machine.yaml configuration file:

gcloud_install_from_package_manager: true

Changes to existing configuration

The installer makes changes to your ~/.bashrc and ~/.zshrc files, so take backup copies of them before running the script.

Ansible Roles

The following external Ansible roles are installed and used. See requirements.yml file for the installed versions.

To install roles:

make install-roles

To update roles to the latest release versions:

make update-roles

To remove any outdated roles:

make clean-roles

Role	Build status
markosamuli.asdf
markosamuli.aws_tools
markosamuli.gcloud
markosamuli.golang
markosamuli.linuxbrew
markosamuli.nvm
markosamuli.packer
markosamuli.pyenv
markosamuli.vagrant
markosamuli.hyper

Development

You should have Python 3.7 or newer installed for the development tools and pre-commit hooks to work.

Install development environment, including Git pre-commit hooks:

make setup-dev

Lint code and configuration:

make lint

References

This is based on my previous setup markosamuli/machine that was forked off from caarlos0/machine to suit my needs.

License

• MIT

Authors

• @markosamuli