Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jessestuart/homemaker

Automate the creation of machines that feel like 🏠 — all the libraries, dependencies, and (most importantly) dotfiles that you've grown to know and love.
https://github.com/jessestuart/homemaker

ansible circleci configuration-management docker packer vagrant

Last synced: 17 days ago
JSON representation

Automate the creation of machines that feel like 🏠 — all the libraries, dependencies, and (most importantly) dotfiles that you've grown to know and love.

Awesome Lists containing this project

README 

        
# Homemaker



[![CircleCI][circleci-badge]][circleci-url]

[![SemaphoreCI Build Status][semaphoreci-badge]][semaphoreci-link]



## What is this nonsense?



`homemaker` is a developer tool composing [Vagrant][vagrant-url],

[Packer][packer-url], and [Ansible][ansible-url] to automate the creation of

machine environments that "feel like home".





  




You know that feeling -- you spin up a box, only to find yourself on the verge

of self-defenestration when none of your aliases work; none of the right

dependencies are installed; and what you thought would be a quick proof-of-concept

turns into a wasted morning of productivity. Nobody wants that.





  




---------------------------------------



## How does this help me?



Homemaker is an opinionated devbox-generator for everyday use, whether locally

(e.g., via a Vagrant box) or cloud-based (by using a Packer builder for

AWS, Digital Ocean, Vultr, etc.). Homemaker was created largely because I got

sick of spinning up boxes and seeing some variation of this:



```console

[vagrant@homemaker-1514256437]~%

=> # Cool! I'm in! Let me just list what's in the current directory:

[vagrant@homemaker-1514256437]~% la

=> zsh: command not found: la

=> # Oh right, this is a fresh box. Aight, I know my base script set Docker up

=> # on here — let's check that the daemon's responding:

=> # (...Proceed to insert another custom alias, because muscle memory)

[vagrant@homemaker-1514256437]~% dps

zsh: command not found: dps

=> # Well that was dumb. If only I had a way to quickly spin up a fully

=> # provisioned box **with all my custom dotfiles** I've so carefully curated

=> # over the years... Now that would be the bee's knees.

```



TL;DR: `homemaker` provides a way to automate the creation of machines that

feel like home -- none of the bloat of a full desktop OS, just the dependencies

& libraries you need to get to get cookin', and (most importantly), your

trusty, dependable dotfiles.



## How do I use this?



`homemaker` supports several methods of execution, depending on your needs.



### Local VM



If all you need is a isolated, disposable development environment, then using

the provided Vagrantfile to run `homemaker` as a local VM is a great place to

start.



```console

$ git clone https://github.com/jessestuart/homemaker

$ cd homemaker

$ vagrant up

```



NOTE: This assumes that you have the `vagrant` CLI tool installed on the host

machine. If not, consult the Vagrant [installation docs][vagrant-installation]

to obtain the installation binary for your OS. Note that Hashicorp strongly

advises against relying on your OS' package manager to install Vagrant:



> "Typically these packages are missing dependencies or include very outdated

> versions of Vagrant. [...] Please use the official installers on the

> downloads page."



Anecdotally, I've never had issues on macOS with simply running

`cask install vagrant`. YMMV.



#### Packer & custom machine images



`homemaker` can also be used to build identical machine images for one of the

several major cloud compute providers, in case you want to spin up an

environment -- whether as a simple remote sandbox, or as the foundation for

a hardened production-ready server -- using Packer builders. Services currently

supported are:



* [x] AWS

* [x] Digital Ocean

* [x] Vultr



Support for other hosting platforms has been tested but is not currently maintained:



- Linode

- Google Compute Engine

- Scaleway



### Disclaimer



Homemaker is still a work in progress. Things I plan on improving upon:



* Support dotfile management systems other than Thoughtbot's RCM.

* Update roles to be more distro-agnostic — `homemaker` currently only supports

  CentOS and Debian/Ubuntu, but it would be super to be able to spin up

  environments in any major distro, particularly more lightweight distros such

  as Alpine. I've already make some preliminary progress on this front. PR's

  always welcome and encouraged.



[ansible-url]: https://github.com/ansible/ansible

[circleci-badge]: https://circleci.com/gh/jessestuart/homemaker.svg?style=shield

[circleci-url]: https://circleci.com/gh/jessestuart/homemaker

[packer-url]: https://github.com/hashicorp/packer

[semaphoreci-badge]: https://semaphoreci.com/api/v1/jesses/homemaker/branches/jesse-circleci/badge.svg

[semaphoreci-link]: https://semaphoreci.com/jesses/homemaker

[vagrant-installation]: https://www.vagrantup.com/downloads.html

[vagrant-url]: https://github.com/hashicorp/vagrant