heat/vIMS/homer.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 Homer 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   homer_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   homer_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 management 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   homer_random_str:
  94     type: OS::Heat::RandomString
  95     properties:
  96       length: 4
  97
  98   homer_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: homer_sg_
 107             base: { get_param: vnf_name }
 108             rand: { get_resource: homer_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: 7888, port_range_max: 7888},
 115         {remote_ip_prefix: 0.0.0.0/0, protocol: icmp}]
 116
 117   homer_admin_port_0:
 118     type: OS::Neutron::Port
 119     properties:
 120       name:
 121         str_replace:
 122           template: pre_base_rand
 123           params:
 124             pre: homer_admin_port_0_
 125             base: { get_param: vnf_name }
 126             rand: { get_resource: homer_random_str }
 127       network: { get_param: public_net_id }
 128       security_groups: [{ get_resource: homer_security_group }]
 129
 130   homer_server_0:
 131     type: OS::Nova::Server
 132     properties:
 133       name:
 134         str_replace:
 135           template: pre_base_rand
 136           params:
 137             pre: homer_server_0_
 138             base: { get_param: vnf_name }
 139             rand: { get_resource: homer_random_str }
 140       image: { get_param: homer_image_name }
 141       flavor: { get_param: homer_flavor_name }
 142       key_name: { get_param: key_name }
 143       networks:
 144         - port: { get_resource: homer_admin_port_0 }
 145       metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }, vnf_name: { get_param: vnf_name }}
 146       user_data_format: RAW
 147       user_data:
 148         str_replace:
 149           params:
 150             __repo_url__: { get_param: repo_url }
 151             __zone__: { get_param: zone }
 152             __dns_ip__: { get_param: dns_ip }
 153             __dnssec_key__: { get_param: dnssec_key }
 154             __etcd_ip__ : { get_param: etcd_ip }
 155             __index__ : 0
 156           template: |
 157             #!/bin/bash
 158
 159             # Log all output to file.
 160             exec > >(tee -a /var/log/clearwater-heat-homer.log) 2>&1
 161             set -x
 162
 163             # Configure the APT software source.
 164             echo 'deb __repo_url__ binary/' > /etc/apt/sources.list.d/clearwater.list
 165             curl -L http://repo.cw-ngv.com/repo_key | apt-key add -
 166             apt-get update
 167
 168             # Get the public IP address from eth0
 169             sudo apt-get install ipcalc
 170             ADDR=`ip addr show eth0 | awk '/inet /{print $2}'`
 171             PUBLIC_ADDR=`ipcalc -n -b $ADDR | awk '/Address:/{print $2}'`
 172
 173             # Configure /etc/clearwater/local_config.
 174             mkdir -p /etc/clearwater
 175             etcd_ip=__etcd_ip__
 176             [ -n "$etcd_ip" ] || etcd_ip=$PUBLIC_ADDR
 177             cat > /etc/clearwater/local_config << EOF
 178             management_local_ip=$PUBLIC_ADDR
 179             local_ip=$PUBLIC_ADDR
 180             public_ip=$PUBLIC_ADDR
 181             public_hostname=homer-__index__.__zone__
 182             etcd_cluster=$etcd_ip
 183             EOF
 184
 185             # Now install the software.
 186             DEBIAN_FRONTEND=noninteractive apt-get install homer --yes --force-yes
 187             DEBIAN_FRONTEND=noninteractive apt-get install clearwater-management --yes --force-yes
 188
 189             # Function to give DNS record type and IP address for specified IP address
 190             ip2rr() {
 191               if echo $1 | grep -q -e '[^0-9.]' ; then
 192                 echo AAAA $1
 193               else
 194                 echo A $1
 195               fi
 196             }
 197
 198             # Update DNS
 199             retries=0
 200             while ! { nsupdate -y "__zone__:__dnssec_key__" -v << EOF
 201             server __dns_ip__
 202             update add homer-__index__.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 203             update add homer.__zone__. 30 $(ip2rr $PUBLIC_ADDR)
 204             send
 205             EOF
 206             } && [ $retries -lt 10 ]
 207             do
 208               retries=$((retries + 1))
 209               echo 'nsupdate failed - retrying (retry '$retries')...'
 210               sleep 5
 211             done
 212
 213             # Use the DNS server.
 214             # Use the DNS server.
 215             echo 'nameserver __dns_ip__' > /etc/dnsmasq.resolv.conf
 216             echo 'RESOLV_CONF=/etc/dnsmasq.resolv.conf' >> /etc/default/dnsmasq
 217             service dnsmasq force-reload
 218
 219
 220 outputs:
 221   homer_ip:
 222     description: IP address in public network
 223     value: { get_attr: [ homer_server_0, networks, { get_param: public_net_id }, 0 ] }