Onboarding documentation update for CLI

[dcaegen2.git] / platformdoc / DCAE-DEPLOYMENT-GUIDE-1707.md

diff --git a/platformdoc/DCAE-DEPLOYMENT-GUIDE-1707.md b/platformdoc/DCAE-DEPLOYMENT-GUIDE-1707.md
new file mode 100644 (file)
index 0000000..415fb2b
--- /dev/null
+++ b/platformdoc/DCAE-DEPLOYMENT-GUIDE-1707.md
@@ -0,0 +1,73 @@
+### DCAE Controller - Deployment Guide 1707\r
+\r
+#### 1) Download latest deployer tar file to your cloudify bootstrap/cli server.\r
+\r
+Say, your working directory is ${WORKING-DIR}\r
+````\r
+cd ${WORKING-DIR}\r
+$ wget http://dockercentral.it.att.com:8093/nexus/repository/rawcentral/com.att.ecompcntr/opstools/dcae-deployer-5.0.tar\r
+$ tar -xvf dcae-deployer-5.0.tar\r
+$ cd ${WORKING-DIR}/dcae-deployer\r
+````\r
+#### 2) Clone the auto generated inputs files from code cloud and save it in <inputDirectory>\r
+````\r
+$ git clone ssh://<userid>@codecloud.web.att.com:7999/st_dcae/com.att.ecomp.dcae.operational.staging.ftl.git <inputsDirectory>\r
+\r
+````\r
+#### 3) Clone the latest consulAgent.sh \r
+````\r
+$ git clone ssh://git@codecloud.web.att.com:7999/st_ecompcntr/platform_installation.git\r
+NOTE: consulAgent.sh will be inside ec-deployer-v2.5.1/ec-deployer/bin\r
+````\r
+#### 4) Update app-inputs.conf with user defined values\r
+````\r
+$ cd ${WORKING-DIR}/dcae-deployer/conf\r
+$ vi app-inputs.conf\r
+ \r
+ -- Update the following values -\r
+         * CLOUDIFY_INPUT=<complete path to the auto generated inputs.json for cloudify ( downloaded in inputsDirectory from Step 2 )>\r
+            e.g. /home/attcloud/dcae/dcae-deployer/testing/1710-FTL3/cloudify-gen/inputs/bootstrap/bootstrap/rdm5adcc1/inputs.json\r
+         * CONSUL_INPUT=<complete path to the auto generated inputs.json for consul ( downloaded in inputsDirectory from Step 2 )>\r
+            e.g. /home/attcloud/dcae/dcae-deployer/testing/1710-FTL3/cloudify-gen/inputs/consul/consul/rdm5adcc1/inputs.json\r
+         * CONSUL_BLUEPRINT=<complete path to the zip for consul on dockercentral>\r
+              - git clone ssh://git@codecloud.web.att.com:7999/st_ecompcntr/blueprints.git\r
+             e.g. /home/attcloud/blueprints/serviceConfigRegistry/blueprint/consul.yaml\r
+             Note: consul.yaml will be inside blueprints/serviceConfigRegistry/blueprint\r
+         * OPENSTACK_KEYFILE=<complete path the pem file used for bootstraping>\r
+             e.g. '/home/attcloud/dcae-m82823u.pem'\r
+         * OPENSTACK_KEY=<name of the keypair used in openstack>\r
+             e.g. 'dcae-m82823'\r
+         * CLOUDIFY_USERNAME=<Username for Cloudify>\r
+         * CLOUDIFY_PASSWORD=<Password for Cloudify>\r
+         * CONSUL_AGENT=<complete path to the extracted consulAgent.sh from Step 3>\r
+             e.g. /home/attcloud/dcae/dcae-deployer/bin/install/bin/consulAgent.sh\r
+         * LOCATION=<put the value of location_id from consul inputs.json file( downloaded in inputsDirectory from Step 2 )>     \r
+        \r
+Save the file and exit!!\r
+````\r
+#### 3) Run the ./deploy.sh script for building entire environment. (This includes, spinning up cloudify manager VM, bootstrapping cloudify manager, and deploying consul blueprint)\r
+````\r
+#####  Option-1: Just bootstrapping cloudify manager on new VM\r
+       Note: This will instantiate a new VM and will bootstrap it with cloudify 3.4.0\r
+       $ ./deploy.sh --action bootstrap\r
+````\r
+````\r
+##### Option-2: Bootstrap cloudify manager on existing centOS VM\r
+         Note : This will bootstrap the provide IP-ADDRESS with the cloudify 3.4.0 \r
+      $ ./deploy.sh --action bootstrap --cloudify-ip <IP-ADDRESS>\r
+````\r
+````\r
+##### Option-3: Teardown cloudify manager\r
+      Note: This will tear down the cloudify from the provided IP-ADDRESS but will not remove the VM\r
+      $ ./deploy.sh --action teardown --cloudify-ip <IP-ADDRESS>\r
+````\r
+````\r
+##### Option-4: Deploy consul\r
+      Note: This will deploy the consul on provided IP-ADDRESS and will instantiate 3 new VMs\r
+         $ ./deploy.sh --action deploy --cloudify-ip <IP-ADDRESS> --component consul\r
+````\r
+````\r
+##### Option-5: Undeploy consul\r
+      Note : This will undeploy the consul from the provide IP-ADDRESS and will remove the 3 VMs\r
+      $ ./deploy.sh --action undeploy --cloudify-ip <IP-ADDRESS> --component consul\r
+````
\ No newline at end of file