Updates vagrant README

The vagrant-devstack-Kuryr-Kubernetes 'Vagrant Options available' in
the README stated that the default VAGRANT_KURYR_VM_MEMORY is 4096,
this change updates it to 6144. And mentions that for a lighter
devstack installation ovn and ovn-octavia driver can be used.
This change also updates the url for atlas.

Change-Id: Idb20cc2c89043a2aaf13335aec44acced283baf4
Closes-Bug: 1901558
This commit is contained in:
Tabitha 2020-10-27 14:42:10 +01:00
parent 0b021592c3
commit c2817aeb41
1 changed files with 17 additions and 12 deletions

View File

@ -14,18 +14,18 @@ Steps to try vagrant image:
3. Run `cd kuryr-kubernetes/contrib/vagrant` 3. Run `cd kuryr-kubernetes/contrib/vagrant`
4. Run `vagrant up` 4. Run `vagrant up`
It will take from 10 to 60 minutes, depending on your internet speed. It will take from 10 to 60 minutes, depending on your internet speed.
Vagrant-cachier can speed up the process [2]. Vagrant-cachier can speed up the process [1].
5. `vagrant ssh` 5. `vagrant ssh`
At this point you should have experimental kubernetes (etcdv3, k8s-apiserver, At this point you should have experimental kubernetes (etcdv3, k8s-apiserver,
k8s-controller-manager, k8s-scheduler, kubelet and kuryr-controller), docker, k8s-controller-manager, k8s-scheduler, kubelet and kuryr-controller), docker,
kuryr, neutron, keystone all up, running and pointing to each other. Pods and kuryr, neutron, keystone, placement, nova, octavia all up, running and pointing
services orchestrated by kubernetes will be backed by kuryr+neutron. The to each other. Pods and services orchestrated by kubernetes will be backed by
architecture of the setup can be seen at [1]. kuryr+neutron and Octavia. The architecture of the setup can be seen at [2].
References: References:
[1] https://docs.openstack.org/developer/kuryr-kubernetes/devref/kuryr_kubernetes_design.html [1] http://fgrehm.viewdocs.io/vagrant-cachier/
[2] http://fgrehm.viewdocs.io/vagrant-cachier/ [2] https://docs.openstack.org/developer/kuryr-kubernetes/devref/kuryr_kubernetes_design.html
Vagrant Options available Vagrant Options available
------------------------- -------------------------
@ -34,23 +34,28 @@ You can set the following environment variables before running `vagrant up` to m
the definition of the Virtual Machine spawned: the definition of the Virtual Machine spawned:
* **VAGRANT\_KURYR\_VM\_BOX**: To change the Vagrant Box used. Should be available in * **VAGRANT\_KURYR\_VM\_BOX**: To change the Vagrant Box used. Should be available in
[atlas](http://atlas.hashicorp.com). [atlas](https://app.vagrantup.com/).
export VAGRANT_KURYR_VM_BOX=centos/7 export VAGRANT_KURYR_VM_BOX=centos/7
Could be an example of a rpm-based option. 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\_MEMORY**: To modify the RAM of the VM. Defaulted to: 6144.
If you configure your local.conf to use Octavia, you should increase the If you mean to create multiple Kubernetes services on the setup and the Octavia
setting to at least 12288. driver used is Amphora, you should increase this setting.
* **VAGRANT\_KURYR\_VM\_CPU**: To modify the cpus of the VM. Defaulted to: 2. * **VAGRANT\_KURYR\_VM\_CPU**: To modify the cpus of the VM. Defaulted to: 2.
If you configure your local.conf to use Octavia, you should increate this
setting to at least 4.
* **VAGRANT\_KURYR\_RUN\_DEVSTACK**: Whether `vagrant up` should run devstack to * **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 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. `local.conf` before run ./stack.sh manually in the VM. Defaulted to: true.
See below for additional options for editing local.conf. See below for additional options for editing local.conf.
For a lighter devstack installation, you can use the "local.conf"[1] that uses ovn
and ovn-octavia, no VM will be created for each load-balancer as is done by the
default Octavia provider (Amphora).
References:
[1] https://github.com/openstack/kuryr-kubernetes/blob/master/devstack/local.conf.ovn.sample
Additional devstack configuration Additional devstack configuration
--------------------------------- ---------------------------------