heat/vLB/base_vlb.yaml

   1 ##########################################################################
   2 #
   3 #==================LICENSE_START==========================================
   4 #
   5 #
   6 # Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
   7 #
   8 # Licensed under the Apache License, Version 2.0 (the "License");
   9 # you may not use this file except in compliance with the License.
  10 # You may obtain a copy of the License at
  11 #        http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19 #==================LICENSE_END============================================
  20 #
  21 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22 #
  23 ##########################################################################
  24
  25 heat_template_version: 2013-05-23
  26
  27 description: Heat template to deploy vLoadBalancer/vDNS demo app for ONAP
  28
  29 ##############
  30 #            #
  31 # PARAMETERS #
  32 #            #
  33 ##############
  34
  35 parameters:
  36   vlb_image_name:
  37     type: string
  38     label: Image name or ID
  39     description: Image to be used for compute instance
  40   vlb_flavor_name:
  41     type: string
  42     label: Flavor
  43     description: Type of instance (flavor) to be used
  44   public_net_id:
  45     type: string
  46     label: Public network name or ID
  47     description: Public network that enables remote connection to VNF
  48   vlb_private_net_id:
  49     type: string
  50     label: vLoadBalancer private network name or ID
  51     description: Private network that connects vLoadBalancer with vDNSs
  52   pktgen_private_net_id:
  53     type: string
  54     label: vPacketGen private network name or ID
  55     description: Private network that connects vLoadBalancer with vPacketGen
  56   onap_private_net_id:
  57     type: string
  58     label: ECOMP management network name or ID
  59     description: Private network that connects ONAP component and the VNF
  60   onap_private_subnet_id:
  61     type: string
  62     label: ECOMP management sub-network name or ID
  63     description: Private sub-network that connects ONAP component and the VNF
  64   vlb_private_net_cidr:
  65     type: string
  66     label: vLoadBalancer private network CIDR
  67     description: The CIDR of the vLoadBalancer private network
  68   pktgen_private_net_cidr:
  69     type: string
  70     label: vPacketGen private network CIDR
  71     description: The CIDR of the vPacketGen private network
  72   onap_private_net_cidr:
  73     type: string
  74     label: ONAP private network CIDR
  75     description: The CIDR of the protected private network
  76   vlb_private_ip_0:
  77     type: string
  78     label: vLoadBalancer private IP address towards the private network
  79     description: Private IP address that is assigned to the vLoadBalancer to communicate with the vDNSs
  80   vlb_private_ip_1:
  81     type: string
  82     label: vLoadBalancer private IP address towards the ONAP management network
  83     description: Private IP address that is assigned to the vLoadBalancer to communicate with ONAP components
  84   vlb_private_ip_2:
  85     type: string
  86     label: vLoadBalancer private IP address towards the vPacketGen network
  87     description: Private IP address that is assigned to the vLoadBalancer to communicate with vPacketGen
  88   vdns_private_ip_0:
  89     type: string
  90     label: vDNS private IP address towards the private network
  91     description: Private IP address that is assigned to the vDNS to communicate with the vLoadBalancer
  92   vdns_private_ip_1:
  93     type: string
  94     label: vDNS private IP address towards the ONAP management network
  95     description: Private IP address that is assigned to the vDNS to communicate with ONAP components
  96   vpg_private_ip_0:
  97     type: string
  98     label: vPacketGen private IP address towards the vPacketGen private network
  99     description: Private IP address that is assigned to the vPacketGen to communicate with the vLoadBalancer
 100   vpg_private_ip_1:
 101     type: string
 102     label: vPacketGen private IP address towards the ONAP management network
 103     description: Private IP address that is assigned to the vPacketGen to communicate with ONAP components
 104   vip:
 105     type: string
 106     label: Virtual Private IP of the vLoadBalancer
 107     description: Virtual Private IP that is assigned to the vLoadBalancer's VPP layer
 108   gre_ipaddr:
 109     type: string
 110     label: IP Address of the GRE tunnel
 111     description: IP address assigned to the GRE tunnel on the vLoadBalancer
 112   pg_int:
 113     type: string
 114     label: IP Address of the output vPacketGen interface
 115     description: IP address assigned to the output interface of the vPacketGen's VPP layer
 116   vlb_name_0:
 117     type: string
 118     label: vLoadBalancer name
 119     description: Name of the vLoadBalancer
 120   vdns_name_0:
 121     type: string
 122     label: vDNS name
 123     description: Name of the vDNS
 124   vpg_name_0:
 125     type: string
 126     label: vPKTGEN name
 127     description: Name of the vPKTGEN
 128   vnf_id:
 129     type: string
 130     label: VNF ID
 131     description: The VNF ID is provided by ONAP
 132   vf_module_id:
 133     type: string
 134     label: vFirewall module ID
 135     description: The vLoadBalancer Module ID is provided by ONAP
 136   dcae_collector_ip:
 137     type: string
 138     label: DCAE collector IP address
 139     description: IP address of the DCAE collector
 140   dcae_collector_port:
 141     type: string
 142     label: DCAE collector port
 143     description: Port of the DCAE collector
 144   key_name:
 145     type: string
 146     label: Key pair name
 147     description: Public/Private key pair name
 148   pub_key:
 149     type: string
 150     label: Public key
 151     description: Public key to be installed on the compute instance
 152   repo_url_artifacts:
 153     type: string
 154     label: Repository URL
 155     description: URL of the repository that hosts the demo packages
 156   demo_artifacts_version:
 157     type: string
 158     label: Artifacts version used in demo vnfs
 159     description: Artifacts (jar, tar.gz) version used in demo vnfs
 160   nexus_artifact_repo:
 161     type: string
 162     description: Root URL for the Nexus repository for Maven artifacts.
 163     default: "https://nexus.onap.org"
 164   install_script_version:
 165     type: string
 166     label: Installation script version number
 167     description: Version number of the scripts that install the vFW demo app
 168   cloud_env:
 169     type: string
 170     label: Cloud environment
 171     description: Cloud environment (e.g., openstack, rackspace)
 172   sec_group:
 173     type: string
 174     description: ONAP Security Group
 175
 176
 177 #############
 178 #           #
 179 # RESOURCES #
 180 #           #
 181 #############
 182
 183 resources:
 184
 185   random-str:
 186     type: OS::Heat::RandomString
 187     properties:
 188       length: 4
 189
 190   my_keypair:
 191     type: OS::Nova::KeyPair
 192     properties:
 193       name:
 194         str_replace:
 195           template: base_rand
 196           params:
 197             base: { get_param: key_name }
 198             rand: { get_resource: random-str }
 199       public_key: { get_param: pub_key }
 200       save_private_key: false
 201
 202   vlb_private_network:
 203     type: OS::Neutron::Net
 204     properties:
 205       name: { get_param: vlb_private_net_id }
 206
 207   vlb_private_subnet:
 208     type: OS::Neutron::Subnet
 209     properties:
 210       name: { get_param: vlb_private_net_id }
 211       network_id: { get_resource: vlb_private_network }
 212       cidr: { get_param: vlb_private_net_cidr }
 213
 214   pktgen_private_network:
 215     type: OS::Neutron::Net
 216     properties:
 217       name: { get_param: pktgen_private_net_id }
 218
 219   pktgen_private_subnet:
 220     type: OS::Neutron::Subnet
 221     properties:
 222       name: { get_param: pktgen_private_net_id }
 223       network_id: { get_resource: pktgen_private_network }
 224       cidr: { get_param: pktgen_private_net_cidr }
 225
 226   vlb_private_0_port:
 227     type: OS::Neutron::Port
 228     properties:
 229       network: { get_resource: vlb_private_network }
 230       fixed_ips: [{"subnet": { get_resource: vlb_private_subnet }, "ip_address": { get_param: vlb_private_ip_0 }}]
 231       security_groups:
 232       - { get_param: sec_group }
 233
 234
 235   vlb_private_1_port:
 236     type: OS::Neutron::Port
 237     properties:
 238       network: { get_param: onap_private_net_id }
 239       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vlb_private_ip_1 }}]
 240       security_groups:
 241       - { get_param: sec_group }
 242
 243   vlb_private_2_port:
 244     type: OS::Neutron::Port
 245     properties:
 246       network: { get_resource: pktgen_private_network }
 247       fixed_ips: [{"subnet": { get_resource: pktgen_private_subnet }, "ip_address": { get_param: vlb_private_ip_2 }}]
 248       security_groups:
 249       - { get_param: sec_group }
 250
 251   vlb_0:
 252     type: OS::Nova::Server
 253     properties:
 254       image: { get_param: vlb_image_name }
 255       flavor: { get_param: vlb_flavor_name }
 256       name: { get_param: vlb_name_0 }
 257       key_name: { get_resource: my_keypair }
 258       networks:
 259         - network: { get_param: public_net_id }
 260         - port: { get_resource: vlb_private_0_port }
 261         - port: { get_resource: vlb_private_1_port }
 262         - port: { get_resource: vlb_private_2_port }
 263       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 264       user_data_format: RAW
 265       user_data:
 266         str_replace:
 267           params:
 268             __dcae_collector_ip__: { get_param: dcae_collector_ip }
 269             __dcae_collector_port__: { get_param: dcae_collector_port }
 270             __ip_to_dns_net__: { get_param: vlb_private_ip_0 }
 271             __ip_to_pktgen_net__: { get_param: vlb_private_ip_2 }
 272             __vip__: { get_param: vip }
 273             __gre_ipaddr__: { get_param: gre_ipaddr }
 274             __pktgen_ipaddr__: { get_param: vpg_private_ip_0 }
 275             __oam_private_ipaddr__: { get_param: vlb_private_ip_1 }
 276             __repo_url_artifacts__: { get_param: repo_url_artifacts }
 277             __demo_artifacts_version__: { get_param: demo_artifacts_version }
 278             __install_script_version__: { get_param: install_script_version }
 279             __vlb_private_net_cidr__: { get_param: vlb_private_net_cidr }
 280             __onap_private_net_cidr__: { get_param: onap_private_net_cidr }
 281             __pktgen_private_net_cidr__: { get_param: pktgen_private_net_cidr }
 282             __pktgen_mac__: { get_attr: [vpg_private_0_port, mac_address] }
 283             __cloud_env__: { get_param: cloud_env }
 284             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 285           template: |
 286             #!/bin/bash
 287
 288             # Create configuration files
 289             mkdir /opt/config
 290             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 291             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 292             echo "__ip_to_dns_net__" > /opt/config/ip_to_dns_net.txt
 293             echo "__ip_to_pktgen_net__" > /opt/config/ip_to_pktgen_net.txt
 294             echo "__vip__" > /opt/config/vip.txt
 295             echo "__gre_ipaddr__" > /opt/config/gre_ipaddr.txt
 296             echo "__pktgen_ipaddr__" > /opt/config/pktgen_ipaddr.txt
 297             echo "__oam_private_ipaddr__" > /opt/config/oam_private_ipaddr.txt
 298             echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
 299             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 300             echo "__install_script_version__" > /opt/config/install_script_version.txt
 301             echo "__vlb_private_net_cidr__" > /opt/config/vlb_private_net_cidr.txt
 302             echo "__pktgen_private_net_cidr__" > /opt/config/pktgen_private_net_cidr.txt
 303             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 304             echo "__pktgen_mac__" > /opt/config/pktgen_mac.txt
 305             echo "__cloud_env__" > /opt/config/cloud_env.txt
 306             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 307
 308             # Download and run install script
 309             apt-get -y install unzip
 310             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 311             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vlb&a=vlb-scripts&e=zip&v=__install_script_version__" -o /opt/vlb-scripts-__install_script_version__.zip
 312             unzip -j /opt/vlb-scripts-__install_script_version__.zip -d /opt v_lb_install.sh
 313             cd /opt
 314             chmod +x v_lb_install.sh
 315             ./v_lb_install.sh
 316
 317
 318   vdns_private_0_port:
 319     type: OS::Neutron::Port
 320     properties:
 321       network: { get_resource: vlb_private_network }
 322       fixed_ips: [{"subnet": { get_resource: vlb_private_subnet }, "ip_address": { get_param: vdns_private_ip_0 }}]
 323       security_groups:
 324       - { get_param: sec_group }
 325
 326   vdns_private_1_port:
 327     type: OS::Neutron::Port
 328     properties:
 329       network: { get_param: onap_private_net_id }
 330       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vdns_private_ip_1 }}]
 331       security_groups:
 332       - { get_param: sec_group }
 333
 334
 335   vdns_0:
 336     type: OS::Nova::Server
 337     properties:
 338       image: { get_param: vlb_image_name }
 339       flavor: { get_param: vlb_flavor_name }
 340       name: { get_param: vdns_name_0 }
 341       key_name: { get_resource: my_keypair }
 342       networks:
 343         - network: { get_param: public_net_id }
 344         - port: { get_resource: vdns_private_0_port }
 345         - port: { get_resource: vdns_private_1_port }
 346       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 347       user_data_format: RAW
 348       user_data:
 349         str_replace:
 350           params:
 351             __lb_oam_int__: { get_param: vlb_private_ip_1 }
 352             __lb_private_ipaddr__: { get_param: vlb_private_ip_0 }
 353             __local_private_ipaddr__: { get_param: vdns_private_ip_0 }
 354             __oam_private_ipaddr__: { get_param: vdns_private_ip_1 }
 355             __repo_url_artifacts__: { get_param: repo_url_artifacts }
 356             __demo_artifacts_version__: { get_param: demo_artifacts_version }
 357             __install_script_version__: { get_param: install_script_version }
 358             __vlb_private_net_cidr__: { get_param: vlb_private_net_cidr }
 359             __onap_private_net_cidr__: { get_param: onap_private_net_cidr }
 360             __cloud_env__: { get_param: cloud_env }
 361             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 362           template: |
 363             #!/bin/bash
 364
 365             # Create configuration files
 366             mkdir /opt/config
 367             echo "__lb_oam_int__" > /opt/config/lb_oam_int.txt
 368             echo "__lb_private_ipaddr__" > /opt/config/lb_private_ipaddr.txt
 369             echo "__local_private_ipaddr__" > /opt/config/local_private_ipaddr.txt
 370             echo "__oam_private_ipaddr__" > /opt/config/oam_private_ipaddr.txt
 371             echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
 372             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 373             echo "__install_script_version__" > /opt/config/install_script_version.txt
 374             echo "__vlb_private_net_cidr__" > /opt/config/vlb_private_net_cidr.txt
 375             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 376             echo "__cloud_env__" > /opt/config/cloud_env.txt
 377             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 378
 379             # Download and run install script
 380             apt-get -y install unzip
 381             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 382             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vlb&a=vlb-scripts&e=zip&v=__install_script_version__" -o /opt/vlb-scripts-__install_script_version__.zip
 383             unzip -j /opt/vlb-scripts-__install_script_version__.zip -d /opt v_dns_install.sh
 384             cd /opt
 385             chmod +x v_dns_install.sh
 386             ./v_dns_install.sh
 387
 388
 389   vpg_private_0_port:
 390     type: OS::Neutron::Port
 391     properties:
 392       network: { get_resource: pktgen_private_network }
 393       fixed_ips: [{"subnet": { get_resource: pktgen_private_subnet }, "ip_address": { get_param: vpg_private_ip_0 }}]
 394       security_groups:
 395       - { get_param: sec_group }
 396
 397   vpg_private_1_port:
 398     type: OS::Neutron::Port
 399     properties:
 400       network: { get_param: onap_private_net_id }
 401       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vpg_private_ip_1 }}]
 402       security_groups:
 403       - { get_param: sec_group }
 404
 405   vpg_0:
 406     type: OS::Nova::Server
 407     properties:
 408       image: { get_param: vlb_image_name }
 409       flavor: { get_param: vlb_flavor_name }
 410       name: { get_param: vpg_name_0 }
 411       key_name: { get_resource: my_keypair }
 412       networks:
 413         - network: { get_param: public_net_id }
 414         - port: { get_resource: vpg_private_0_port }
 415         - port: { get_resource: vpg_private_1_port }
 416       user_data_format: RAW
 417       user_data:
 418         str_replace:
 419           params:
 420             __repo_url_artifacts__: { get_param: repo_url_artifacts }
 421             __local_private_ipaddr__: { get_param: vpg_private_ip_0 }
 422             __oam_private_ipaddr__: { get_param: vpg_private_ip_1 }
 423             __onap_private_net_cidr__: { get_param: onap_private_net_cidr }
 424             __pktgen_private_net_cidr__: { get_param: pktgen_private_net_cidr }
 425             __vlb_ipaddr__: { get_param: vlb_private_ip_2 }
 426             __demo_artifacts_version__: { get_param: demo_artifacts_version }
 427             __install_script_version__: { get_param: install_script_version }
 428             __pg_int__: { get_param: pg_int }
 429             __vlb_mac__: { get_attr: [vlb_private_2_port, mac_address] }
 430             __cloud_env__: { get_param: cloud_env }
 431             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 432           template: |
 433             #!/bin/bash
 434
 435             # Create configuration files
 436             mkdir /opt/config
 437             echo "__oam_private_ipaddr__" > /opt/config/oam_private_ipaddr.txt
 438             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 439             echo "__local_private_ipaddr__" > /opt/config/local_private_ipaddr.txt
 440             echo "__pktgen_private_net_cidr__" > /opt/config/pktgen_private_net_cidr.txt
 441             echo "__vlb_ipaddr__" > /opt/config/vlb_ipaddr.txt
 442             echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
 443             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 444             echo "__install_script_version__" > /opt/config/install_script_version.txt
 445             echo "__pg_int__" > /opt/config/pg_int.txt
 446             echo "__vlb_mac__" > /opt/config/vlb_mac.txt
 447             echo "__cloud_env__" > /opt/config/cloud_env.txt
 448             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 449
 450             # Download and run install script
 451             apt-get -y install unzip
 452             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 453             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vlb&a=vlb-scripts&e=zip&v=__install_script_version__" -o /opt/vlb-scripts-__install_script_version__.zip
 454             unzip -j /opt/vlb-scripts-__install_script_version__.zip -d /opt v_packetgen_install.sh
 455             cd /opt
 456             chmod +x v_packetgen_install.sh
 457             ./v_packetgen_install.sh