openstack/kayobe
Code Issues Proposed changes
f11c73ff03
kayobe/doc/source/contributor/vagrant.rst
Mark Goddard c9cc6f4064 docs: add variable for current branch 
This allows us to include the correct branch when cloning repositories
in documentation.

Method adapted from OpenStack Ansible documentation. A backslash is
added on purpose before repository URLs to bypass highlighting which
makes them less readable (dark text on dark background).

https://opendev.org/openstack/openstack-ansible/src/branch/master/doc/source/conf.py

Story: 2008851
Task: 42366
Change-Id: I4b4a8d1c848bb992f65860b058cb9fd9d77613d0
2021-06-09 14:01:13 +02:00

1.5 KiB
Raw Blame History

Vagrant

Kayobe provides a Vagrantfile that can be used to bring up a virtual machine for use as a development environment. The VM is based on the centos/8 CentOS 8 image, and supports the following providers:

  • VirtualBox
  • VMWare Fusion

The VM is configured with 4GB RAM and a 20GB HDD. It has a single private network in addition to the standard Vagrant NAT network.

Preparation

First, ensure that Vagrant is installed and correctly configured to use the required provider. Also install the following vagrant plugins:

vagrant plugin install vagrant-reload vagrant-disksize

If using the VirtualBox provider, install the following vagrant plugin:

vagrant plugin install vagrant-vbguest

Note: if using Ubuntu 16.04 LTS, you may be unable to install any plugins. To work around this install the upstream version from www.virtualbox.org.

Usage

Later sections in the development guide cover in more detail how to use the development VM in different configurations. These steps cover bringing up and accessing the VM.

Clone the kayobe repository:

Change the current directory to the kayobe repository:

cd kayobe

Inspect kayobe's Vagrantfile, noting the provisioning steps:

less Vagrantfile

Bring up a virtual machine:

vagrant up

Wait for the VM to boot, then SSH in:

vagrant ssh