tutorials/Clearwater_vIMS/heat/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: 2013-05-23
  34
  35 description: >
  36   Clearwater Sprout node
  37
  38 parameters:
  39   vnf_id:
  40     type: string
  41     label: VNF ID
  42     description: The VNF ID provided by ONAP
  43   vf_module_id:
  44     type: string
  45     label: VNF module ID
  46     description: The VNF module ID provided by ONAP
  47   public_net_id:
  48     type: string
  49     description: ID of public network
  50     constraints:
  51       - custom_constraint: neutron.network
  52         description: Must be a valid network ID
  53   sprout_flavor_name:
  54     type: string
  55     description: Flavor to use
  56     constraints:
  57       - custom_constraint: nova.flavor
  58         description: Must be a valid flavor name
  59   sprout_image_name:
  60     type: string
  61     description: Name of image to use
  62   key_name:
  63     type: string
  64     description: Name of keypair to assign
  65     constraints:
  66       - custom_constraint: nova.keypair
  67         description: Must be a valid keypair name
  68 # base_mgmt_security_group:
  69 #   type: string
  70 #   description: ID of base security group for all Clearwater nodes (management)
  71 # sprout_sig_security_group:
  72 #   type: string
  73 #   description: ID of security group for Sprout nodes (signaling)
  74 # sprout_sig2_security_group:
  75 #   type: string
  76 #   description: ID of additional security group for Sprout nodes (signaling)
  77   repo_url:
  78     type: string
  79     description: URL for Clearwater repository
  80     default: http://repo.cw-ngv.com/stable
  81   zone:
  82     type: string
  83     description: DNS zone
  84     default: example.com
  85   dns_ip:
  86     type: string
  87     description: IP address for DNS server on network
  88   dnssec_key:
  89     type: string
  90     description: DNSSEC private key (Base64-encoded)
  91     constraints:
  92       - allowed_pattern: "[0-9A-Za-z+/=]+"
  93         description: Must be Base64-encoded
  94   etcd_ip:
  95     type: string
  96     description: IP address of an existing member of the etcd cluster
  97     default: ""
  98   index:
  99     type: number
 100     description: Index of this Sprout node in the Sprout cluster
 101     default: 0
 102
 103 resources:
 104   server:
 105     type: OS::Nova::Server
 106     properties:
 107       name: { str_replace: { params: { __index__: { get_param: index }, __zone__: { get_param: zone } }, template: sprout-__index__.__zone__ } }
 108       image: { get_param: sprout_image_name }
 109       flavor: { get_param: sprout_flavor_name }
 110       key_name: { get_param: key_name }
 111       networks:
 112         - network: { get_param: public_net_id }
 113       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
 114       user_data_format: RAW
 115       user_data:
 116         str_replace:
 117           params:
 118             __repo_url__: { get_param: repo_url }
 119             __zone__: { get_param: zone }
 120             __dns_ip__: { get_param: dns_ip }
 121             __dnssec_key__: { get_param: dnssec_key }
 122             __etcd_ip__ : { get_param: etcd_ip }
 123             __index__ : { get_param: index }
 124           template: |
 125             #!/bin/bash
 126
 127             # Log all output to file.
 128             exec > >(tee -a /var/log/clearwater-heat-sprout.log) 2>&1
 129             set -x
 130
 131             # Configure the APT software source.
 132             echo 'deb __repo_url__ binary/' > /etc/apt/sources.list.d/clearwater.list
 133             curl -L http://repo.cw-ngv.com/repo_key | apt-key add -
 134             apt-get update
 135
 136             # Get the public IP address from eth0
 137             sudo apt-get install ipcalc
 138             ADDR=`ip addr show eth0 | awk '/inet /{print $2}'`
 139             PUBLIC_ADDR=`ipcalc -n -b $ADDR | awk '/Address:/{print $2}'`
 140
 141             # Configure /etc/clearwater/local_config.
 142             mkdir -p /etc/clearwater
 143             etcd_ip=__etcd_ip__
 144             [ -n "$etcd_ip" ] || etcd_ip=$PUBLIC_ADDR
 145             cat > /etc/clearwater/local_config << EOF
 146             management_local_ip=$PUBLIC_ADDR
 147             local_ip=$PUBLIC_ADDR
 148             public_ip=$PUBLIC_ADDR
 149             public_hostname=__index__.sprout.__zone__
 150             etcd_cluster=$etcd_ip
 151             EOF
 152
 153             # Create /etc/chronos/chronos.conf.
 154             mkdir -p /etc/chronos
 155             cat > /etc/chronos/chronos.conf << EOF
 156             [http]
 157             bind-address = $PUBLIC_ADDR
 158             bind-port = 7253
 159             threads = 50
 160
 161             [logging]
 162             folder = /var/log/chronos
 163             level = 2
 164
 165             [alarms]
 166             enabled = true
 167
 168             [exceptions]
 169             max_ttl = 600
 170             EOF
 171
 172             # Now install the software.
 173             DEBIAN_FRONTEND=noninteractive apt-get install sprout-node --yes --force-yes
 174             DEBIAN_FRONTEND=noninteractive apt-get install clearwater-management --yes --force-yes
 175
 176             # Function to give DNS record type and IP address for specified IP address
 177             ip2rr() {
 178               if echo $1 | grep -q -e '[^0-9.]' ; then
 179                 echo AAAA $1
 180               else
 181                 echo A $1
 182               fi
 183             }
 184
 185             # Update DNS
 186             retries=0
 187             while ! { nsupdate -y "__zone__:__dnssec_key__" -v << EOF
 188             server __dns_ip__
 189             update add sprout-__index__.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 190             update add __index__.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 191             update add sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 192             update add scscf.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 193             update add icscf.sprout.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 194             update add sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.sprout.__zone__.
 195             update add _sip._tcp.sprout.__zone__. 30 SRV 0 0 5054 __index__.sprout.__zone__.
 196             update add icscf.sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.icscf.sprout.__zone__.
 197             update add _sip._tcp.icscf.sprout.__zone__. 30 SRV 0 0 5052 __index__.sprout.__zone__.
 198             update add scscf.sprout.__zone__. 30 NAPTR 0 0 "s" "SIP+D2T" "" _sip._tcp.scscf.sprout.__zone__.
 199             update add _sip._tcp.scscf.sprout.__zone__. 30 SRV 0 0 5054 __index__.sprout.__zone__.
 200             send
 201             EOF
 202             } && [ $retries -lt 10 ]
 203             do
 204               retries=$((retries + 1))
 205               echo 'nsupdate failed - retrying (retry '$retries')...'
 206               sleep 5
 207             done
 208
 209             # Use the DNS server.
 210             echo 'nameserver __dns_ip__' > /etc/dnsmasq.resolv.conf
 211             echo 'RESOLV_CONF=/etc/dnsmasq.resolv.conf' >> /etc/default/dnsmasq
 212             service dnsmasq force-reload
 213
 214 outputs:
 215   public_ip:
 216     description: IP address in public network
 217     value: { get_attr: [ server, accessIPv4 ] }