Merge "Update cloud image Ubuntu18.04 mininet ovs"
[releng/builder.git] / packer / README.markdown
index f02ace5e9ec2db3ad5ce29b68e66bc719c3e57f0..da99a245788dfebf7bc9d4071cfb314983d5e844 100644 (file)
@@ -9,30 +9,29 @@ We build OpenDaylight's CI images via Packer.
 
 You'll need to [install Packer][2], of course.
 
-OpenDaylight's Packer configuration is divided into build-specific variables,
-output-specific templates and a set of shared provisioning scripts. To do a
+OpenDaylight's Packer configuration separates build-specific variables,
+output-specific templates, and a set of shared provisioning scripts. To do a
 specific build, combine the template for the desired output artifact type with
-a variable file. To build a new java-builder instance the following would be done:
+a variable file. To build a new java-builder instance run this command:
 
 ```
 packer build -var-file=vars/cloud-env.json -var-file=vars/centos.json templates/java-builder.json
 ```
 
 **NOTE:** vars/cloud-env.json is a gitignored file as it contains private
-information. There is a vars/cloud-env.json.example file that may be used as a
-base for creating the one needed.
+information. The vars/cloud-env.json.example file is available as an example.
 
 This would build bootable image in two different OpenStack clouds. In specific,
 Rackspace's Public cloud and a private OpenStack cloud.
 
 From a high level, the builds:
 
-* Boot a specified base image in both clouds.
-* Run a set of shell scripts, listed in the template's shell provisioner
-  section, to do any configuration required by the builder.
-* Execute a shutdown of the running instance in the clouds.
-* Execute a 'nova image-create' operation against the shutdown instance.
-* Perform a 'nova delete' operation against the shutdown instance.
+-   Boot a specified base image in both clouds.
+-   Run a set of shell scripts, listed in the template's shell provisioner
+    section, to do any configuration required by the builder.
+-   Execute a shutdown of the running instance in the clouds.
+-   Execute a 'nova image-create' operation against the shutdown instance.
+-   Perform a 'nova delete' operation against the shutdown instance.
 
 [1]: https://www.packer.io/
 [2]: https://www.packer.io/intro/getting-started/setup.html