Merge "Make distribution-check job an ODL-releng templated job"
[releng/builder.git] / vagrant / README.md
1 The purpose of these various directories is to have Vagrant definitions
2 that are then snapshotted for use as slaves in the OpenDaylight and
3 ODLForge environments.
4
5 If building up in a Rackspace environment using this for the first time
6 there is a particular order that should be taken to produce a finalized
7 image.
8
9 1. Bring a vagrant image up using the rackspace-convert-base definition.
10    This will prepare a basic Rackspace image to operate properly when
11    being managed by vagrant. It is purposely very limited in what it
12    does.
13
14 2. After the rackspace-convert-base image is up and you receive the
15    notice to snapshot the image perform a ```nova create-image```
16    against the running instance. Once the snapshot is complete you may
17    destroy the currently running vagrant image (it's easiest if the
18    create-image is done with --poll so you know when it's complete)
19
20 3. Bring up one of the various other vagrant images passing
21    ```RSIMAGE=${a_vagrant_image_id}``` where ```$a_vagrant_image_id```
22    is the imageID that was generated after the snapshotting operation in
23    step 2. You probably also want to execute using ```RSRESEAL=true` to
24    have the brought up image resealed for cloning purposes.
25
26 4. If you executed with ```RSRESEAL=true``` now is the time to take the
27    snapshot of the current running vagrant. See step 2
28
29 5. The final step in preparing an image for use in the Linux Foundation
30    managed environments to then take the image produced in step 4 and
31    run the ```lf-networking``` vagrant definition using it. See the
32    README.md in that vagrant folder for the required extra environment
33    variables.
34
35 6. Snapshot the new vagrant, see step 2 for details.
36
37 At this point a new Rackspace image will be ready for a given network
38 configuration. If you, the reader, are looking to utilize any of this
39 for your own Rackspace managed environment, or standard Vagrant then
40 step 5 & 6 will likely not be needed as they are specific to how the
41 Linux Foundation manages the Jenkins environment for OpenDaylight.