heat/vCPE/vgmux/base_vcpe_vgmux.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 build vCPE Infrastructure Metro vGMUX
  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   bng_gmux_private_net_id:
  49     type: string
  50     label: vBNG vGMUX private network name or ID
  51     description: Private network that connects vBNG to vGMUX
  52   bng_gmux_private_subnet_id:
  53     type: string
  54     label: vBNG vGMUX private sub-network name or ID
  55     description: vBNG vGMUX private sub-network name or ID
  56   bng_gmux_private_net_cidr:
  57     type: string
  58     label: vBNG vGMUX private network CIDR
  59     description: The CIDR of the vBNG-vGMUX private network
  60   mux_gw_private_net_id:
  61     type: string
  62     label: vGMUX vGWs network name or ID
  63     description: Private network that connects vGMUX to vGWs
  64   mux_gw_private_subnet_id:
  65     type: string
  66     label: vGMUX vGWs sub-network name or ID
  67     description: vGMUX vGWs sub-network name or ID
  68   mux_gw_private_net_cidr:
  69     type: string
  70     label: vGMUX private network CIDR
  71     description: The CIDR of the vGMUX private network
  72   brgemu_bng_private_net_cidr:
  73     type: string
  74     label: vBRG vBNG private network CIDR
  75     description: The CIDR of the vBRG-vBNG private network
  76   onap_private_net_id:
  77     type: string
  78     label: ONAP management network name or ID
  79     description: Private network that connects ONAP components and the VNF
  80   onap_private_subnet_id:
  81     type: string
  82     label: ONAP management sub-network name or ID
  83     description: Private sub-network that connects ONAP components and the VNF
  84   onap_private_net_cidr:
  85     type: string
  86     label: ONAP private network CIDR
  87     description: The CIDR of the protected private network
  88   vgmux_private_ip_0:
  89     type: string
  90     label: vGMUX private IP address towards the vBNG-vGMUX private network
  91     description: Private IP address that is assigned to the vGMUX to communicate with the vBNG
  92   vgmux_private_ip_1:
  93     type: string
  94     label: vGMUX private IP address towards the ONAP management network
  95     description: Private IP address that is assigned to the vGMUX to communicate with ONAP components
  96   vgmux_private_ip_2:
  97     type: string
  98     label: vGMUX private IP address towards the vGMUX-vGW private network
  99     description: Private IP address that is assigned to the vGMUX to communicate with vGWs
 100   vgmux_name_0:
 101     type: string
 102     label: vGMUX name
 103     description: Name of the vGMUX
 104   vnf_id:
 105     type: string
 106     label: VNF ID
 107     description: The VNF ID is provided by ONAP
 108   vf_module_id:
 109     type: string
 110     label: vCPE module ID
 111     description: The vCPE Module ID is provided by ONAP
 112   bng_gmux_private_ip:
 113     type: string
 114     label: vBNG private IP address towards the vBNG-vGMUX private network
 115     description: Private IP address that is assigned to the vBNG to communicate with the vGMUX
 116   dcae_collector_ip:
 117     type: string
 118     label: DCAE collector IP address
 119     description: IP address of the DCAE collector
 120   dcae_collector_port:
 121     type: string
 122     label: DCAE collector port
 123     description: Port of the DCAE collector
 124   key_name:
 125     type: string
 126     label: Key pair name
 127     description: Public/Private key pair name
 128   pub_key:
 129     type: string
 130     label: Public key
 131     description: Public key to be installed on the compute instance
 132   script_version:
 133     type: string
 134     label: Installation script version number
 135     description: Version number of the scripts that install the vGMUX
 136   nexus_artifact_repo:
 137     type: string
 138     description: Root URL for the Nexus repository for Maven artifacts.
 139     default: "https://nexus.onap.org"
 140   cloud_env:
 141     type: string
 142     label: Cloud environment
 143     description: Cloud environment (e.g., openstack, rackspace)
 144
 145 #############
 146 #           #
 147 # RESOURCES #
 148 #           #
 149 #############
 150
 151 resources:
 152
 153   random-str:
 154     type: OS::Heat::RandomString
 155     properties:
 156       length: 4
 157
 158   my_keypair:
 159     type: OS::Nova::KeyPair
 160     properties:
 161       name:
 162         str_replace:
 163           template: base_rand
 164           params:
 165             base: { get_param: key_name }
 166             rand: { get_resource: random-str }
 167       public_key: { get_param: pub_key }
 168       save_private_key: false
 169
 170
 171   # Virtual GMUX Instantiation
 172   vgmux_private_0_port:
 173     type: OS::Neutron::Port
 174     properties:
 175       network: { get_param: bng_gmux_private_net_id }
 176       fixed_ips: [{"subnet": { get_param: bng_gmux_private_subnet_id }, "ip_address": { get_param: vgmux_private_ip_0 }}]
 177
 178   vgmux_private_1_port:
 179     type: OS::Neutron::Port
 180     properties:
 181       network: { get_param: onap_private_net_id }
 182       fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vgmux_private_ip_1 }}]
 183
 184   vgmux_private_2_port:
 185     type: OS::Neutron::Port
 186     properties:
 187       network: { get_param: mux_gw_private_net_id }
 188       fixed_ips: [{"subnet": {  get_param: mux_gw_private_subnet_id }, "ip_address": { get_param: vgmux_private_ip_2 }}]
 189
 190   vgmux_0:
 191     type: OS::Nova::Server
 192     properties:
 193       image: { get_param: vcpe_image_name }
 194       flavor: { get_param: vcpe_flavor_name }
 195       name: { get_param: vgmux_name_0 }
 196       key_name: { get_resource: my_keypair }
 197       networks:
 198         - network: { get_param: public_net_id }
 199         - port: { get_resource: vgmux_private_0_port }
 200         - port: { get_resource: vgmux_private_1_port }
 201         - port: { get_resource: vgmux_private_2_port }
 202       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 203       user_data_format: RAW
 204       user_data:
 205         str_replace:
 206           params:
 207             __mux_to_bng_net_ipaddr__ : { get_param: vgmux_private_ip_0 }
 208             __oam_ipaddr__ : { get_param: vgmux_private_ip_1 }
 209             __mux_gw_net_ipaddr__ : { get_param: vgmux_private_ip_2 }
 210             __bng_to_mux_ipaddr__ : { get_param: bng_gmux_private_ip }
 211             __bng_mux_net_cidr__ : { get_param: bng_gmux_private_net_cidr }
 212             __oam_cidr__ : { get_param: onap_private_net_cidr }
 213             __mux_gw_net_cidr__ : { get_param: mux_gw_private_net_cidr }
 214             __brg_bng_net_cidr__ : { get_param: brgemu_bng_private_net_cidr }
 215             __script_version__ : { get_param: script_version }
 216             __cloud_env__ : { get_param: cloud_env }
 217             __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
 218           template: |
 219             #!/bin/bash
 220
 221             # Create configuration files
 222             mkdir /opt/config
 223             echo "__mux_to_bng_net_ipaddr__" > /opt/config/mux_to_bng_net_ipaddr.txt
 224             echo "__oam_ipaddr__" > /opt/config/oam_ipaddr.txt
 225             echo "__mux_gw_net_ipaddr__" > /opt/config/mux_gw_net_ipaddr.txt
 226             echo "__bng_to_mux_ipaddr__ " > /opt/config/bng_to_mux_net_ipaddr.txt
 227             echo "__bng_mux_net_cidr__" > /opt/config/bng_mux_net_cidr.txt
 228             echo "__oam_cidr__" > /opt/config/oam_cidr.txt
 229             echo "__mux_gw_net_cidr__" > /opt/config/mux_gw_net_cidr.txt
 230             echo "__brg_bng_net_cidr__" > /opt/config/brg_bng_net_cidr.txt
 231             echo "__script_version__" > /opt/config/script_version.txt
 232             echo "__cloud_env__" > /opt/config/cloud_env.txt
 233             echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt
 234
 235             # Download and run install script
 236             apt-get update
 237             apt-get -y install unzip
 238             if [[ "__script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
 239             curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vcpe&a=vcpe-scripts&e=zip&v=__script_version__" -o /opt/vcpe-scripts-__script_version__.zip
 240             unzip -j /opt/vcpe-scripts-__script_version__.zip -d /opt v_gmux_install.sh
 241             cd /opt
 242             chmod +x v_gmux_install.sh
 243             ./v_gmux_install.sh