heat/vCPE/vgw/base_vcpe_vgw.yaml

   1 ##########################################################################
   2 #
   3 #==================LICENSE_START==========================================
   4 #
   5 #
   6 # Copyright 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 vCPE vGateway (vG)
  28
  29 ##############
  30 #            #
  31 # PARAMETERS #
  32 #            #
  33 ##############
  34
  35 parameters:
  36   vcpe_image_name:
  37     type: string
  38     label: Image name or ID
  39     description: Image to be used for compute instance
  40   vcpe_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   mux_gw_private_net_id:
  49     type: string
  50     label: vGMUX private network name or ID
  51     description: Private network that connects vGMUX to vGWs
  52   mux_gw_private_subnet_id:
  53     type: string
  54     label: vGMUX private sub-network name or ID
  55     description: vGMUX private sub-network name or ID
  56   mux_gw_private_net_cidr:
  57     type: string
  58     label: vGMUX private network CIDR
  59     description: The CIDR of the vGMUX private network
  60   onap_private_net_id:
  61     type: string
  62     label: ONAP management network name or ID
  63     description: Private network that connects ONAP components and the VNF
  64   onap_private_subnet_id:
  65     type: string
  66     label: ONAP management sub-network name or ID
  67     description: Private sub-network that connects ONAP components and the VNF
  68   onap_private_net_cidr:
  69     type: string
  70     label: ONAP private network CIDR
  71     description: The CIDR of the protected private network
  72   cpe_public_net_id:
  73     type: string
  74     label: vCPE network that emulates internetmanagement name or ID
  75     description: Private network that connects vGW to emulated internet
  76   cpe_public_subnet_id:
  77     type: string
  78     label: vCPE Public subnet
  79     description: vCPE Public subnet
  80   cpe_public_net_cidr:
  81     type: string
  82     label: vCPE public network CIDR
  83     description: The CIDR of the vCPE public
  84   vgw_private_ip_0:
  85     type: string
  86     label: vGW private IP address towards the vGMUX
  87     description: Private IP address that is assigned to the vGW to communicate with vGMUX
  88   vgw_private_ip_1:
  89     type: string
  90     label: vGW private IP address towards the ONAP management network
  91     description: Private IP address that is assigned to the vGW to communicate with ONAP components
  92   vgw_private_ip_2:
  93     type: string
  94     label: vGW private IP address towards the vCPE public network
  95     description: Private IP address that is assigned to the vGW to communicate with vCPE public network
  96   vgw_name_0:
  97     type: string
  98     label: vGW  name
  99     description: Name of the vGW
 100   vnf_id:
 101     type: string
 102     label: VNF ID
 103     description: The VNF ID is provided by ONAP
 104   vf_module_id:
 105     type: string
 106     label: vCPE module ID
 107     description: The vCPE Module ID is provided by ONAP
 108   dcae_collector_ip:
 109     type: string
 110     label: DCAE collector IP address
 111     description: IP address of the DCAE collector
 112   dcae_collector_port:
 113     type: string
 114     label: DCAE collector port
 115     description: Port of the DCAE collector
 116   key_name:
 117     type: string
 118     label: Key pair name
 119     description: Public/Private key pair name
 120   pub_key:
 121     type: string
 122     label: Public key
 123     description: Public key to be installed on the compute instance
 124   repo_url_blob:
 125     type: string
 126     label: Repository URL
 127     description: URL of the repository that hosts the demo packages
 128   repo_url_artifacts:
 129     type: string
 130     label: Repository URL
 131     description: URL of the repository that hosts the demo packages
 132   install_script_version:
 133     type: string
 134     label: Installation script version number
 135     description: Version number of the scripts that install the vFW demo app
 136   demo_artifacts_version:
 137     type: string
 138     label: Artifacts version used in demo vnfs
 139     description: Artifacts (jar, tar.gz) version used in demo vnfs
 140   cloud_env:
 141     type: string
 142     label: Cloud environment
 143     description: Cloud environment (e.g., openstack, rackspace)
 144   vpp_source_repo_url:
 145     type: string
 146     label: VPP Source Git Repo
 147     description: URL for VPP source codes
 148   vpp_source_repo_branch:
 149     type: string
 150     label: VPP Source Git Branch
 151     description: Git Branch for the VPP source codes
 152   hc2vpp_source_repo_url:
 153     type: string
 154     label: Honeycomb Source Git Repo
 155     description: URL for Honeycomb source codes
 156   hc2vpp_source_repo_branch:
 157     type: string
 158     label: Honeycomb Source Git Branch
 159     description: Git Branch for the Honeycomb source codes
 160
 161 #############
 162 #           #
 163 # RESOURCES #
 164 #           #
 165 #############
 166
 167 resources:
 168
 169   random-str:
 170     type: OS::Heat::RandomString
 171     properties:
 172       length: 4
 173
 174   my_keypair:
 175     type: OS::Nova::KeyPair
 176     properties:
 177       name:
 178         str_replace:
 179           template: base_rand
 180           params:
 181             base: { get_param: key_name }
 182             rand: { get_resource: random-str }
 183       public_key: { get_param: pub_key }
 184       save_private_key: false
 185
 186   # Virtual GW Instantiation
 187   vgw_private_0_port:
 188     type: OS::Neutron::Port
 189     properties:
 190       network: { get_param: mux_gw_private_net_id }
 191       fixed_ips: [{"subnet": { get_param: mux_gw_private_subnet_id }, "ip_address": { get_param: vgw_private_ip_0 }}]
 192
 193   vgw_private_1_port:
 194     type: OS::Neutron::Port
 195     properties:
 196       network: { get_param: onap_private_net_id }
 197       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vgw_private_ip_1 }}]
 198
 199   vgw_private_2_port:
 200     type: OS::Neutron::Port
 201     properties:
 202       network: { get_param: cpe_public_net_id}
 203       fixed_ips: [{"subnet": { get_param: cpe_public_subnet_id }, "ip_address": { get_param: vgw_private_ip_2 }}]
 204
 205   vgw_0:
 206     type: OS::Nova::Server
 207     properties:
 208       image: { get_param: vcpe_image_name }
 209       flavor: { get_param: vcpe_flavor_name }
 210       name: { get_param: vgw_name_0 }
 211       key_name: { get_resource: my_keypair }
 212       networks:
 213         - network: { get_param: public_net_id }
 214         - port: { get_resource: vgw_private_0_port }
 215         - port: { get_resource: vgw_private_1_port }
 216         - port: { get_resource: vgw_private_2_port }
 217       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 218       user_data_format: RAW
 219       user_data:
 220         str_replace:
 221           params:
 222             __mux_gw_private_net_ipaddr__ : { get_param: vgw_private_ip_0 }
 223             __oam_ipaddr__ : { get_param: vgw_private_ip_1 }
 224             __oam_cidr__ : { get_param: onap_private_net_cidr }
 225             __cpe_public_net_cidr__ : { get_param: cpe_public_net_cidr }
 226             __mux_gw_private_net_cidr__ : { get_param: mux_gw_private_net_cidr }
 227             __repo_url_blob__ : { get_param: repo_url_blob }
 228             __repo_url_artifacts__ : { get_param: repo_url_artifacts }
 229             __demo_artifacts_version__ : { get_param: demo_artifacts_version }
 230             __install_script_version__ : { get_param: install_script_version }
 231             __cloud_env__ : { get_param: cloud_env }
 232             __vpp_source_repo_url__ : { get_param: vpp_source_repo_url }
 233             __vpp_source_repo_branch__ : { get_param: vpp_source_repo_branch }
 234             __hc2vpp_source_repo_url__ : { get_param: hc2vpp_source_repo_url }
 235             __hc2vpp_source_repo_branch__ : { get_param: hc2vpp_source_repo_branch }
 236           template: |
 237             #!/bin/bash
 238
 239             # Create configuration files
 240             mkdir /opt/config
 241             echo "__oam_ipaddr__" > /opt/config/oam_ipaddr.txt
 242             echo "__oam_cidr__" > /opt/config/oam_cidr.txt
 243             echo "__cpe_public_net_cidr__" > /opt/config/cpe_public_net_cidr.txt
 244             echo "__mux_gw_private_net_ipaddr__" > /opt/config/mux_gw_private_net_ipaddr.txt
 245             echo "__mux_gw_private_net_cidr__" > /opt/config/mux_gw_private_net_cidr.txt
 246             echo "__repo_url_blob__" > /opt/config/repo_url_blob.txt
 247             echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
 248             echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
 249             echo "__install_script_version__" > /opt/config/install_script_version.txt
 250             echo "__cloud_env__" > /opt/config/cloud_env.txt
 251             echo "__vpp_source_repo_url__" > /opt/config/vpp_source_repo_url.txt
 252             echo "__vpp_source_repo_branch__" > /opt/config/vpp_source_repo_branch.txt
 253             echo "__hc2vpp_source_repo_url__" > /opt/config/hc2vpp_source_repo_url.txt
 254             echo "__hc2vpp_source_repo_branch__" > /opt/config/hc2vpp_source_repo_branch.txt
 255
 256             # Download and run install script
 257             curl -k __repo_url_blob__/org.onap.demo/vnfs/vcpe/__install_script_version__/v_gw_install.sh -o /opt/v_gw_install.sh
 258             cd /opt
 259             chmod +x v_gw_install.sh
 260             ./v_gw_install.sh
 261