Fix doc build warnings
[dcaegen2.git] / platformdoc / DCAE-DEPLOYMENT-GUIDE-1707.md
1 ### DCAE Controller - Deployment Guide 1707\r
2 \r
3 #### 1) Download latest deployer tar file to your cloudify bootstrap/cli server.\r
4 \r
5 Say, your working directory is ${WORKING-DIR}\r
6 ````\r
7 cd ${WORKING-DIR}\r
8 $ wget http://dockercentral.it.att.com:8093/nexus/repository/rawcentral/com.att.ecompcntr/opstools/dcae-deployer-5.0.tar\r
9 $ tar -xvf dcae-deployer-5.0.tar\r
10 $ cd ${WORKING-DIR}/dcae-deployer\r
11 ````\r
12 #### 2) Clone the auto generated inputs files from code cloud and save it in <inputDirectory>\r
13 ````\r
14 $ git clone ssh://<userid>@codecloud.web.att.com:7999/st_dcae/com.att.ecomp.dcae.operational.staging.ftl.git <inputsDirectory>\r
15 \r
16 ````\r
17 #### 3) Clone the latest consulAgent.sh \r
18 ````\r
19 $ git clone ssh://git@codecloud.web.att.com:7999/st_ecompcntr/platform_installation.git\r
20 NOTE: consulAgent.sh will be inside ec-deployer-v2.5.1/ec-deployer/bin\r
21 ````\r
22 #### 4) Update app-inputs.conf with user defined values\r
23 ````\r
24 $ cd ${WORKING-DIR}/dcae-deployer/conf\r
25 $ vi app-inputs.conf\r
26  \r
27  -- Update the following values -\r
28           * CLOUDIFY_INPUT=<complete path to the auto generated inputs.json for cloudify ( downloaded in inputsDirectory from Step 2 )>\r
29              e.g. /home/attcloud/dcae/dcae-deployer/testing/1710-FTL3/cloudify-gen/inputs/bootstrap/bootstrap/rdm5adcc1/inputs.json\r
30           * CONSUL_INPUT=<complete path to the auto generated inputs.json for consul ( downloaded in inputsDirectory from Step 2 )>\r
31              e.g. /home/attcloud/dcae/dcae-deployer/testing/1710-FTL3/cloudify-gen/inputs/consul/consul/rdm5adcc1/inputs.json\r
32           * CONSUL_BLUEPRINT=<complete path to the zip for consul on dockercentral>\r
33                - git clone ssh://git@codecloud.web.att.com:7999/st_ecompcntr/blueprints.git\r
34               e.g. /home/attcloud/blueprints/serviceConfigRegistry/blueprint/consul.yaml\r
35               Note: consul.yaml will be inside blueprints/serviceConfigRegistry/blueprint\r
36           * OPENSTACK_KEYFILE=<complete path the pem file used for bootstraping>\r
37               e.g. '/home/attcloud/dcae-m82823u.pem'\r
38           * OPENSTACK_KEY=<name of the keypair used in openstack>\r
39               e.g. 'dcae-m82823'\r
40           * CLOUDIFY_USERNAME=<Username for Cloudify>\r
41           * CLOUDIFY_PASSWORD=<Password for Cloudify>\r
42           * CONSUL_AGENT=<complete path to the extracted consulAgent.sh from Step 3>\r
43               e.g. /home/attcloud/dcae/dcae-deployer/bin/install/bin/consulAgent.sh\r
44           * LOCATION=<put the value of location_id from consul inputs.json file( downloaded in inputsDirectory from Step 2 )>     \r
45          \r
46 Save the file and exit!!\r
47 ````\r
48 #### 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
49 ````\r
50 #####  Option-1: Just bootstrapping cloudify manager on new VM\r
51        Note: This will instantiate a new VM and will bootstrap it with cloudify 3.4.0\r
52        $ ./deploy.sh --action bootstrap\r
53 ````\r
54 ````\r
55 ##### Option-2: Bootstrap cloudify manager on existing centOS VM\r
56           Note : This will bootstrap the provide IP-ADDRESS with the cloudify 3.4.0 \r
57       $ ./deploy.sh --action bootstrap --cloudify-ip <IP-ADDRESS>\r
58 ````\r
59 ````\r
60 ##### Option-3: Teardown cloudify manager\r
61       Note: This will tear down the cloudify from the provided IP-ADDRESS but will not remove the VM\r
62       $ ./deploy.sh --action teardown --cloudify-ip <IP-ADDRESS>\r
63 ````\r
64 ````\r
65 ##### Option-4: Deploy consul\r
66       Note: This will deploy the consul on provided IP-ADDRESS and will instantiate 3 new VMs\r
67           $ ./deploy.sh --action deploy --cloudify-ip <IP-ADDRESS> --component consul\r
68 ````\r
69 ````\r
70 ##### Option-5: Undeploy consul\r
71       Note : This will undeploy the consul from the provide IP-ADDRESS and will remove the 3 VMs\r
72       $ ./deploy.sh --action undeploy --cloudify-ip <IP-ADDRESS> --component consul\r
73 ````