heat/vFWCL_DANOS/vFWSNK/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 Closed Loop demo app (vFW and vSink) 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   vsn_image_name:
  45     type: string
  46     label: Image name or ID
  47     description: Image to be used for compute instance
  48   vsn_flavor_name:
  49     type: string
  50     label: Flavor
  51     description: Type of instance (flavor) to be used
  52   public_net_id:
  53     type: string
  54     label: Public network name or ID
  55     description: Public network that enables remote connection to VNF
  56   int_unprotected_private_net_id:
  57     type: string
  58     label: Unprotected private network name or ID
  59     description: Private network that connects vPacketGenerator with vFirewall
  60   int_unprotected_private_subnet_id:
  61     type: string
  62     label: Unprotected private subnetwork name or ID
  63     description: Private subnetwork of the protected network
  64   unprotected_private_net_cidr:
  65     type: string
  66     label: Unprotected private network CIDR
  67     description: The CIDR of the unprotected private network
  68   int_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   int_protected_private_subnet_id:
  73     type: string
  74     label: Protected private subnetwork name or ID
  75     description: Private subnetwork of the unprotected network
  76   protected_private_net_cidr:
  77     type: string
  78     label: Protected private network CIDR
  79     description: The CIDR of the protected private network
  80   onap_private_net_id:
  81     type: string
  82     label: ONAP management network name or ID
  83     description: Private network that connects ONAP components and the VNF
  84   onap_private_subnet_id:
  85     type: string
  86     label: ONAP management sub-network name or ID
  87     description: Private sub-network that connects ONAP components and the VNF
  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: vPacketGenerator private IP address towards the unprotected network
 107     description: Private IP address that is assigned to the vPacketGenerator to communicate with the vFirewall
 108   vsn_int_protected_private_ip_0:
 109     type: string
 110     label: vSink private IP address towards the protected network
 111     description: Private IP address that is assigned to the vSink to communicate with the vFirewall
 112   vsn_onap_private_ip_0:
 113     type: string
 114     label: vSink private IP address towards the ONAP management network
 115     description: Private IP address that is assigned to the vSink to communicate with ONAP components
 116   vfw_name_0:
 117     type: string
 118     label: vFirewall name
 119     description: Name of the vFirewall
 120   vsn_name_0:
 121     type: string
 122     label: vSink name
 123     description: Name of the vSink
 124   vnf_name:
 125     type: string
 126     label: VNF NAME
 127     description: The VNF NAME is provided by ONAP
 128   net_prefix:
 129     type: string
 130     label: Network prefix
 131     description: Prefix for private network names - Workaround for Dublin
 132   vnf_id:
 133     type: string
 134     label: VNF ID
 135     description: The VNF ID is provided by ONAP
 136   vf_module_id:
 137     type: string
 138     label: vFirewall module ID
 139     description: The vFirewall Module ID is provided by ONAP
 140   dcae_collector_ip:
 141     type: string
 142     label: DCAE collector IP address
 143     description: IP address of the DCAE collector
 144   dcae_collector_port:
 145     type: string
 146     label: DCAE collector port
 147     description: Port of the DCAE collector
 148   key_name:
 149     type: string
 150     label: Key pair name
 151     description: Public/Private key pair name
 152   pub_key:
 153     type: string
 154     label: Public key
 155     description: Public key to be installed on the compute instance
 156   install_script_version:
 157     type: string
 158     label: Installation script version number
 159     description: Version number of the scripts that install the vFW demo app
 160   demo_artifacts_version:
 161     type: string
 162     label: Artifacts version used in demo vnfs
 163     description: Artifacts (jar, tar.gz) version used in demo vnfs
 164   nexus_artifact_repo:
 165     type: string
 166     description: Root URL for the Nexus repository for Maven artifacts.
 167   cloud_env:
 168     type: string
 169     label: Cloud environment
 170     description: Cloud environment (e.g., openstack, rackspace)
 171   sec_group:
 172     type: string
 173     description: ONAP Security Group
 174
 175 #############
 176 #           #
 177 # RESOURCES #
 178 #           #
 179 #############
 180
 181 resources:
 182   random-str:
 183     type: OS::Heat::RandomString
 184     properties:
 185       length: 4
 186
 187   my_keypair:
 188     type: OS::Nova::KeyPair
 189     properties:
 190       name:
 191         str_replace:
 192           template: vnfname_base_rand
 193           params:
 194             base: { get_param: key_name }
 195             vnfname: { get_param: vnf_name }
 196             rand: { get_resource: random-str }
 197       public_key: { get_param: pub_key }
 198       save_private_key: false
 199
 200   int_unprotected_private_network:
 201     type: OS::Neutron::Net
 202     properties:
 203       name:
 204         str_replace:
 205           template: vnfname_netid
 206           params:
 207             netid: { get_param: int_unprotected_private_net_id }
 208             vnfname: { get_param: net_prefix }
 209
 210   int_unprotected_private_subnet:
 211     type: OS::Neutron::Subnet
 212     properties:
 213       name:
 214         str_replace:
 215           template: vnfname_subnetid
 216           params:
 217             subnetid: { get_param: int_unprotected_private_subnet_id }
 218             vnfname: { get_param: net_prefix }
 219       network: { get_resource: int_unprotected_private_network }
 220       cidr: { get_param: unprotected_private_net_cidr }
 221
 222   int_protected_private_network:
 223     type: OS::Neutron::Net
 224     properties:
 225       name:
 226         str_replace:
 227           template: vnfname_netid
 228           params:
 229             netid: { get_param: int_protected_private_net_id }
 230             vnfname: { get_param: net_prefix }
 231
 232   int_protected_private_subnet:
 233     type: OS::Neutron::Subnet
 234     properties:
 235       name:
 236         str_replace:
 237           template: vnfname_subnetid
 238           params:
 239             subnetid: { get_param: int_protected_private_subnet_id }
 240             vnfname: { get_param: net_prefix }
 241       network: { get_resource: int_protected_private_network }
 242       cidr: { get_param: protected_private_net_cidr }
 243
 244   # DANOS installation as Virtual Firewall instantiation
 245   vfw_0_int_unprotected_private_port_0:
 246     type: OS::Neutron::Port
 247     properties:
 248       network: { get_resource: int_unprotected_private_network }
 249       fixed_ips: [{"subnet": { get_resource: int_unprotected_private_subnet }, "ip_address": { get_param: vfw_int_unprotected_private_ip_0 }}]
 250       security_groups:
 251       - { get_param: sec_group }
 252
 253   vfw_0_int_protected_private_port_0:
 254     type: OS::Neutron::Port
 255     properties:
 256       allowed_address_pairs: [{ "ip_address": { get_param: vfw_int_protected_private_floating_ip }}]
 257       network: { get_resource: int_protected_private_network }
 258       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vfw_int_protected_private_ip_0 }}]
 259       security_groups:
 260       - { get_param: sec_group }
 261
 262   vfw_0_onap_private_port_0:
 263     type: OS::Neutron::Port
 264     properties:
 265       network: { get_param: onap_private_net_id }
 266       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vfw_onap_private_ip_0 }}]
 267       security_groups:
 268       - { get_param: sec_group }
 269
 270   vfw_server_0:
 271     type: OS::Nova::Server
 272     properties:
 273       image: { get_param: vfw_image_name }
 274       flavor: { get_param: vfw_flavor_name }
 275       name: { get_param: vfw_name_0 }
 276       key_name: { get_resource: my_keypair }
 277       networks:
 278         - network: { get_param: public_net_id }
 279         - port: { get_resource: vfw_0_int_unprotected_private_port_0 }
 280         - port: { get_resource: vfw_0_int_protected_private_port_0 }
 281         - port: { get_resource: vfw_0_onap_private_port_0 }
 282       metadata:
 283         vnf_name: { get_param: vnf_name }
 284         vnf_id: { get_param: vnf_id }
 285         vf_module_id: { get_param: vf_module_id }
 286       user_data_format: RAW
 287       user_data:
 288         str_replace:
 289           params:
 290             __dcae_collector_ip__: { get_param: dcae_collector_ip }
 291             __dcae_collector_port__: { get_param: dcae_collector_port }
 292             __demo_artifacts_version__: { get_param: demo_artifacts_version }
 293             __install_script_version__: { get_param: install_script_version }
 294             __vfw_private_ip_0__: { get_param: vfw_int_unprotected_private_ip_0 }
 295             __vfw_private_ip_1__: { get_param: vfw_int_protected_private_ip_0 }
 296             __vfw_private_ip_2__: { get_param: vfw_onap_private_ip_0 }
 297             __unprotected_private_net_cidr__: { get_param: unprotected_private_net_cidr }
 298             __protected_private_net_cidr__: { get_param: protected_private_net_cidr }
 299             __onap_private_net_cidr__: { get_param: onap_private_net_cidr }
 300             __cloud_env__: { get_param: cloud_env }
 301             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 302           template: |
 303             #!/bin/bash
 304
 305             # Create configuration files
 306             mkdir /opt/config
 307             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 308             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 309             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 310             echo "__install_script_version__" > /opt/config/install_script_version.txt
 311             echo "__vfw_private_ip_0__" > /opt/config/vfw_private_ip_0.txt
 312             echo "__vfw_private_ip_1__" > /opt/config/vfw_private_ip_1.txt
 313             echo "__vfw_private_ip_2__" > /opt/config/vfw_private_ip_2.txt
 314             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 315             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 316             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 317             echo "__cloud_env__" > /opt/config/cloud_env.txt
 318             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 319
 320
 321   # Virtual Sink instantiation
 322   vsn_0_int_protected_private_port_0:
 323     type: OS::Neutron::Port
 324     properties:
 325       network: { get_resource: int_protected_private_network }
 326       fixed_ips: [{"subnet": { get_resource: int_protected_private_subnet }, "ip_address": { get_param: vsn_int_protected_private_ip_0 }}]
 327       security_groups:
 328       - { get_param: sec_group }
 329
 330   vsn_0_onap_private_port_0:
 331     type: OS::Neutron::Port
 332     properties:
 333       network: { get_param: onap_private_net_id }
 334       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vsn_onap_private_ip_0 }}]
 335       security_groups:
 336       - { get_param: sec_group }
 337
 338   vsn_server_0:
 339     type: OS::Nova::Server
 340     properties:
 341       image: { get_param: vsn_image_name }
 342       flavor: { get_param: vsn_flavor_name }
 343       name: { get_param: vsn_name_0 }
 344       key_name: { get_resource: my_keypair }
 345       networks:
 346         - network: { get_param: public_net_id }
 347         - port: { get_resource: vsn_0_int_protected_private_port_0 }
 348         - port: { get_resource: vsn_0_onap_private_port_0 }
 349       metadata:
 350         vnf_name: { get_param: vnf_name }
 351         vnf_id: { get_param: vnf_id }
 352         vf_module_id: { get_param: vf_module_id }
 353       user_data_format: RAW
 354       user_data:
 355         str_replace:
 356           params:
 357             __protected_net_gw__: { get_param: vfw_int_protected_private_ip_0 }
 358             __unprotected_net__: { get_param: unprotected_private_net_cidr }
 359             __install_script_version__: { get_param: install_script_version }
 360             __vsn_private_ip_0__: { get_param: vsn_int_protected_private_ip_0 }
 361             __vsn_private_ip_1__: { get_param: vsn_onap_private_ip_0 }
 362             __protected_private_net_cidr__: { get_param: protected_private_net_cidr }
 363             __onap_private_net_cidr__: { get_param: onap_private_net_cidr }
 364             __cloud_env__: { get_param: cloud_env }
 365             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 366           template: |
 367             #!/bin/bash
 368
 369             # Create configuration files
 370             mkdir /opt/config
 371             echo "__protected_net_gw__" > /opt/config/protected_net_gw.txt
 372             echo "__unprotected_net__" > /opt/config/unprotected_net.txt
 373             echo "__install_script_version__" > /opt/config/install_script_version.txt
 374             echo "__vsn_private_ip_0__" > /opt/config/vsn_private_ip_0.txt
 375             echo "__vsn_private_ip_1__" > /opt/config/vsn_private_ip_1.txt
 376             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 377             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 378             echo "__cloud_env__" > /opt/config/cloud_env.txt
 379             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 380
 381             # Download and run install script
 382             apt-get update
 383             apt-get -y install unzip
 384             if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 385             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
 386             unzip -j /opt/vfw-scripts-__install_script_version__.zip -d /opt v_sink_install.sh
 387             cd /opt
 388             chmod +x v_sink_install.sh
 389             ./v_sink_install.sh