heat/vFWDT/vFWSNK/base_vfw.yaml

   1 ##########################################################################
   2 #
   3 #==================LICENSE_START==========================================
   4 #
   5 #
   6 # Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
   7 # Copyright (c) 2018 Orange Intellectual Property. All rights reserved.
   8 #
   9 # Licensed under the Apache License, Version 2.0 (the "License");
  10 # you may not use this file except in compliance with the License.
  11 # You may obtain a copy of the License at
  12 #        http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS,
  16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 # See the License for the specific language governing permissions and
  18 # limitations under the License.
  19 #
  20 #==================LICENSE_END============================================
  21 #
  22 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  23 #
  24 ##########################################################################
  25
  26 heat_template_version: 2013-05-23
  27
  28 description: Heat template that deploys vFirewall Closed Loop demo app (vFW and vSink) for ONAP
  29
  30 ##############
  31 #            #
  32 # PARAMETERS #
  33 #            #
  34 ##############
  35
  36 parameters:
  37   image_name:
  38     type: string
  39     label: Image name or ID
  40     description: Image to be used for compute instance
  41   flavor_name:
  42     type: string
  43     label: Flavor
  44     description: Type of instance (flavor) to be used
  45   public_net_id:
  46     type: string
  47     label: Public network name or ID
  48     description: Public network that enables remote connection to VNF
  49   unprotected_private_net_id:
  50     type: string
  51     label: Unprotected private network name or ID
  52     description: Private network that connects vPacketGenerator with vFirewall
  53   unprotected_private_subnet_id:
  54     type: string
  55     label: Unprotected private subnetwork name or ID
  56     description: Private subnetwork of the protected network
  57   unprotected_private_net_cidr:
  58     type: string
  59     label: Unprotected private network CIDR
  60     description: The CIDR of the unprotected private network
  61   protected_private_net_id:
  62     type: string
  63     label: Protected private network name or ID
  64     description: Private network that connects vFirewall with vSink
  65   protected_private_subnet_id:
  66     type: string
  67     label: Protected private subnetwork name or ID
  68     description: Private subnetwork of the unprotected network
  69   protected_private_net_cidr:
  70     type: string
  71     label: Protected private network CIDR
  72     description: The CIDR of the protected private network
  73   onap_private_net_id:
  74     type: string
  75     label: ONAP management network name or ID
  76     description: Private network that connects ONAP components and the VNF
  77   onap_private_subnet_id:
  78     type: string
  79     label: ONAP management sub-network name or ID
  80     description: Private sub-network that connects ONAP components and the VNF
  81   onap_private_net_cidr:
  82     type: string
  83     label: ONAP private network CIDR
  84     description: The CIDR of the protected private network
  85   ext_private_net_id:
  86     type: string
  87     label: external private network name or ID
  88     description: Private network that enables connection to the public network
  89   ext_private_subnet_id:
  90     type: string
  91     label: External private subnetwork name or ID
  92     description: Private subnetwork that enables connection to the public network
  93   ext_private_net_cidr:
  94     type: string
  95     label: External private network CIDR
  96     description: The CIDR of the external private network
  97   vfw_private_ip_0:
  98     type: string
  99     label: vFirewall private IP address towards the unprotected network
 100     description: Private IP address that is assigned to the vFirewall to communicate with the vPacketGenerator
 101   vfw_private_ip_1:
 102     type: string
 103     label: vFirewall private IP address towards the protected network
 104     description: Private IP address that is assigned to the vFirewall to communicate with the vSink
 105   vfw_private_ip_2:
 106     type: string
 107     label: vFirewall private IP address towards the ONAP management network
 108     description: Private IP address that is assigned to the vFirewall to communicate with ONAP components
 109   vfw_private_ip_3:
 110     type: string
 111     label: vFirewall private IP address towards public
 112     description: Private IP address that is assigned to the vFirewall to communicate with internet
 113   vpg_private_ip_0:
 114     type: string
 115     label: vPacketGenerator private IP address towards the unprotected network
 116     description: Private IP address that is assigned to the vPacketGenerator to communicate with the vFirewall
 117   vsn_private_ip_0:
 118     type: string
 119     label: vSink private IP address towards the protected network
 120     description: Private IP address that is assigned to the vSink to communicate with the vFirewall
 121   vsn_private_ip_1:
 122     type: string
 123     label: vSink private IP address towards the ONAP management network
 124     description: Private IP address that is assigned to the vSink to communicate with ONAP components
 125   vsn_private_ip_2:
 126     type: string
 127     label: vSink private IP address towards public
 128     description: Private IP address that is assigned to the vSink to communicate with internet
 129   vfw_name_0:
 130     type: string
 131     label: vFirewall name
 132     description: Name of the vFirewall
 133   vsn_name_0:
 134     type: string
 135     label: vSink name
 136     description: Name of the vSink
 137   vnf_id:
 138     type: string
 139     label: VNF ID
 140     description: The VNF ID is provided by ONAP
 141   vf_module_id:
 142     type: string
 143     label: vFirewall module ID
 144     description: The vFirewall Module ID is provided by ONAP
 145   dcae_collector_ip:
 146     type: string
 147     label: DCAE collector IP address
 148     description: IP address of the DCAE collector
 149   dcae_collector_port:
 150     type: string
 151     label: DCAE collector port
 152     description: Port of the DCAE collector
 153   key_name:
 154     type: string
 155     label: Key pair name
 156     description: Public/Private key pair name
 157   pub_key:
 158     type: string
 159     label: Public key
 160     description: Public key to be installed on the compute instance
 161   repo_url_blob:
 162     type: string
 163     label: Repository URL
 164     description: URL of the repository that hosts the demo packages
 165   repo_url_artifacts:
 166     type: string
 167     label: Repository URL
 168     description: URL of the repository that hosts the demo packages
 169   install_script_version:
 170     type: string
 171     label: Installation script version number
 172     description: Version number of the scripts that install the vFW demo app
 173   demo_artifacts_version:
 174     type: string
 175     label: Artifacts version used in demo vnfs
 176     description: Artifacts (jar, tar.gz) version used in demo vnfs
 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
 185 #############
 186 #           #
 187 # RESOURCES #
 188 #           #
 189 #############
 190
 191 resources:
 192   random-str:
 193     type: OS::Heat::RandomString
 194     properties:
 195       length: 4
 196
 197   my_keypair:
 198     type: OS::Nova::KeyPair
 199     properties:
 200       name:
 201         str_replace:
 202           template: base_rand
 203           params:
 204             base: { get_param: key_name }
 205             rand: { get_resource: random-str }
 206       public_key: { get_param: pub_key }
 207       save_private_key: false
 208
 209   # Virtual Firewall instantiation
 210   vfw_private_0_port:
 211     type: OS::Neutron::Port
 212     properties:
 213       network: { get_param: unprotected_private_net_id }
 214       fixed_ips: [{"subnet": { get_param: unprotected_private_subnet_id }, "ip_address": { get_param: vfw_private_ip_0 }}]
 215       security_groups:
 216       - { get_param: sec_group }
 217
 218   vfw_private_1_port:
 219     type: OS::Neutron::Port
 220     properties:
 221       allowed_address_pairs: [{ "ip_address": { get_param: vpg_private_ip_0 }}]
 222       network: { get_param: protected_private_net_id }
 223       fixed_ips: [{"subnet": { get_param: protected_private_subnet_id }, "ip_address": { get_param: vfw_private_ip_1 }}]
 224       security_groups:
 225       - { get_param: sec_group }
 226
 227   vfw_private_2_port:
 228     type: OS::Neutron::Port
 229     properties:
 230       network: { get_param: onap_private_net_id }
 231       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vfw_private_ip_2 }}]
 232       security_groups:
 233       - { get_param: sec_group }
 234
 235   vfw_private_3_port:
 236     type: OS::Neutron::Port
 237     properties:
 238       network: { get_param: ext_private_net_id }
 239       fixed_ips: [{"subnet": { get_param: ext_private_subnet_id }, "ip_address": { get_param: vfw_private_ip_3 }}]
 240       security_groups:
 241        - { get_param: sec_group }
 242
 243   vfw_ext_floatingip:
 244     type: OS::Neutron::FloatingIP
 245     properties:
 246       floating_network: { get_param: public_net_id }
 247       port_id: { get_resource: vfw_private_3_port }
 248
 249   vfw_0:
 250     type: OS::Nova::Server
 251     properties:
 252       image: { get_param: image_name }
 253       flavor: { get_param: flavor_name }
 254       name: { get_param: vfw_name_0 }
 255       key_name: { get_resource: my_keypair }
 256       networks:
 257         - port: { get_resource: vfw_private_3_port }
 258         - port: { get_resource: vfw_private_0_port }
 259         - port: { get_resource: vfw_private_1_port }
 260         - port: { get_resource: vfw_private_2_port }
 261       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 262       user_data_format: RAW
 263       user_data:
 264         str_replace:
 265           params:
 266             __dcae_collector_ip__ : { get_param: dcae_collector_ip }
 267             __dcae_collector_port__ : { get_param: dcae_collector_port }
 268             __repo_url_blob__ : { get_param: repo_url_blob }
 269             __repo_url_artifacts__ : { get_param: repo_url_artifacts }
 270             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 271             __install_script_version__ : { get_param: install_script_version }
 272             __vfw_private_ip_0__ : { get_param: vfw_private_ip_0 }
 273             __vfw_private_ip_1__ : { get_param: vfw_private_ip_1 }
 274             __vfw_private_ip_2__ : { get_param: vfw_private_ip_2 }
 275             __vfw_private_ip_3__ : { get_param: vfw_private_ip_3 }
 276             __unprotected_private_net_cidr__ : { get_param: unprotected_private_net_cidr }
 277             __protected_private_net_cidr__ : { get_param: protected_private_net_cidr }
 278             __onap_private_net_cidr__ : { get_param: onap_private_net_cidr }
 279             __cloud_env__ : { get_param: cloud_env }
 280           template: |
 281             #!/bin/bash
 282
 283             # Create configuration files
 284             mkdir /opt/config
 285             echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
 286             echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
 287             echo "__repo_url_blob__" > /opt/config/repo_url_blob.txt
 288             echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
 289             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 290             echo "__install_script_version__" > /opt/config/install_script_version.txt
 291             echo "__vfw_private_ip_0__" > /opt/config/vfw_private_ip_0.txt
 292             echo "__vfw_private_ip_1__" > /opt/config/vfw_private_ip_1.txt
 293             echo "__vfw_private_ip_2__" > /opt/config/vfw_private_ip_2.txt
 294             echo "__vfw_private_ip_3__" > /opt/config/vfw_private_ip_3.txt
 295             echo "__unprotected_private_net_cidr__" > /opt/config/unprotected_private_net_cidr.txt
 296             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 297             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 298             echo "__cloud_env__" > /opt/config/cloud_env.txt
 299
 300             # Download and run install script
 301             curl -k __repo_url_blob__/org.onap.demo/vnfs/vfw/__install_script_version__/v_firewall_install.sh -o /opt/v_firewall_install.sh
 302             cd /opt
 303             chmod +x v_firewall_install.sh
 304             ./v_firewall_install.sh
 305
 306
 307   # Virtual Sink instantiation
 308   vsn_private_0_port:
 309     type: OS::Neutron::Port
 310     properties:
 311       network: { get_param: protected_private_net_id }
 312       fixed_ips: [{"subnet": { get_param: protected_private_subnet_id }, "ip_address": { get_param: vsn_private_ip_0 }}]
 313       security_groups:
 314       - { get_param: sec_group }
 315
 316   vsn_private_1_port:
 317     type: OS::Neutron::Port
 318     properties:
 319       network: { get_param: onap_private_net_id }
 320       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vsn_private_ip_1 }}]
 321       security_groups:
 322       - { get_param: sec_group }
 323
 324   vsn_private_2_port:
 325     type: OS::Neutron::Port
 326     properties:
 327       network: { get_param: ext_private_net_id }
 328       fixed_ips: [{"subnet": { get_param: ext_private_subnet_id }, "ip_address": { get_param: vsn_private_ip_2 }}]
 329       security_groups:
 330       - { get_param: sec_group }
 331
 332   vsn_ext_floatingip:
 333     type: OS::Neutron::FloatingIP
 334     properties:
 335       floating_network: { get_param: public_net_id }
 336       port_id: { get_resource: vsn_private_2_port }
 337
 338   vsn_0:
 339     type: OS::Nova::Server
 340     properties:
 341       image: { get_param: image_name }
 342       flavor: { get_param: flavor_name }
 343       name: { get_param: vsn_name_0 }
 344       key_name: { get_resource: my_keypair }
 345       networks:
 346         - port: { get_resource: vsn_private_2_port }
 347         - port: { get_resource: vsn_private_0_port }
 348         - port: { get_resource: vsn_private_1_port }
 349       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 350       user_data_format: RAW
 351       user_data:
 352         str_replace:
 353           params:
 354             __protected_net_gw__: { get_param: vfw_private_ip_1 }
 355             __unprotected_net__: { get_param: unprotected_private_net_cidr }
 356             __repo_url_blob__ : { get_param: repo_url_blob }
 357             __repo_url_artifacts__ : { get_param: repo_url_artifacts }
 358             __install_script_version__ : { get_param: install_script_version }
 359             __vsn_private_ip_0__ : { get_param: vsn_private_ip_0 }
 360             __vsn_private_ip_1__ : { get_param: vsn_private_ip_1 }
 361             __vsn_private_ip_2__ : { get_param: vsn_private_ip_2 }
 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           template: |
 366             #!/bin/bash
 367
 368             # Create configuration files
 369             mkdir /opt/config
 370             echo "__protected_net_gw__" > /opt/config/protected_net_gw.txt
 371             echo "__unprotected_net__" > /opt/config/unprotected_net.txt
 372             echo "__repo_url_blob__" > /opt/config/repo_url_blob.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 "__vsn_private_ip_2__" > /opt/config/vsn_private_ip_2.txt
 377             echo "__protected_private_net_cidr__" > /opt/config/protected_private_net_cidr.txt
 378             echo "__onap_private_net_cidr__" > /opt/config/onap_private_net_cidr.txt
 379             echo "__cloud_env__" > /opt/config/cloud_env.txt
 380
 381             # Download and run install script
 382             curl -k __repo_url_blob__/org.onap.demo/vnfs/vfw/__install_script_version__/v_sink_install.sh -o /opt/v_sink_install.sh
 383             cd /opt
 384             chmod +x v_sink_install.sh
 385             ./v_sink_install.sh