Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mborne/vagrantbox
[DEV] Vagrant helper to create some local VM to play with distributed systems like K3S.
https://github.com/mborne/vagrantbox
ansible dev k3s-cluster vagrant
Last synced: 2 months ago
JSON representation
[DEV] Vagrant helper to create some local VM to play with distributed systems like K3S.
- Host: GitHub
- URL: https://github.com/mborne/vagrantbox
- Owner: mborne
- License: mit
- Created: 2022-06-21T08:00:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T04:39:08.000Z (7 months ago)
- Last Synced: 2024-05-23T05:34:53.587Z (7 months ago)
- Topics: ansible, dev, k3s-cluster, vagrant
- Homepage:
- Size: 330 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vagrantbox
Create some virtual machines with [Vagrant](https://developer.hashicorp.com/vagrant) and [Ansible](https://docs.ansible.com/).
## Motivation
This repository aims at providing a playground :
* To install distributed systems like [K3S](https://github.com/mborne/k3s-deploy#k3s-deploy)
* To illustre the use of Vagrant and Ansible in [mborne/cours-devops (French)](https://github.com/mborne/cours-devops#readme)
## Requirements
* [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or [KVM](https://github.com/mborne/toolbox/tree/master/kvm#readme)
* [Vagrant](https://developer.hashicorp.com/vagrant/install)
* [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html#installing-ansible-on-ubuntu) if you want to use helper playbooks
* Optional (http proxy) : `vagrant plugin install vagrant-proxyconf` to forward `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY`.
## Parameters
See supported env vars in [Vagrantfile](Vagrantfile) :
| Name | Description | Default value |
| ---------------------- | ----------------------------------------------------------------------- | ------------------ |
| `VAGRANTBOX_BOX` | Base image from [Vagrant Cloud](https://app.vagrantup.com/boxes/search) | `"ubuntu/jammy64"` |
| `VAGRANTBOX_NUM_NODES` | Number of VM | `4` |
| `VAGRANTBOX_NETWORK` | Network for VM | `"192.168.50"` |
| `VAGRANTBOX_MEMORY` | VM memory in Mo | `"2048"` |
## Usage
### Vagrant
| Description | Command |
| ------------------------- | ----------------------------------------------------------------- |
| Start VMs with VirtualBox | `vagrant up` |
| Start VMs with KVM | `VAGRANTBOX_BOX=generic/ubuntu2204 vagrant up --provider=libvirt` |
| Check VM status | `vagrant status` |
| Open a terminal in a VM | `vagrant ssh vagrantbox-1` |
| Destroy VMs | `vagrant destroy -f` |
> see also [gist.github.com - wpscholar/vagrant-cheat-sheet.md](https://gist.github.com/wpscholar/a49594e2e2b918f4d0c4#file-vagrant-cheat-sheet-md)
### Ansible
The following playbooks are available to configure guest and VMs :
| Name | Description |
| ------------------------------------------------------------ | ---------------------------------------------------------------- |
| [playbooks/quickstart.yml](playbooks/quickstart.yml) | Apply the following playbooks |
| [playbooks/configure-vm.yml](playbooks/configure-vm.yml) | Add `~/.ssh/id_rsa.pub` and fill `/etc/hosts` on each VM |
| [playbooks/clear-ssh.yml](playbooks/clear-ssh.yml) | Update `~/.ssh/known_hosts` with SSH keys for the vagrantbox VMs |
| [playbooks/upgrade.yml](playbooks/upgrade.yml) | Upgrade system package (`apt-get update && apt-get upgrade -y`) |
| [playbooks/configure-host.yml](playbooks/configure-host.yml) | Fill `/etc/hosts` on VM's host (**optional**, see bellow) |
You may use [playbooks/quickstart.yml](playbooks/quick-start.yml) as follow :
```bash
# /etc/hosts edition requires sudo
ansible-playbook -i inventory playbooks/quickstart.yml --ask-become-pass
# To avoid sudo requirement, disable changes on /etc/hosts :
ansible-playbook -i inventory playbooks/quickstart.yml -e configure_host_enabled=false
# With KVM and generic/ubuntu2204 :
ansible-playbook -i inventory playbooks/quickstart.yml -e vagrant_provider=libvirt -e ansible_ssh_pass=vagrant --ask-become-pass
```
You should see something like this :
[](https://asciinema.org/a/664079)
## License
[MIT](LICENSE)
## Ressources
* [Using vagrantbox on windows](docs/windows.md)