openstack/kuryr
Code Issues Proposed changes
24eb1458dd
kuryr/contrib/vagrant/README.md
Kyle Mestery d45a1cfb30 README.md: Cleanup documentation 
Some things have changed since this was written, namely that kuryr itself
is started as part of devstack and the kuryr subnetpool is created. Also,
the instructions for using user_local.conf to add another Neutron plugin
need some updating.

Change-Id: I5f9a7ee1fff2607f5fbf2117e34ad4bc9b095b1f
Signed-off-by: Kyle Mestery <mestery@mestery.com>
2016-04-18 14:15:03 -05:00

2.3 KiB
Raw Blame History

vagrant-devstack-Kuryr

Getting started

A Vagrant based kuryr,neutron,keystone and experimental docker system.

Steps to try vagrant image:

  1. Install Vagrant on your local machine. Install one of the current providers supported: VirtualBox, Libvirt or Vagrant
  2. Git clone Kuryr repository.
  3. Run cd kuryr/contrib/vagrant
  4. Run vagrant up It will take around 10 mins.
  5. vagrant ssh You will get a VM with everything running. You will get vm shell with keystone and neutron already running.

At this point you should have experimental docker, kuryr, neutron, keystone all up, running and pointing to each other. Any docker network related commands can be tried now as explained in [1].

References:

[1] https://github.com/openstack/kuryr/blob/master/doc/source/devref/libnetwork_remote_driver_design.rst#L64

Vagrant Options available

You can set the following environment variables before running vagrant up to modify the definition of the Virtual Machine spawned:

  • VAGRANT_KURYR_VM_BOX: To change the Vagrant Box used. Should be available in atlas.

    export VAGRANT_KURYR_VM_BOX=centos/7

    Could be an example of a rpm-based option.

  • VAGRANT_KURYR_VM_MEMORY: To modify the RAM of the VM. Defaulted to: 4096

  • VAGRANT_KURYR_VM_CPU: To modify the cpus of the VM. Defaulted to: 2

  • VAGRANT_KURYR_RUN_DEVSTACK: Whether vagrant up should run devstack to have an environment ready to use. Set it to 'false' if you want to edit local.conf before run ./stack.sh manually in the VM. Defaulted to: true. See below for additional options for editing local.conf.

Additional devstack configuration

To add additional configuration to local.conf before the VM is provisioned, you can create a file called "user_local.conf" in the contrib/vagrant directory of networking-kuryr. This file will be appended to the "local.conf" created during the Vagrant provisioning.

For example, to use OVN as the Neutron plugin with Kuryr, you can create a "user_local.conf" with the following configuration:

enable_plugin networking-ovn http://git.openstack.org/openstack/networking-ovn
enable_service ovn-northd
enable_service ovn-controller
disable_service q-agt
disable_service q-l3