https://github.com/samuell/devbox-golang
A Vagrant box with Ansible provisioning for setting up a vim-based Go(lang) development environment
https://github.com/samuell/devbox-golang
ansible golang vagrant vagrant-boxes vagrant-machine virtualbox
Last synced: about 1 month ago
JSON representation
A Vagrant box with Ansible provisioning for setting up a vim-based Go(lang) development environment
- Host: GitHub
- URL: https://github.com/samuell/devbox-golang
- Owner: samuell
- Created: 2015-02-27T19:54:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-22T08:07:43.000Z (over 6 years ago)
- Last Synced: 2025-02-25T05:34:11.873Z (about 2 months ago)
- Topics: ansible, golang, vagrant, vagrant-boxes, vagrant-machine, virtualbox
- Language: Shell
- Size: 171 KB
- Stars: 85
- Watchers: 6
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list-ansible - devbox-golang - based Go(lang) development environment (virtualbox)
README
# DevBox-Golong
*Vagrant box backed by Docker or Virtualbox, with Ansible provisioning*
A Vagrant box (Virtualbox or Docker as providers) with Ansible provisioning
for setting up a Vim-based Golang development environment.
### Note: There are currently problems with the docker version of the script, so please use the virtualbox version until this is solved!
## Ingredients
- [Ubuntu 16.04 "xenial" LTS 64bit base image](http://www.ubuntu.com/)
- [Go(lang) 1.6.2](http://golang.org/)
- [Vim](http://www.vim.org/)
- [Fatih's vim-go plugin](https://github.com/fatih/vim-go), providing syntax highlight, gocode integration for autocompletion, and more.
- See the [vim-go](https://github.com/fatih/vim-go) README for more info on how you can easily enable additional included features.
- [GoCode Go completion engine](https://github.com/nsf/gocode)
- [Git](http://git-scm.com/)
- [Tig - text mode interface to git](http://jonas.nitro.dk/tig/)
- [gdb - the GNU debugger](http://www.gnu.org/software/gdb)
- [cgdb - Curses based user interface to gdb](https://cgdb.github.io)
## Optional ingredients
*Uncomment roles in playbook.yml to enable these.*
- [Valloric's YouCompleteMe](https://github.com/Valloric/YouCompleteMe) for as-you-type completion (NB: Requires uncommenting the YouCompleteMe role in playbook.yml!)).
- [Apache Mesos](http://mesos.apache.org) - An open source computer cluster manager. (UI on [localhost:5050](http://localhost:5050)).
## Prerequisites
- [Vagrant](https://www.vagrantup.com/)
- [Ansible](http://www.ansible.com/)
- [VirtualBox](https://www.virtualbox.org/) (Not required if you use Docker as provider!)
- [Docker](https://www.docker.com) (Not required if you use Virtualbox as provider!)
### Installing the requirements in Ubuntu (tested with 14.04)
1. Install Virtualbox:
```bash
sudo apt-get install virtualbox
```
2. Install Docker:
```bash
sudo apt-get install docker.io
```
3. Install a recent version of ansible:
```bash
sudo apt-get install ansible/trusty-backports
```
*(if you ubuntu version is "trusty", otherwise, replace it with your appropriate version)*
4. Install Vagrant, by first downloadng the proper .deb file from [vagrantup.com](https://www.vagrantup.com/downloads.html)
5. ... and then installing it with:
```bash
sudo dpkg -i
```
## Setup and Usage
#### Clone the github repository:
```bash
git clone [email protected]:samuell/devbox-golang
cd devbox-golang
```
#### Bring up the VM
With docker provider (Expect it to take at least ~8m):
```bash
vagrant up docker
```
With VirtualBox provider (Expect it to take at least ~20m):
```bash
vagrant up virtualbox
```
#### Log in to the VM
With docker provider:
```bash
vagrant ssh docker
```
With VirtualBox provider:
```bash
vagrant ssh virtualbox
```
#### Create a repository for uploading to github:
```bash
mkcd ~/code/go/src/github//
git init .
```
#### Now, start coding!
```bash
vim main.go
```
#### A tip on how you can upload your existing git ssh keys to the new vm:
With the following command you can get the info you need to run scp
against the machine:
```bash
vagrant ssh-config [docker | virtualbox]
```
Note the hostname and port number (and identity file, if you with),
and run, for example:
```bash
scp -i -P \
~/.ssh/id_rsa_ \
vagrant@:/home/vagrant/.ssh/
```
Then, sometimes, in order to get the new key activated in your shell
after logging in to the vm, you might need to do:
```bash
ssh-agent bash -l
ssh-add ~/.ssh/id_rsa_
```
- Autocompletion will happen automatically
- If you have turned off the YouCompleteMe role, you will get autocompletion with ``
## Known issues
- GDB Breakpoints don't take, unless you follow the advice given [here](https://github.com/docker/docker/issues/7276#issuecomment-50436671).
That is, in short, do this on your **Host machine**, if you run Ubuntu:
```bash
sudo apt-get install apparmor-utils
sudo echo 'aa-complain /etc/apparmor.d/docker' >> /etc/rc.local
sudo aa-complain /etc/apparmor.d/docker
```
The problem seems to be that `ptrace` is not given access to the process otherwise.
- There are some really red message from the docker daemon when running `vagrant halt`.
Everything seems to work as expected though (including the shutdown)
- There are some red message on vagrant up, but they are nothing serious, and can be ignored for now.
- When building Go 1.5 dev, the build will end with a lot of error messages, but that is from the
tests after the build. The build itself seems to work, largely.
## References
- [Vagrant & Ansible Quickstart Tutorial](http://adamcod.es/2014/09/23/vagrant-ansible-quickstart-tutorial.html)