Update README file with detail packer instructions

[infra/tools.git] / infra / jenkins / slave-setup / cloud-infra / README.md

diff --git a/infra/jenkins/slave-setup/cloud-infra/README.md b/infra/jenkins/slave-setup/cloud-infra/README.md
index 869c1d42fd53d6f68a14188f9676579b77adf340..21dfb33af1ffaac25ce6e250547f0e2c29017065 100644 (file)
--- a/infra/jenkins/slave-setup/cloud-infra/README.md
+++ b/infra/jenkins/slave-setup/cloud-infra/README.md
@@ -1,3 +1,4 @@
+## Description
 The packer file and corresponding script in this folder are used
 for building OpenStack images to be used for Cloud Infra jobs on
 Nordix Jenkins.
@@ -9,6 +10,13 @@ to be created. The actual script that is executed by packer on
 provisioned temporary instances should work on any Ubuntu1804
 regardless of cloud and region.
 
+## Steps To Run
+ 1. Source OpenStack RC file `source <openstack-rc-file.sh>` that points to **"cicd"** project in Frankfurt region. This will set up environment variables used by packer e.g. OS_USERNAME, OS_PASSWORD and OS_AUTH_URL.
+ 2. Run `packer build <packerfile.json>`
+
+This will build `cloud-infra-base-ubuntu1804` private image on the **"cicd"** project in Frankfurt region.
+## Note
+### Image public key handling
 A final note is that the file authorized_keys.packer is used for
 injecting user keys into image during cloud-init phase for ssh
 access to the slaves for troubleshooting. If you want to have