Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/markosamuli/macos-machine

macOS development machine setup
https://github.com/markosamuli/macos-machine

ansible macos

Last synced: 5 months ago
JSON representation

macOS development machine setup

Awesome Lists containing this project

README 

          
# Development macOS Setup



[![GitHub release](https://img.shields.io/github/release/markosamuli/macos-machine.svg)](https://github.com/markosamuli/macos-machine/releases)

[![License](https://img.shields.io/github/license/markosamuli/macos-machine.svg)](https://github.com/markosamuli/macos-machine/blob/master/LICENSE)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![Known Vulnerabilities](https://snyk.io/test/github/markosamuli/macos-machine/badge.svg)](https://snyk.io/test/github/markosamuli/macos-machine)



| Branch | Coding Style               |

| ------ | -------------------------- |

| master | ![Coding Style][cs-master] |



This is a collection of Ansible roles and tasks to setup a new developer machine

on macOS.



Read my [Machine Setup Guide][machine-setup-guide] for instructions.



[machine-setup-guide]: https://machine.msk.io/

[cs-master]: https://github.com/markosamuli/macos-machine/workflows/Code%20Quality/badge.svg?branch=master



## Requirements



- Mac running macOS 10.14 (Mojave) or later

- Xcode (Command Line Tools) 11 or later installed

- Xcode (Command Line Tools) 12 or later recommended on macOS Catalina

- Git installed (provided with Xcode Command Line tools)



This setup has only been tested on the macOS Sierra and not against existing

installations.



See [markosamuli/linux-machine] for my Ubuntu Linux setup.



[markosamuli/linux-machine]: https://github.com/markosamuli/linux-machine



## Install



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

the `setup` script.



```bash

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

```



## Getting Started



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



```bash

git clone https://github.com/markosamuli/macos-machine

cd macos-machine

./setup

```



## Local options



You can pass custom variables to the Ansible playbook and roles by creating a

[`machine.yaml`][machine.yaml] file to customise your configuration.



```bash

cp machine.yaml.example machine.yaml

```



The `setup` script will detect if this file exists and passes it to the Ansible

Playbook with `--extra-vars`.



[machine.yaml]: machine.yaml



## Software installed by the playbooks



### Installation tools



The following tools are prerequisites and always installed during setup if not

already found on the system.



- Xcode Command Line Tools

- [Homebrew](https://brew.sh/)

- [Ansible](https://www.ansible.com/) installed with Homebrew

- [Python](https://www.python.org/) installed with Homebrew



### Desktop applications



[iTerm2][iterm2] and [Terminus][terminus] terminal applications will be

installed on all environments.



To install [Google Drive File Stream][gdfs]:



```yaml

install_gdfs: true

```



To install [Slack][slack] desktop application:



```yaml

install_slack: true

```



[terminus]: https://eugeny.github.io/terminus/

[iterm2]: https://www.iterm2.com/

[slack]: https://slack.com/downloads/osx

[gdfs]: https://support.google.com/drive/answer/7329379?hl=en



### Shell



Latest version of [Zsh][zsh] will be installed from Homebrew.



[zsh]: https://www.zsh.org/



### Command line tools



- [GNU Wget][wget]

- [GNU sed][sed] as `gsed` command

- [GNU tar][tar] as `gtar` command

- [jq] command-line JSON processor

- [The Silver Searcher][ag] (`ag` command) code searching utility similar to

  `ack`

- [htop] process viewer for console

- [ShellCheck][shellcheck] static analysis tool for shell scripts

- [shfmt] formatter for shell scripts

- [asciinema] for recording terminal session



Run tools playbook:



```bash

make install-tools

```



[wget]: https://www.gnu.org/software/wget/

[sed]: https://www.gnu.org/software/sed/

[tar]: https://www.gnu.org/software/tar/

[jq]: https://stedolan.github.io/jq/

[htop]: https://hisham.hm/htop/

[ag]: https://github.com/ggreer/the_silver_searcher

[shellcheck]: https://github.com/koalaman/shellcheck

[shfmt]: https://github.com/mvdan/sh

[asciinema]: https://asciinema.org/



### macOS customization and automation



To install [Hazel][hazel] automation tool:



```yaml

install_hazel: true

```



To install [Hammerspoon][hammerspoon] automation tool:



```yaml

install_hammerspoon: true

```



[hazel]: https://www.noodlesoft.com/

[hammerspoon]: https://www.hammerspoon.org/



### Editors



[Visual Studio Code][vscode] will be installed on all environments.



Latest [Vim][vim] package will be installed from Homebrew.



To install [MacVim][macvim] instead of Vim, update `machine.yaml` with the

following configuration:



```yaml

install_macvim: true

```



To install [JetBrains Toolbox][jetbrains] to install and manage JetBrains

applications:



```yaml

install_jetbrains_toolbox: true

```



[vscode]: https://code.visualstudio.com/

[vim]: https://www.vim.org/

[macvim]: https://github.com/macvim-dev/macvim

[jetbrains]: https://www.jetbrains.com/toolbox-app/



### asdf version manager



You can install [asdf] version manager by adding the following option to your

[`machine.yaml`][machine.yaml]:



```yaml

install_asdf: true

```



To configure [asdf plugins][asdf-plugins] and package versions to install, add

them into your [`machine.yaml`][machine.yaml] configuration.



```yaml

asdf_plugins:

  - name: kubectl

  - name: concourse

```



Note that some of the playbooks remove conflicting asdf plugins and versions if

a respective tool is installed using another package or version manager.



[asdf]: https://asdf-vm.com

[asdf-plugins]: https://asdf-vm.com/#/plugins-all



### Python



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



- [pyenv]

- [pyenv-virtualenv]

- [Python][python] v3.7 installed with pyenv



Run Python playbook:



```bash

make install-python

```



You can disable installation by adding the following option to your

[`machine.yaml`][machine.yaml]:



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



```yaml

pyenv_init_shell: false

```



[python]: https://www.python.org/

[pyenv]: https://github.com/pyenv/pyenv

[pyenv-virtualenv]: https://github.com/pyenv/pyenv-virtualenv



### Ruby



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



```yaml

install_ruby: true

```



This will install:



- [rbenv] using [zzet.rbenv] role

- [Ruby][ruby] version 2.6.3 with rbenv



Run Ruby playbook:



```bash

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:



```yaml

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, so you need to add

something like below to initialize rbenv in your shell:



```bash

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

```



[zzet.rbenv]: https://github.com/zzet/ansible-rbenv-role

[rbenv]: https://github.com/rbenv/rbenv

[ruby]: https://www.ruby-lang.org/en/



### Node.js



- [Node Version Manager][nvm] (NVM)

- [Node.js][nodejs] LTS installed with NVM



Run Node.js playbook:



```bash

make install-node

```



You can disable installation by adding the following option to your

[`machine.yaml`][machine.yaml]:



```yaml

install_nodejs: false

```



[nvm]: https://github.com/creationix/nvm

[nodejs]: https://nodejs.org/en/



### Go



[Go programming language][golang] installed using [markosamuli.golang] Ansible

role.



Run Go playbook:



```bash

make install-golang

```



You can disable installation by adding the following option to your

[`machine.yaml`][machine.yaml]:



```yaml

install_golang: false

```



[golang]: https://golang.org/



### Lua



You can install [Lua][lua] programming language by adding the following option

to your [`machine.yaml`][machine.yaml] file:



```yaml

install_lua: true

```



Run Lua playbook:



```bash

make install-lua

```



This will also install [LuaRocks][luarocks] package manager and [luacheck]

rock using the custom [luarocks module][luarocks.py].



[lua]: https://www.lua.org/

[luarocks]: https://luarocks.org/

[luacheck]: https://github.com/mpeterv/luacheck

[luarocks.py]: playbooks/library/luarocks.py



### Rust



Install [Rust][rust] programming language:



```yaml

install_rust: true

```



To avoid modifying path during install:



```yaml

rust_modify_path: false

```



Run Rust playbook:



```bash

make install-rust

```



To uninstall Rust, run:



```bash

rustup self uninstall

```



[rust]: https://www.rust-lang.org/



### Git



Latest version of [Git][git] will be installed from Homebrew.



[git]: https://git-scm.com/



### Vagrant and VirtualBox



[Vagrant][vagrant] and [VirtualBox][virtualbox] are no longer installed by

default, but you can enable them by adding:



```yaml

install_vagrant: true

```



[vagrant]: https://www.vagrantup.com/

[virtualbox]: https://www.virtualbox.org/



### Docker



[Docker for Mac][docker] will be installed by default.



Run Docker playbook:



```bash

make install-docker

```



To disable installation, add:



```yaml

install_docker: false

```



[docker]: https://docs.docker.com/docker-for-mac/



### Certbot



Install [Certbot][certbot] with:



```yaml

install_certbot: true

```



[certbot]: https://certbot.eff.org



### Nmap



Install [Nmap][nmap] utility for network discovery and security auditing by

adding:



```yaml

install_nmap: true

```



[nmap]: https://nmap.org/



### Packer



To install [Packer][packer] add:



```yaml

install_packer: true

```



[packer]: https://packer.io/



### Terraform



Install [tfenv] version manager for [Terraform][terraform] and install the

latest version.



Any previous conflicting installations using [asdf] or [markosamuli.terraform]

role are removed.



Run Terraform playbook:



```bash

make install-terraform

```



Disable [Terraform][terraform] installation with:



```yaml

install_terraform: false

```



[terraform]: https://www.terraform.io/

[tfenv]: https://github.com/tfutils/tfenv



### Digital Ocean



Install [doctl] using Homebrew package manager by adding the following option to

your [`machine.yaml`][machine.yaml]:



```yaml

install_doctl: true

```



This will uninstall any conflicting asdf plugins and versions.



[doctl]: https://github.com/digitalocean/doctl



### Amazon Web Services



- [AWS CLI](https://aws.amazon.com/cli/)

- [aws-shell](https://github.com/awslabs/aws-shell) - interactive shell for AWS

  CLI

- [AWS Vault](https://github.com/99designs/aws-vault) - a vault for securely

  storing and accessing AWS credentials in development environments

- [cli53](https://github.com/barnybug/cli53) - command line tool for Amazon

  Route 53



Run AWS playbook:



```bash

make install-aws

```



You can disable installation by adding the following option to your

[`machine.yaml`][machine.yaml]:



```yaml

install_aws: false

```



### Google Cloud Platform



[Google Cloud SDK][cloud-sdk] installed from the archive file under user home

directory. You shouldn't try to install a global version with these playbooks.



Run Google Cloud SDK playbook:



```bash

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:



```yaml

gcloud_install_path: ~/opt

```



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`][machine.yaml] file:



```yaml

gcloud_setup_shell: false

```



You can disable installation by adding the following option to your

[`machine.yaml`][machine.yaml]:



```yaml

install_gcloud: false

```



[cloud-sdk]: https://cloud.google.com/sdk/



## Changes to existing configuration



The installer creates empty `~/.bash_profile` and `~/.bashrc` files and makes

sure `~/.bashrc` is loaded from `~/.bash_profile`.



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:



```bash

make install-roles

```



To update roles to the latest release versions:



```bash

make update-roles

```



To remove any outdated roles:



```bash

make clean-roles

```



| Role                    | Build status                                                                                                                                  |

| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |

| [markosamuli.asdf]      | [![Build Status](https://travis-ci.com/markosamuli/ansible-asdf.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-asdf)           |

| [markosamuli.aws_tools] | [![Build Status](https://travis-ci.com/markosamuli/ansible-aws-tools.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-aws-tools) |

| [markosamuli.gcloud]    | [![Build Status](https://travis-ci.com/markosamuli/ansible-gcloud.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-gcloud)       |

| [markosamuli.golang]    | [![Build Status](https://travis-ci.com/markosamuli/ansible-golang.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-golang)       |

| [markosamuli.nvm]       | [![Build Status](https://travis-ci.com/markosamuli/ansible-nvm.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-nvm)             |

| [markosamuli.packer]    | [![Build Status](https://travis-ci.com/markosamuli/ansible-packer.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-packer)       |

| [markosamuli.pyenv]     | [![Build Status](https://travis-ci.com/markosamuli/ansible-pyenv.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-pyenv)         |

| [markosamuli.rust]      | [![Build Status](https://travis-ci.com/markosamuli/ansible-rust.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-rust)           |

| [markosamuli.vagrant]   | [![Build Status](https://travis-ci.com/markosamuli/ansible-vagrant.svg?branch=master)](https://travis-ci.com/markosamuli/ansible-vagrant)     |

| [zzet.rbenv]            | [![Build Status](https://travis-ci.org/zzet/ansible-rbenv-role.png?branch=master)](https://travis-ci.org/zzet/ansible-rbenv-role)             |



[markosamuli.asdf]: https://github.com/markosamuli/ansible-asdf

[markosamuli.aws_tools]: https://github.com/markosamuli/ansible-aws-tools

[markosamuli.gcloud]: https://github.com/markosamuli/ansible-gcloud

[markosamuli.golang]: https://github.com/markosamuli/ansible-golang

[markosamuli.nvm]: https://github.com/markosamuli/ansible-nvm

[markosamuli.packer]: https://github.com/markosamuli/ansible-packer

[markosamuli.pyenv]: https://github.com/markosamuli/ansible-pyenv

[markosamuli.rust]: https://github.com/markosamuli/ansible-rust

[markosamuli.terraform]: https://github.com/markosamuli/ansible-terraform

[markosamuli.vagrant]: https://github.com/markosamuli/ansible-vagrant

[zzet.rbenv]: https://github.com/zzet/rbenv

[requirements.yml]: requirements.yml



## Development



Install [pre-commit] hooks:



```bash

make setup-git-hooks

```



Lint code and configuration:



```bash

make lint

```



[pre-commit]: https://pre-commit.com/



## References



This is based on my previous setup [markosamuli/machine] that was forked off

from [caarlos0/machine] to suit my needs.



[markosamuli/machine]: https://github.com/markosamuli/machine

[caarlos0/machine]: https://github.com/caarlos0/machine



## License



- [MIT](LICENSE)



## Authors



- [@markosamuli](https://github.com/markosamuli)