heat/vFW/base_vfw.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 that deploys vFirewall demo app for ONAP
  28
  29 ##############
  30 #            #
  31 # PARAMETERS #
  32 #            #
  33 ##############
  34
  35 parameters:
  36   vfw_image_name:
  37     type: string
  38     label: Image name or ID
  39     description: Image to be used for compute instance
  40   vfw_flavor_name:
  41     type: string
  42     label: Flavor
  43     description: Type of instance (flavor) to be used
  44   vpg_image_name:
  45     type: string
  46     label: Image name or ID
  47     description: Image to be used for compute instance
  48   vpg_flavor_name:
  49     type: string
  50     label: Flavor
  51     description: Type of instance (flavor) to be used
  52   vsn_image_name:
  53     type: string
  54     label: Image name or ID
  55     description: Image to be used for compute instance
  56   vsn_flavor_name:
  57     type: string
  58     label: Flavor
  59     description: Type of instance (flavor) to be used
  60   public_net_id:
  61     type: string
  62     label: Public network name or ID
  63     description: Public network that enables remote connection to VNF
  64   unprotected_private_net_id:
  65     type: string
  66     label: Unprotected private network name or ID
  67     description: Private network that connects vPacketGenerator with vFirewall
  68   protected_private_net_id:
  69     type: string
  70     label: Protected private network name or ID
  71     description: Private network that connects vFirewall with vSink
  72   onap_private_net_id:
  73     type: string
  74     label: ONAP management network name or ID
  75     description: Private network that connects ONAP components and the VNF
  76   onap_private_subnet_id:
  77     type: string
  78     label: ONAP management sub-network name or ID
  79     description: Private sub-network that connects ONAP components and the VNF
  80   unprotected_private_net_cidr:
  81     type: string
  82     label: Unprotected private network CIDR
  83     description: The CIDR of the unprotected private network
  84   protected_private_net_cidr:
  85     type: string
  86     label: Protected private network CIDR
  87     description: The CIDR of the protected private network
  88   onap_private_net_cidr:
  89     type: string
  90     label: ONAP private network CIDR
  91     description: The CIDR of the protected private network
  92   vfw_int_unprotected_private_ip_0:
  93     type: string
  94     label: vFirewall private IP address towards the unprotected network
  95     description: Private IP address that is assigned to the vFirewall to communicate with the vPacketGenerator
  96   vfw_int_protected_private_ip_0:
  97     type: string
  98     label: vFirewall private IP address towards the protected network
  99     description: Private IP address that is assigned to the vFirewall to communicate with the vSink
 100   vfw_onap_private_ip_0:
 101     type: string
 102     label: vFirewall private IP address towards the ONAP management network
 103     description: Private IP address that is assigned to the vFirewall to communicate with ONAP components
 104   vfw_int_protected_private_floating_ip:
 105     type: string
 106     label: same value as vpg_int_unprotected_private_ip_0
 107     description: IP to inform OpenStack to enable vfw protected private port to allow packets coming from the packet generator
 108   vpg_int_unprotected_private_ip_0:
 109     type: string
 110     label: vPacketGenerator private IP address towards the unprotected network
 111     description: Private IP address that is assigned to the vPacketGenerator to communicate with the vFirewall
 112   vpg_onap_private_ip_0:
 113     type: string
 114     label: vPacketGenerator private IP address towards the ONAP management network
 115     description: Private IP address that is assigned to the vPacketGenerator to communicate with ONAP components
 116   vsn_int_protected_private_ip_0:
 117     type: string
 118     label: vSink private IP address towards the protected network
 119     description: Private IP address that is assigned to the vSink to communicate with the vFirewall
 120   vsn_onap_private_ip_0:
 121     type: string
 122     label: vSink private IP address towards the ONAP management network
 123     description: Private IP address that is assigned to the vSink to communicate with ONAP components
 124   vfw_name_0:
 125     type: string
 126     label: vFirewall name
 127     description: Name of the vFirewall
 128   vpg_name_0:
 129     type: string
 130     label: vPacketGenerator name
 131     description: Name of the vPacketGenerator
 132   vsn_name_0:
 133     type: string
 134     label: vSink name
 135     description: Name of the vSink
 136   vnf_id:
 137     type: string
 138     label: VNF ID
 139     description: The VNF ID is provided by ONAP
 140   vnf_name:
 141     type: string
 142     label: VNF NAME
 143     description: The VNF NAME is provided by ONAP
 144   vf_module_id:
 145     type: string
 146     label: vFirewall module ID
 147     description: The vFirewall Module ID is provided by ONAP
 148   dcae_collector_ip:
 149     type: string
 150     label: DCAE collector IP address
 151     description: IP address of the DCAE collector
 152   dcae_collector_port:
 153     type: string
 154     label: DCAE collector port
 155     description: Port of the DCAE collector
 156   key_name:
 157     type: string
 158     label: Key pair name
 159     description: Public/Private key pair name
 160   pub_key:
 161     type: string
 162     label: Public key
 163     description: Public key to be installed on the compute instance
 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   demo_artifacts_version:
 169     type: string
 170     label: Artifacts version used in demo vnfs
 171     description: Artifacts (jar, tar.gz) version used in demo vnfs
 172   nexus_artifact_repo:
 173     type: string
 174     description: Root URL for the Nexus repository for Maven artifacts.
 175     # default values prohibited
 176     #default: "https://nexus.onap.org"
 177   cloud_env:
 178     type: string
 179     label: Cloud environment
 180     description: Cloud environment (e.g., openstack, rackspace)
 181   sec_group:
 182     type: string
 183     description: ONAP Security Group
 184   # Unused in template
 185   #sdnc_model_name:
 186   #  type: string
 187   #  description: SDNC Model Name metatada
 188   #sdnc_model_version:
 189   #  type: string
 190   #  description: SDNC Model Version metatada
 191   #sdnc_artifact_name:
 192   #  type: string
 193   #  description: SDNC Artifact Name metatada
 194
 195 #############
 196 #           #
 197 # RESOURCES #
 198 #           #
 199 #############
 200
 201 resources:
 202   random-str:
 203     type: OS::Heat::RandomString
 204     properties:
 205       length: 4
 206
 207   my_keypair:
 208     type: OS::Nova::KeyPair
 209     properties:
 210       name:
 211         str_replace:
 212           template: vnfname_base_rand
 213           params:
 214             base: { get_param: key_name }
 215             rand: { get_resource: random-str }
 216             vnfname: { get_param: vnf_name }
 217       public_key: { get_param: pub_key }
 218       save_private_key: false
 219
 220   # NETWORK_ROLE: unprotected_private
 221   # NETWORK_TYPE: internal
 222   int_unprotected_private_network:
 223     type: OS::Neutron::Net
 224     properties:
 225       name:
 226         str_replace:
 227           template: vnfname_netid
 228           params:
 229             netid: { get_param: unprotected_private_net_id }
 230             vnfname: { get_param: vnf_name }
 231
 232   # NETWORK_ROLE: protected_private
 233   # NETWORK_TYPE: internal
 234   int_protected_private_network:
 235     type: OS::Neutron::Net
 236     properties:
 237       name:
 238         str_replace:
 239           template: vnfname_netid
 240           params:
 241             netid: { get_param: protected_private_net_id }
 242             vnfname: { get_param: vnf_name }
 243
 244   # NETWORK_ROLE: unprotected_private
 245   # NETWORK_TYPE: internal
 246   int_unprotected_private_subnet:
 247     type: OS::Neutron::Subnet
 248     properties:
 249       network: { get_resource: int_unprotected_private_network }
 250       cidr: { get_param: unprotected_private_net_cidr }
 251
 252   # NETWORK_ROLE: protected_private
 253   # NETWORK_TYPE: internal
 254   int_protected_private_subnet:
 255     type: OS::Neutron::Subnet
 256     properties:
 257       network: { get_resource: int_protected_private_network }
 258       cidr: { get_param: protected_private_net_cidr }
 259
 260   ### Virtual Firewall instantiation ###
 261
 262   # VM_TYPE: vfw
 263   # NETWORK_ROLE: protected_private
 264   # NETWORK_TYPE: internal
 265   vfw_0_int_unprotected_private_port_0:
 266     type: OS::Neutron::Port
 267     properties:
 268       network: { get_resource: int_unprotected_private_network }
 269       fixed_ips: [{"subnet": { get_resource: int_unprotected_private_subnet }, "ip_address": { get_param: vfw_int_unprotected_private_ip_0 }}]
 270       security_groups:
 271       - { get_param: sec_group }
 272
 273   # VM_TYPE: vfw
 274   # NETWORK_ROLE: protected_private
 275   # NETWORK_TYPE: internal
 276   vfw_0_int_protected_private_port_0:
 277     type: OS::Neutron::Port
 278     properties:
 279       # this is a violation
 280       allowed_address_pairs: [{ "ip_address": { get_param: vfw_int_protected_private_floating_ip }}]
 281       network: { get_resource: int_protected_private_network }
 282       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vfw_int_protected_private_ip_0 }}]
 283       security_groups:
 284       - { get_param: sec_group }
 285
 286   # VM_TYPE: vfw
 287   # NETWORK_ROLE: onap_private
 288   # NETWORK_TYPE: external
 289   vfw_0_onap_private_port_0:
 290     type: OS::Neutron::Port
 291     properties:
 292       network: { get_param: onap_private_net_id }
 293       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vfw_onap_private_ip_0 }}]
 294       security_groups:
 295       - { get_param: sec_group }
 296
 297   # VM_TYPE: vfw
 298   vfw_server_0:
 299     type: OS::Nova::Server
 300     properties:
 301       image: { get_param: vfw_image_name }
 302       flavor: { get_param: vfw_flavor_name }
 303       name: { get_param: vfw_name_0 }
 304       key_name: { get_resource: my_keypair }
 305       networks:
 306         - network: { get_param: public_net_id }
 307         - port: { get_resource: vfw_0_int_unprotected_private_port_0 }
 308         - port: { get_resource: vfw_0_int_protected_private_port_0 }
 309         - port: { get_resource: vfw_0_onap_private_port_0 }
 310       metadata:
 311         vnf_id: { get_param: vnf_id }
 312         vf_module_id: { get_param: vf_module_id }
 313         vnf_name: { get_param: vnf_name }
 314       user_data_format: RAW
 315       user_data:
 316         str_replace:
 317           params:
 318             __dcae_collector_ip__ : { get_param: dcae_collector_ip }
 319             __dcae_collector_port__ : { get_param: dcae_collector_port }
 320             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 321             __install_script_version__ : { get_param: install_script_version }
 322             __vfw_private_ip_0__ : { get_param: vfw_int_unprotected_private_ip_0 }
 323             __vfw_private_ip_1__ : { get_param: vfw_int_protected_private_ip_0 }
 324             __vfw_private_ip_2__ : { get_param: vfw_onap_private_ip_0 }
 325             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 326             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 327             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 328             __cloud_env__ : { get_param: cloud_env }
 329             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 330           template: |
 331             #!/bin/bash
 332
 333             # Create configuration files
 334             mkdir /opt/config
 335             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 336             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 337             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 338             echo "__install_script_version__" > /opt/config/install_script_version.txt
 339             echo "__vfw_private_ip_0__" > /opt/config/vfw_private_ip_0.txt
 340             echo "__vfw_private_ip_1__" > /opt/config/vfw_private_ip_1.txt
 341             echo "__vfw_private_ip_2__" > /opt/config/vfw_private_ip_2.txt
 342             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 343             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 344             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 345             echo "__cloud_env__" > /opt/config/cloud_env.txt
 346             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 347
 348             # Download and run install script
 349             apt-get update
 350             apt-get -y install unzip
 351             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 352             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 353             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_firewall_install.sh
 354             cd /opt
 355             chmod +x v_firewall_install.sh
 356             ./v_firewall_install.sh
 357
 358
 359   ### Virtual Packet Generator instantiation ###
 360
 361   vpg_0_int_unprotected_private_port_0:
 362     type: OS::Neutron::Port
 363     properties:
 364       network: { get_resource: int_unprotected_private_network }
 365       fixed_ips: [{"subnet": { get_resource: int_unprotected_private_subnet }, "ip_address": { get_param: vpg_int_unprotected_private_ip_0 }}]
 366       security_groups:
 367       - { get_param: sec_group }
 368
 369   vpg_0_onap_private_port_0:
 370     type: OS::Neutron::Port
 371     properties:
 372       network: { get_param: onap_private_net_id }
 373       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vpg_onap_private_ip_0 }}]
 374       security_groups:
 375       - { get_param: sec_group }
 376
 377   vpg_server_0:
 378     type: OS::Nova::Server
 379     properties:
 380       image: { get_param: vpg_image_name }
 381       flavor: { get_param: vpg_flavor_name }
 382       name: { get_param: vpg_name_0 }
 383       key_name: { get_resource: my_keypair }
 384       networks:
 385         - network: { get_param: public_net_id }
 386         - port: { get_resource: vpg_0_int_unprotected_private_port_0 }
 387         - port: { get_resource: vpg_0_onap_private_port_0 }
 388       metadata:
 389         vnf_id: { get_param: vnf_id }
 390         vf_module_id: { get_param: vf_module_id }
 391         vnf_name: { get_param: vnf_name }
 392       user_data_format: RAW
 393       user_data:
 394         str_replace:
 395           params:
 396             __fw_ipaddr__: { get_param: vfw_int_unprotected_private_ip_0 }
 397             __protected_net_cidr__: { get_param: protected_private_net_cidr }
 398             __sink_ipaddr__: { get_param: vsn_int_protected_private_ip_0 }
 399             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 400             __install_script_version__ : { get_param: install_script_version }
 401             __vpg_private_ip_0__ : { get_param: vpg_int_unprotected_private_ip_0 }
 402             __vpg_private_ip_1__ : { get_param: vpg_onap_private_ip_0 }
 403             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 404             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 405             __cloud_env__ : { get_param: cloud_env }
 406             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 407           template: |
 408             #!/bin/bash
 409
 410             # Create configuration files
 411             mkdir /opt/config
 412             echo "__fw_ipaddr__" > /opt/config/fw_ipaddr.txt
 413             echo "__protected_net_cidr__" > /opt/config/protected_net_cidr.txt
 414             echo "__sink_ipaddr__" > /opt/config/sink_ipaddr.txt
 415             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 416             echo "__install_script_version__" > /opt/config/install_script_version.txt
 417             echo "__vpg_private_ip_0__" > /opt/config/vpg_private_ip_0.txt
 418             echo "__vpg_private_ip_1__" > /opt/config/vpg_private_ip_1.txt
 419             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 420             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 421             echo "__cloud_env__" > /opt/config/cloud_env.txt
 422             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 423
 424             # Download and run install script
 425             apt-get update
 426             apt-get -y install unzip
 427             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 428             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 429             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_packetgen_install.sh
 430             cd /opt
 431             chmod +x v_packetgen_install.sh
 432             ./v_packetgen_install.sh
 433
 434
 435   ### Virtual Sink instantiation ###
 436
 437   vsn_0_int_protected_private_port_0:
 438     type: OS::Neutron::Port
 439     properties:
 440       network: { get_resource: int_protected_private_network }
 441       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vsn_int_protected_private_ip_0 }}]
 442       security_groups:
 443       - { get_param: sec_group }
 444
 445   vsn_0_onap_private_port_0:
 446     type: OS::Neutron::Port
 447     properties:
 448       network: { get_param: onap_private_net_id }
 449       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vsn_onap_private_ip_0 }}]
 450       security_groups:
 451       - { get_param: sec_group }
 452
 453   vsn_server_0:
 454     type: OS::Nova::Server
 455     properties:
 456       image: { get_param: vsn_image_name }
 457       flavor: { get_param: vsn_flavor_name }
 458       name: { get_param: vsn_name_0 }
 459       key_name: { get_resource: my_keypair }
 460       networks:
 461         - network: { get_param: public_net_id }
 462         - port: { get_resource: vsn_0_int_protected_private_port_0 }
 463         - port: { get_resource: vsn_0_onap_private_port_0 }
 464       metadata:
 465         vnf_id: { get_param: vnf_id }
 466         vf_module_id: { get_param: vf_module_id }
 467         vnf_name: { get_param: vnf_name }
 468       user_data_format: RAW
 469       user_data:
 470         str_replace:
 471           params:
 472             __protected_net_gw__: { get_param: vfw_int_protected_private_ip_0 }
 473             __unprotected_net__: { get_param: unprotected_private_net_cidr }
 474             __install_script_version__ : { get_param: install_script_version }
 475             __vsn_private_ip_0__ : { get_param: vsn_int_protected_private_ip_0 }
 476             __vsn_private_ip_1__ : { get_param: vsn_onap_private_ip_0 }
 477             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 478             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 479             __cloud_env__ : { get_param: cloud_env }
 480             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 481           template: |
 482             #!/bin/bash
 483
 484             # Create configuration files
 485             mkdir /opt/config
 486             echo "__protected_net_gw__" > /opt/config/protected_net_gw.txt
 487             echo "__unprotected_net__" > /opt/config/unprotected_net.txt
 488             echo "__install_script_version__" > /opt/config/install_script_version.txt
 489             echo "__vsn_private_ip_0__" > /opt/config/vsn_private_ip_0.txt
 490             echo "__vsn_private_ip_1__" > /opt/config/vsn_private_ip_1.txt
 491             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 492             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 493             echo "__cloud_env__" > /opt/config/cloud_env.txt
 494             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 495
 496             # Download and run install script
 497             apt-get update
 498             apt-get -y install unzip
 499             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 500             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vfw&a=vfw-scripts&e=zip&v=__install_script_version__" -o /opt/vfw-scripts-__install_script_version__.zip
 501             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_sink_install.sh
 502             cd /opt
 503             chmod +x v_sink_install.sh
 504             ./v_sink_install.sh