heat/vCPE/vbng/base_vcpe_vbng.yaml

##########################################################################
#
#==================LICENSE_START==========================================
#
#
# Copyright 2017 AT&T Intellectual Property. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#        http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#==================LICENSE_END============================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
#
##########################################################################

heat_template_version: 2013-05-23

description: Heat template to deploy vCPE virtual Broadband Network Gateway (vBNG)

##############
#            #
# PARAMETERS #
#            #
##############

parameters:
  vcpe_image_name:
    type: string
    label: Image name or ID
    description: Image to be used for compute instance
  vcpe_flavor_name:
    type: string
    label: Flavor
    description: Type of instance (flavor) to be used
  public_net_id:
    type: string
    label: Public network name or ID
    description: Public network that enables remote connection to VNF
  brgemu_bng_private_net_id:
    type: string
    label: vBNG IN private network name or ID
    description: Private network that connects vBRG to vBNG
  brgemu_bng_private_subnet_id:
    type: string
    label: vBNG IN private sub-network name or ID
    description: vBNG IN private sub-network name or ID
  brgemu_bng_private_net_cidr:
    type: string
    label: vBNG IN private network CIDR
    description: The CIDR of the input side of vBNG private network
  bng_gmux_private_net_id:
    type: string
    label: vBNG vGMUX private network name or ID
    description: Private network that connects vBNG to vGMUX
  bng_gmux_private_subnet_id:
    type: string
    label: vBNG vGMUX private sub-network name or ID
    description: vBNG vGMUX private sub-network name or ID
  bng_gmux_private_net_cidr:
    type: string
    label: vGMUX private network CIDR
    description: The CIDR of the input side of vGMUX private network
  onap_private_net_id:
    type: string
    label: ONAP management network name or ID
    description: Private network that connects ONAP components and the VNF
  onap_private_subnet_id:
    type: string
    label: ONAP management sub-network name or ID
    description: Private sub-network that connects ONAP components and the VNF
  onap_private_net_cidr:
    type: string
    label: ONAP private network CIDR
    description: The CIDR of the protected private network
  cpe_signal_net_id:
    type: string
    label: vCPE private network name or ID
    description: Private network that connects vCPE elements with vCPE infrastructure elements
  cpe_signal_subnet_id:
    type: string
    label: vCPE private sub-network name or ID
    description: vCPE private sub-network name or ID
  cpe_signal_private_net_cidr:
    type: string
    label: vAAA private network CIDR
    description: The CIDR of the vAAA private network
  vbng_private_ip_0:
    type: string
    label: vBNG IN private IP address
    description: Private IP address that is assigned to the vBNG IN
  vbng_private_ip_1:
    type: string
    label: vBNG private IP address towards the ONAP management network
    description: Private IP address that is assigned to the vBNG to communicate with ONAP components
  vbng_private_ip_2:
    type: string
    label: vBNG to CPE_SIGNAL private IP address
    description: Private IP address that is assigned to the vBNG in the CPE_SIGNAL network
  vbng_private_ip_3:
    type: string
    label: vBNG to vGMUX private IP address
    description: Private IP address that is assigned to the vBNG to vGMUX port
  vbng_name_0:
    type: string
    label: vBNG name
    description: Name of the vBNG
  vnf_id:
    type: string
    label: VNF ID
    description: The VNF ID is provided by ONAP
  vf_module_id:
    type: string
    label: vCPE module ID
    description: The vCPE Module ID is provided by ONAP
  dcae_collector_ip:
    type: string
    label: DCAE collector IP address
    description: IP address of the DCAE collector
  dcae_collector_port:
    type: string
    label: DCAE collector port
    description: Port of the DCAE collector
  key_name:
    type: string
    label: Key pair name
    description: Public/Private key pair name
  pub_key:
    type: string
    label: Public key
    description: Public key to be installed on the compute instance
  repo_url_blob:
    type: string
    label: Repository URL
    description: URL of the repository that hosts the demo packages
  repo_url_artifacts:
    type: string
    label: Repository URL
    description: URL of the repository that hosts the demo packages
  install_script_version:
    type: string
    label: Installation script version number
    description: Version number of the scripts that install the vFW demo app
  demo_artifacts_version:
    type: string
    label: Artifacts version used in demo vnfs
    description: Artifacts (jar, tar.gz) version used in demo vnfs
  cloud_env:
    type: string
    label: Cloud environment
    description: Cloud environment (e.g., openstack, rackspace)
  vpp_source_repo_url:
    type: string
    label: VPP Source Git Repo
    description: URL for VPP source codes
  vpp_source_repo_branch:
    type: string
    label: VPP Source Git Branch
    description: Git Branch for the VPP source codes
  vpp_patch_url:
    type: string
    label: VPP Patch URL
    description: URL for VPP patch for vBNG

#############
#           #
# RESOURCES #
#           #
#############

resources:

  random-str:
    type: OS::Heat::RandomString
    properties:
      length: 4

  my_keypair:
    type: OS::Nova::KeyPair
    properties:
      name:
        str_replace:
          template: base_rand
          params:
            base: { get_param: key_name }
            rand: { get_resource: random-str }
      public_key: { get_param: pub_key }
      save_private_key: false


  # Virtual BNG Instantiation
  vbng_private_0_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: brgemu_bng_private_net_id }
      fixed_ips: [{"subnet": { get_param: brgemu_bng_private_subnet_id }, "ip_address": { get_param: vbng_private_ip_0 }}]

  vbng_private_1_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: onap_private_net_id }
      fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vbng_private_ip_1 }}]

  vbng_private_2_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: cpe_signal_net_id }
      fixed_ips: [{"subnet": { get_param: cpe_signal_subnet_id }, "ip_address": { get_param: vbng_private_ip_2 }}]

  vbng_private_3_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: bng_gmux_private_net_id }
      fixed_ips: [{"subnet": { get_param: bng_gmux_private_subnet_id }, "ip_address": { get_param: vbng_private_ip_3 }}]

  vbng_0:
    type: OS::Nova::Server
    properties:
      image: { get_param: vcpe_image_name }
      flavor: { get_param: vcpe_flavor_name }
      name: { get_param: vbng_name_0 }
      key_name: { get_resource: my_keypair }
      networks:
        - network: { get_param: public_net_id }
        - port: { get_resource: vbng_private_0_port }
        - port: { get_resource: vbng_private_1_port }
        - port: { get_resource: vbng_private_2_port }
      metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
      user_data_format: RAW
      user_data:
        str_replace:
          params:
            __oam_ipaddr__: { get_param: vbng_private_ip_1 }
            __brgemu_bng_net_ipaddr__: { get_param: vbng_private_ip_0 }
            __cpe_signal_net_ipaddr__: { get_param: vbng_private_ip_2 }
            __bng_gmux_net_ipaddr__: { get_param: vbng_private_ip_3 }
            __oam_cidr__: { get_param: onap_private_net_cidr }
            __brgemu_bng_cidr__: { get_param: brgemu_bng_private_net_cidr }
            __cpe_signal_cidr__: { get_param: cpe_signal_private_net_cidr }
            __bng_gmux_cidr__: { get_param: bng_gmux_private_net_cidr }
            __dcae_collector_ip__: { get_param: dcae_collector_ip }
            __dcae_collector_port__: { get_param: dcae_collector_port }
            __repo_url_blob__ : { get_param: repo_url_blob }
            __repo_url_artifacts__ : { get_param: repo_url_artifacts }
            __demo_artifacts_version__ : { get_param: demo_artifacts_version }
            __install_script_version__ : { get_param: install_script_version }
            __cloud_env__ : { get_param: cloud_env }
            __vpp_source_repo_url__ : { get_param: vpp_source_repo_url }
            __vpp_source_repo_branch__ : { get_param: vpp_source_repo_branch }
            __vpp_patch_url__ : { get_param: vpp_patch_url }
          template: |
            #!/bin/bash

            # Create configuration files
            mkdir /opt/config
            echo "__brgemu_bng_net_ipaddr__" > /opt/config/brgemu_bng_net_ipaddr.txt
            echo "__cpe_signal_net_ipaddr__" > /opt/config/cpe_signal_net_ipaddr.txt
            echo "__bng_gmux_net_ipaddr__" > /opt/config/bng_gmux_net_ipaddr.txt
            echo "__oam_ipaddr__" > /opt/config/oam_ipaddr.txt
            echo "__oam_cidr__" > /opt/config/oam_cidr.txt
            echo "__bng_gmux_cidr__" > /opt/config/bng_gmux_net_cidr.txt
            echo "__cpe_signal_cidr__" > /opt/config/cpe_signal_net_cidr.txt
            echo "__brgemu_bng_cidr__" > /opt/config/brgemu_bng_net_cidr.txt
            echo "__dcae_collector_ip__" > /opt/config/dcae_collector_ip.txt
            echo "__dcae_collector_port__" > /opt/config/dcae_collector_port.txt
            echo "__repo_url_blob__" > /opt/config/repo_url_blob.txt
            echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
            echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
            echo "__install_script_version__" > /opt/config/install_script_version.txt
            echo "__cloud_env__" > /opt/config/cloud_env.txt
            echo "__vpp_source_repo_url__" > /opt/config/vpp_source_repo_url.txt
            echo "__vpp_source_repo_branch__" > /opt/config/vpp_source_repo_branch.txt
            echo "__vpp_patch_url__" > /opt/config/vpp_patch_url.txt

            # Download and run install script
            curl -k __repo_url_blob__/org.onap.demo/vnfs/vcpe/__install_script_version__/v_bng_install.sh -o /opt/v_bng_install.sh
            cd /opt
            chmod +x v_bng_install.sh
            ./v_bng_install.sh