heat/vIMS/sprout.yaml

   1 # Project Clearwater - IMS in the Cloud
   2 # Copyright (C) 2015  Metaswitch Networks Ltd
   3 #
   4 # This program is free software: you can redistribute it and/or modify it
   5 # under the terms of the GNU General Public License as published by the
   6 # Free Software Foundation, either version 3 of the License, or (at your
   7 # option) any later version, along with the "Special Exception" for use of
   8 # the program along with SSL, set forth below. This program is distributed
   9 # in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  10 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  11 # A PARTICULAR PURPOSE.  See the GNU General Public License for more
  12 # details. You should have received a copy of the GNU General Public
  13 # License along with this program.  If not, see
  14 # <http://www.gnu.org/licenses/>.
  15 #
  16 # The author can be reached by email at clearwater@metaswitch.com or by
  17 # post at Metaswitch Networks Ltd, 100 Church St, Enfield EN2 6BQ, UK
  18 #
  19 # Special Exception
  20 # Metaswitch Networks Ltd  grants you permission to copy, modify,
  21 # propagate, and distribute a work formed by combining OpenSSL with The
  22 # Software, or a work derivative of such a combination, even if such
  23 # copying, modification, propagation, or distribution would otherwise
  24 # violate the terms of the GPL. You must comply with the GPL in all
  25 # respects for all of the code used other than OpenSSL.
  26 # "OpenSSL" means OpenSSL toolkit software distributed by the OpenSSL
  27 # Project and licensed under the OpenSSL Licenses, or a work based on such
  28 # software and licensed under the OpenSSL Licenses.
  29 # "OpenSSL Licenses" means the OpenSSL License and Original SSLeay License
  30 # under which the OpenSSL Project distributes the OpenSSL toolkit software,
  31 # as those licenses appear in the file LICENSE-OPENSSL.
  32
  33 heat_template_version: 2014-10-16
  34
  35 description: >
  36   Clearwater Sprout node
  37
  38 parameters:
  39   vnf_name:
  40     type: string
  41     label: VNF ID
  42     description: The VNF name provided by ONAP
  43   vnf_id:
  44     type: string
  45     label: VNF ID
  46     description: The VNF ID provided by ONAP
  47   vf_module_id:
  48     type: string
  49     label: VNF module ID
  50     description: The VNF module ID provided by ONAP
  51   public_net_id:
  52     type: string
  53     description: ID of public network
  54     constraints:
  55       - custom_constraint: neutron.network
  56         description: Must be a valid network ID
  57   sprout_flavor_name:
  58     type: string
  59     description: Flavor to use
  60     constraints:
  61       - custom_constraint: nova.flavor
  62         description: Must be a valid flavor name
  63   sprout_image_name:
  64     type: string
  65     description: Name of image to use
  66   key_name:
  67     type: string
  68     description: Name of keypair to assign
  69     constraints:
  70       - custom_constraint: nova.keypair
  71         description: Must be a valid keypair name
  72   repo_url:
  73     type: string
  74     description: URL for Clearwater repository
  75   zone:
  76     type: string
  77     description: DNS zone
  78   dns_ip:
  79     type: string
  80     description: IP address for DNS server on network
  81   dnssec_key:
  82     type: string
  83     description: DNSSEC private key (Base64-encoded)
  84     constraints:
  85       - allowed_pattern: "[0-9A-Za-z+/=]+"
  86         description: Must be Base64-encoded
  87   etcd_ip:
  88     type: string
  89     description: IP address of an existing member of the etcd cluster
  90
  91 resources:
  92
  93   sprout_random_str:
  94     type: OS::Heat::RandomString
  95     properties:
  96       length: 4
  97
  98   sprout_security_group:
  99     type: OS::Neutron::SecurityGroup
 100     properties:
 101       description: security group
 102       name:
 103         str_replace:
 104           template: pre_base_rand
 105           params:
 106             pre: sprout_sg_
 107             base: { get_param: vnf_name }
 108             rand: { get_resource: sprout_random_str }
 109       rules: [
 110         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 22, port_range_max: 22},
 111         {remote_ip_prefix: 0.0.0.0/0, protocol: udp, port_range_min: 161, port_range_max: 162},
 112         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 2380, port_range_max: 2380},
 113         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 4000, port_range_max: 4000},
 114         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 5054, port_range_max: 5054},
 115         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 5052, port_range_max: 5052},
 116         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 9888, port_range_max: 9888},
 117         {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 443, port_range_max: 443},
 118         {remote_ip_prefix: 0.0.0.0/0, protocol: icmp}]
 119
 120   sprout_admin_port_0:
 121     type: OS::Neutron::Port
 122     properties:
 123       name:
 124         str_replace:
 125           template: pre_base_rand
 126           params:
 127             pre: sprout_admin_port_0_
 128             base: { get_param: vnf_name }
 129             rand: { get_resource: sprout_random_str }
 130       network: { get_param: public_net_id }
 131       security_groups: [{ get_resource: sprout_security_group }]
 132
 133   sprout_server_0:
 134     type: OS::Nova::Server
 135     properties:
 136       name:
 137         str_replace:
 138           template: pre_base_rand
 139           params:
 140             pre: sprout_server_0_
 141             base: { get_param: vnf_name }
 142             rand: { get_resource: sprout_random_str }
 143       image: { get_param: sprout_image_name }
 144       flavor: { get_param: sprout_flavor_name }
 145       key_name: { get_param: key_name }
 146       networks:
 147         - port: { get_resource: sprout_admin_port_0 }
 148       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }, vnf_name: { get_param: vnf_name }}
 149       user_data_format: RAW
 150       user_data:
 151         str_replace:
 152           params:
 153             __repo_url__: { get_param: repo_url }
 154             __zone__: { get_param: zone }
 155             __dns_ip__: { get_param: dns_ip }
 156             __dnssec_key__: { get_param: dnssec_key }
 157             __etcd_ip__ : { get_param: etcd_ip }
 158             __index__ : 0
 159           template: |
 160             #!/bin/bash
 161
 162             # Log all output to file.
 163             exec > >(tee -a /var/log/clearwater-heat-sprout.log) 2>&1
 164             set -x
 165
 166             # Configure the APT software source.
 167             echo 'deb __repo_url__ binary/' > /etc/apt/sources.list.d/clearwater.list
 168             curl -L http://repo.cw-ngv.com/repo_key | apt-key add -
 169             apt-get update
 170
 171             # Get the public IP address from eth0
 172             sudo apt-get install ipcalc
 173             ADDR=`ip addr show eth0 | awk '/inet /{print $2}'`
 174             PUBLIC_ADDR=`ipcalc -n -b $ADDR | awk '/Address:/{print $2}'`
 175
 176             # Configure /etc/clearwater/local_config.
 177             mkdir -p /etc/clearwater
 178             etcd_ip=__etcd_ip__
 179             [ -n "$etcd_ip" ] || etcd_ip=$PUBLIC_ADDR
 180             cat > /etc/clearwater/local_config << EOF
 181             management_local_ip=$PUBLIC_ADDR
 182             local_ip=$PUBLIC_ADDR
 183             public_ip=$PUBLIC_ADDR
 184             public_hostname=__index__.sprout.__zone__
 185             etcd_cluster=$etcd_ip
 186             EOF
 187
 188             # Create /etc/chronos/chronos.conf.
 189             mkdir -p /etc/chronos
 190             cat > /etc/chronos/chronos.conf << EOF
 191             [http]
 192             bind-address = $PUBLIC_ADDR
 193             bind-port = 7253
 194             threads = 50
 195
 196             [logging]
 197             folder = /var/log/chronos
 198             level = 2
 199
 200             [alarms]
 201             enabled = true
 202
 203             [exceptions]
 204             max_ttl = 600
 205             EOF
 206
 207             # Now install the software.
 208             DEBIAN_FRONTEND=noninteractive apt-get install sprout --yes --force-yes
 209             DEBIAN_FRONTEND=noninteractive apt-get install clearwater-management --yes --force-yes
 210
 211             # Function to give DNS record type and IP address for specified IP address
 212             ip2rr() {
 213               if echo $1 | grep -q -e '[^0-9.]' ; then
 214                 echo AAAA $1
 215               else
 216                 echo A $1
 217               fi
 218             }
 219
 220             # Update DNS
 221             retries=0
 222             while ! { nsupdate -y "__zone__:__dnssec_key__" -v << EOF
 223             server __dns_ip__
 224             update add sprout-__index__.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 225             update add __index__.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 226             update add sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 227             update add scscf.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 228             update add icscf.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 229             update add sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.sprout.__zone__.
 230             update add _sip._tcp.sprout.__zone__. 30 SRV 0 0 5054 __index__.sprout.__zone__.
 231             update add icscf.sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.icscf.sprout.__zone__.
 232             update add _sip._tcp.icscf.sprout.__zone__. 30 SRV 0 0 5052 __index__.sprout.__zone__.
 233             update add scscf.sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.scscf.sprout.__zone__.
 234             update add _sip._tcp.scscf.sprout.__zone__. 30 SRV 0 0 5054 __index__.sprout.__zone__.
 235             send
 236             EOF
 237             } && [ $retries -lt 10 ]
 238             do
 239               retries=$((retries + 1))
 240               echo 'nsupdate failed - retrying (retry '$retries')...'
 241               sleep 5
 242             done
 243
 244             # Use the DNS server.
 245             echo 'nameserver __dns_ip__' > /etc/dnsmasq.resolv.conf
 246             echo 'RESOLV_CONF=/etc/dnsmasq.resolv.conf' >> /etc/default/dnsmasq
 247             service dnsmasq force-reload
 248
 249 outputs:
 250   sprout_ip:
 251     description: IP address in public network
 252     value: { get_attr: [ sprout_server_0, networks, { get_param: public_net_id }, 0 ] }