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   public_net_id:
  45     type: string
  46     label: Public network name or ID
  47     description: Public network that enables remote connection to VNF
  48   unprotected_private_net_id:
  49     type: string
  50     label: Unprotected private network name or ID
  51     description: Private network that connects vPacketGenerator with vFirewall
  52   protected_private_net_id:
  53     type: string
  54     label: Protected private network name or ID
  55     description: Private network that connects vFirewall with vSink
  56   onap_private_net_id:
  57     type: string
  58     label: ONAP management network name or ID
  59     description: Private network that connects ONAP components and the VNF
  60   onap_private_subnet_id:
  61     type: string
  62     label: ONAP management sub-network name or ID
  63     description: Private sub-network that connects ONAP components and the VNF
  64   unprotected_private_net_cidr:
  65     type: string
  66     label: Unprotected private network CIDR
  67     description: The CIDR of the unprotected private network
  68   protected_private_net_cidr:
  69     type: string
  70     label: Protected private network CIDR
  71     description: The CIDR of the protected 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   vfw_private_ip_0:
  77     type: string
  78     label: vFirewall private IP address towards the unprotected network
  79     description: Private IP address that is assigned to the vFirewall to communicate with the vPacketGenerator
  80   vfw_private_ip_1:
  81     type: string
  82     label: vFirewall private IP address towards the protected network
  83     description: Private IP address that is assigned to the vFirewall to communicate with the vSink
  84   vfw_private_ip_2:
  85     type: string
  86     label: vFirewall private IP address towards the ONAP management network
  87     description: Private IP address that is assigned to the vFirewall to communicate with ONAP components
  88   vpg_private_ip_0:
  89     type: string
  90     label: vPacketGenerator private IP address towards the unprotected network
  91     description: Private IP address that is assigned to the vPacketGenerator to communicate with the vFirewall
  92   vpg_private_ip_1:
  93     type: string
  94     label: vPacketGenerator private IP address towards the ONAP management network
  95     description: Private IP address that is assigned to the vPacketGenerator to communicate with ONAP components
  96   vsn_private_ip_0:
  97     type: string
  98     label: vSink private IP address towards the protected network
  99     description: Private IP address that is assigned to the vSink to communicate with the vFirewall
 100   vsn_private_ip_1:
 101     type: string
 102     label: vSink private IP address towards the ONAP management network
 103     description: Private IP address that is assigned to the vSink to communicate with ONAP components
 104   vfw_name_0:
 105     type: string
 106     label: vFirewall name
 107     description: Name of the vFirewall
 108   vpg_name_0:
 109     type: string
 110     label: vPacketGenerator name
 111     description: Name of the vPacketGenerator
 112   vsn_name_0:
 113     type: string
 114     label: vSink name
 115     description: Name of the vSink
 116   vnf_id:
 117     type: string
 118     label: VNF ID
 119     description: The VNF ID is provided by ONAP
 120   vf_module_id:
 121     type: string
 122     label: vFirewall module ID
 123     description: The vFirewall Module ID is provided by ONAP
 124   dcae_collector_ip:
 125     type: string
 126     label: DCAE collector IP address
 127     description: IP address of the DCAE collector
 128   dcae_collector_port:
 129     type: string
 130     label: DCAE collector port
 131     description: Port of the DCAE collector
 132   key_name:
 133     type: string
 134     label: Key pair name
 135     description: Public/Private key pair name
 136   pub_key:
 137     type: string
 138     label: Public key
 139     description: Public key to be installed on the compute instance
 140   install_script_version:
 141     type: string
 142     label: Installation script version number
 143     description: Version number of the scripts that install the vFW demo app
 144   demo_artifacts_version:
 145     type: string
 146     label: Artifacts version used in demo vnfs
 147     description: Artifacts (jar, tar.gz) version used in demo vnfs
 148   nexus_artifact_repo:
 149     type: string
 150     description: Root URL for the Nexus repository for Maven artifacts.
 151     default: "https://nexus.onap.org"
 152   cloud_env:
 153     type: string
 154     label: Cloud environment
 155     description: Cloud environment (e.g., openstack, rackspace)
 156   sec_group:
 157     type: string
 158     description: ONAP Security Group
 159
 160 #############
 161 #           #
 162 # RESOURCES #
 163 #           #
 164 #############
 165
 166 resources:
 167   random-str:
 168     type: OS::Heat::RandomString
 169     properties:
 170       length: 4
 171
 172   my_keypair:
 173     type: OS::Nova::KeyPair
 174     properties:
 175       name:
 176         str_replace:
 177           template: base_rand
 178           params:
 179             base: { get_param: key_name }
 180             rand: { get_resource: random-str }
 181       public_key: { get_param: pub_key }
 182       save_private_key: false
 183
 184   unprotected_private_network:
 185     type: OS::Neutron::Net
 186     properties:
 187       name: { get_param: unprotected_private_net_id }
 188
 189   protected_private_network:
 190     type: OS::Neutron::Net
 191     properties:
 192       name: { get_param: protected_private_net_id }
 193
 194   unprotected_private_subnet:
 195     type: OS::Neutron::Subnet
 196     properties:
 197       network_id: { get_resource: unprotected_private_network }
 198       cidr: { get_param: unprotected_private_net_cidr }
 199
 200   protected_private_subnet:
 201     type: OS::Neutron::Subnet
 202     properties:
 203       network_id: { get_resource: protected_private_network }
 204       cidr: { get_param: protected_private_net_cidr }
 205
 206   # Virtual Firewall instantiation
 207   vfw_private_0_port:
 208     type: OS::Neutron::Port
 209     properties:
 210       network: { get_resource: unprotected_private_network }
 211       fixed_ips: [{"subnet": { get_resource: unprotected_private_subnet }, "ip_address": { get_param: vfw_private_ip_0 }}]
 212       security_groups:
 213       - { get_param: sec_group }
 214
 215   vfw_private_1_port:
 216     type: OS::Neutron::Port
 217     properties:
 218       allowed_address_pairs: [{ "ip_address": { get_param: vpg_private_ip_0 }}]
 219       network: { get_resource: protected_private_network }
 220       fixed_ips: [{"subnet": { get_resource: protected_private_subnet }, "ip_address": { get_param: vfw_private_ip_1 }}]
 221       security_groups:
 222       - { get_param: sec_group }
 223
 224   vfw_private_2_port:
 225     type: OS::Neutron::Port
 226     properties:
 227       network: { get_param: onap_private_net_id }
 228       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vfw_private_ip_2 }}]
 229       security_groups:
 230       - { get_param: sec_group }
 231
 232   vfw_0:
 233     type: OS::Nova::Server
 234     properties:
 235       image: { get_param: vfw_image_name }
 236       flavor: { get_param: vfw_flavor_name }
 237       name: { get_param: vfw_name_0 }
 238       key_name: { get_resource: my_keypair }
 239       networks:
 240         - network: { get_param: public_net_id }
 241         - port: { get_resource: vfw_private_0_port }
 242         - port: { get_resource: vfw_private_1_port }
 243         - port: { get_resource: vfw_private_2_port }
 244       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 245       user_data_format: RAW
 246       user_data:
 247         str_replace:
 248           params:
 249             __dcae_collector_ip__ : { get_param: dcae_collector_ip }
 250             __dcae_collector_port__ : { get_param: dcae_collector_port }
 251             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 252             __install_script_version__ : { get_param: install_script_version }
 253             __vfw_private_ip_0__ : { get_param: vfw_private_ip_0 }
 254             __vfw_private_ip_1__ : { get_param: vfw_private_ip_1 }
 255             __vfw_private_ip_2__ : { get_param: vfw_private_ip_2 }
 256             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 257             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 258             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 259             __cloud_env__ : { get_param: cloud_env }
 260             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 261           template: |
 262             #!/bin/bash
 263
 264             # Create configuration files
 265             mkdir /opt/config
 266             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 267             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 268             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 269             echo "__install_script_version__" > /opt/config/install_script_version.txt
 270             echo "__vfw_private_ip_0__" > /opt/config/vfw_private_ip_0.txt
 271             echo "__vfw_private_ip_1__" > /opt/config/vfw_private_ip_1.txt
 272             echo "__vfw_private_ip_2__" > /opt/config/vfw_private_ip_2.txt
 273             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 274             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 275             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 276             echo "__cloud_env__" > /opt/config/cloud_env.txt
 277             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 278
 279             # Download and run install script
 280             apt-get update
 281             apt-get -y install unzip
 282             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 283             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
 284             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_firewall_install.sh
 285             cd /opt
 286             chmod +x v_firewall_install.sh
 287             ./v_firewall_install.sh
 288
 289
 290   # Virtual Packet Generator instantiation
 291   vpg_private_0_port:
 292     type: OS::Neutron::Port
 293     properties:
 294       network: { get_resource: unprotected_private_network }
 295       fixed_ips: [{"subnet": { get_resource: unprotected_private_subnet }, "ip_address": { get_param: vpg_private_ip_0 }}]
 296       security_groups:
 297       - { get_param: sec_group }
 298
 299   vpg_private_1_port:
 300     type: OS::Neutron::Port
 301     properties:
 302       network: { get_param: onap_private_net_id }
 303       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vpg_private_ip_1 }}]
 304       security_groups:
 305       - { get_param: sec_group }
 306
 307   vpg_0:
 308     type: OS::Nova::Server
 309     properties:
 310       image: { get_param: vfw_image_name }
 311       flavor: { get_param: vfw_flavor_name }
 312       name: { get_param: vpg_name_0 }
 313       key_name: { get_resource: my_keypair }
 314       networks:
 315         - network: { get_param: public_net_id }
 316         - port: { get_resource: vpg_private_0_port }
 317         - port: { get_resource: vpg_private_1_port }
 318       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 319       user_data_format: RAW
 320       user_data:
 321         str_replace:
 322           params:
 323             __fw_ipaddr__: { get_param: vfw_private_ip_0 }
 324             __protected_net_cidr__: { get_param: protected_private_net_cidr }
 325             __sink_ipaddr__: { get_param: vsn_private_ip_0 }
 326             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 327             __install_script_version__ : { get_param: install_script_version }
 328             __vpg_private_ip_0__ : { get_param: vpg_private_ip_0 }
 329             __vpg_private_ip_1__ : { get_param: vpg_private_ip_1 }
 330             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 331             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 332             __cloud_env__ : { get_param: cloud_env }
 333             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 334           template: |
 335             #!/bin/bash
 336
 337             # Create configuration files
 338             mkdir /opt/config
 339             echo "__fw_ipaddr__" > /opt/config/fw_ipaddr.txt
 340             echo "__protected_net_cidr__" > /opt/config/protected_net_cidr.txt
 341             echo "__sink_ipaddr__" > /opt/config/sink_ipaddr.txt
 342             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 343             echo "__install_script_version__" > /opt/config/install_script_version.txt
 344             echo "__vpg_private_ip_0__" > /opt/config/vpg_private_ip_0.txt
 345             echo "__vpg_private_ip_1__" > /opt/config/vpg_private_ip_1.txt
 346             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 347             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 348             echo "__cloud_env__" > /opt/config/cloud_env.txt
 349             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 350
 351             # Download and run install script
 352             apt-get update
 353             apt-get -y install unzip
 354             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 355             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
 356             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_packetgen_install.sh
 357             cd /opt
 358             chmod +x v_packetgen_install.sh
 359             ./v_packetgen_install.sh
 360
 361
 362   # Virtual Sink instantiation
 363   vsn_private_0_port:
 364     type: OS::Neutron::Port
 365     properties:
 366       network: { get_resource: protected_private_network }
 367       fixed_ips: [{"subnet": { get_resource: protected_private_subnet }, "ip_address": { get_param: vsn_private_ip_0 }}]
 368       security_groups:
 369       - { get_param: sec_group }
 370
 371   vsn_private_1_port:
 372     type: OS::Neutron::Port
 373     properties:
 374       network: { get_param: onap_private_net_id }
 375       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vsn_private_ip_1 }}]
 376       security_groups:
 377       - { get_param: sec_group }
 378
 379   vsn_0:
 380     type: OS::Nova::Server
 381     properties:
 382       image: { get_param: vfw_image_name }
 383       flavor: { get_param: vfw_flavor_name }
 384       name: { get_param: vsn_name_0 }
 385       key_name: { get_resource: my_keypair }
 386       networks:
 387         - network: { get_param: public_net_id }
 388         - port: { get_resource: vsn_private_0_port }
 389         - port: { get_resource: vsn_private_1_port }
 390       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 391       user_data_format: RAW
 392       user_data:
 393         str_replace:
 394           params:
 395             __protected_net_gw__: { get_param: vfw_private_ip_1 }
 396             __unprotected_net__: { get_param: unprotected_private_net_cidr }
 397             __install_script_version__ : { get_param: install_script_version }
 398             __vsn_private_ip_0__ : { get_param: vsn_private_ip_0 }
 399             __vsn_private_ip_1__ : { get_param: vsn_private_ip_1 }
 400             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 401             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 402             __cloud_env__ : { get_param: cloud_env }
 403             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 404           template: |
 405             #!/bin/bash
 406
 407             # Create configuration files
 408             mkdir /opt/config
 409             echo "__protected_net_gw__" > /opt/config/protected_net_gw.txt
 410             echo "__unprotected_net__" > /opt/config/unprotected_net.txt
 411             echo "__install_script_version__" > /opt/config/install_script_version.txt
 412             echo "__vsn_private_ip_0__" > /opt/config/vsn_private_ip_0.txt
 413             echo "__vsn_private_ip_1__" > /opt/config/vsn_private_ip_1.txt
 414             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 415             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 416             echo "__cloud_env__" > /opt/config/cloud_env.txt
 417             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 418
 419             # Download and run install script
 420             apt-get update
 421             apt-get -y install unzip
 422             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 423             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
 424             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_sink_install.sh
 425             cd /opt
 426             chmod +x v_sink_install.sh
 427             ./v_sink_install.sh