docs/heat.rst

   1 ONAP HEAT Template
   2 ------------------
   3
   4 Source files
   5 ~~~~~~~~~~~~
   6
   7 - Template file: https://git.onap.org/integration/plain/deployment/heat/onap-rke/onap-oom.yaml
   8 - Environment file: https://git.onap.org/integration/plain/deployment/heat/onap-rke/env/windriver/onap-oom.env
   9
  10 The files are based on the windriver environement used by the integration team.
  11
  12 Description
  13 ~~~~~~~~~~~
  14
  15 The ONAP HEAT template spins up the entire ONAP platform. The template,
  16 onap_openstack.yaml, comes with an environment file,
  17 onap_openstack.env, in which all the default values are defined.
  18
  19 .. note::
  20  onap_openstack.yaml AND onap_openstack.env ARE THE HEAT TEMPLATE
  21  AND ENVIRONMENT FILE CURRENTLY SUPPORTED.
  22  onap_openstack_float.yaml/env AND onap_openstack_nofloat.yaml/env
  23  AREN'T UPDATED AND THEIR USAGE IS NOT SUGGESTED.
  24
  25 The HEAT template is composed of two sections: (i) parameters, and (ii)
  26 resources.
  27 The parameter section contains the declaration and
  28 description of the parameters that will be used to spin up ONAP, such as
  29 public network identifier, URLs of code and artifacts repositories, etc.
  30 The default values of these parameters can be found in the environment
  31 file.
  32
  33 The resource section contains the definition of:
  34
  35 - ONAP Private Management Network, which ONAP components use to communicate with each other and with VNFs
  36 - ONAP Virtual Machines (VMs)
  37 - Public/private key pair used to access ONAP VMs
  38 - Virtual interfaces towards the ONAP Private Management Network
  39 - Disk volumes.
  40
  41 Each VM specification includes Operating System image name, VM size
  42 (i.e. flavor), VM name, etc. Each VM has two virtual network interfaces:
  43 one towards the public network and one towards the ONAP Private
  44 Management network, as described above. Furthermore, each VM runs a
  45 post-instantiation script that downloads and installs software
  46 dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software
  47 packages and docker containers from remote repositories.
  48
  49 When the HEAT template is executed, the Openstack HEAT engine creates
  50 the resources defined in the HEAT template, based on the parameters
  51 values defined in the environment file.
  52
  53 Environment file
  54 ~~~~~~~~~~~~~~~~
  55
  56 Before running HEAT, it is necessary to customize the environment file.
  57 Indeed, some parameters, namely public_net_id, pub_key,
  58 openstack_tenant_id, openstack_username, and openstack_api_key,
  59 need to be set depending on the user's environment:
  60
  61 **Global parameters**
  62
  63 ::
  64
  65  public_net_id:       PUT YOUR NETWORK ID/NAME HERE
  66  pub_key:             PUT YOUR PUBLIC KEY HERE
  67  openstack_tenant_id: PUT YOUR OPENSTACK PROJECT ID HERE
  68  openstack_username:  PUT YOUR OPENSTACK USERNAME HERE
  69  openstack_api_key:   PUT YOUR OPENSTACK PASSWORD HERE
  70  horizon_url:         PUT THE HORIZON URL HERE
  71  keystone_url:        PUT THE KEYSTONE URL HERE (do not include version number)
  72
  73 openstack_region parameter is set to RegionOne (OpenStack default). If
  74 your OpenStack is using another Region, please modify this parameter.
  75
  76 public_net_id is the unique identifier (UUID) or name of the public
  77 network of the cloud provider. To get the public_net_id, use the
  78 following OpenStack CLI command (ext is the name of the external
  79 network, change it with the name of the external network of your
  80 installation)
  81
  82 ::
  83
  84  openstack network list  | grep ext |  awk '{print $2}'
  85
  86 pub_key is string value of the public key that will be installed in
  87 each ONAP VM. To create a public/private key pair in Linux, please
  88 execute the following instruction:
  89
  90 ::
  91
  92  user@ubuntu:~$ ssh-keygen -t rsa
  93
  94 The following operations to create the public/private key pair occur:
  95
  96 ::
  97
  98  Generating public/private rsa key pair.
  99  Enter file in which to save the key (/home/user/.ssh/id_rsa):
 100  Created directory '/home/user/.ssh'.
 101  Enter passphrase (empty for no passphrase):
 102  Enter same passphrase again:
 103  Your identification has been saved in /home/user/.ssh/id_rsa.
 104  Your public key has been saved in /home/user/.ssh/id_rsa.pub.
 105
 106 openstack_username, openstack_tenant_id (password), and
 107 openstack_api_key are user's credentials to access the
 108 OpenStack-based cloud.
 109
 110 **Images and flavors parameters**
 111
 112 ::
 113
 114  ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE
 115  ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE
 116  flavor_small:       PUT THE SMALL FLAVOR NAME HERE
 117  flavor_medium:      PUT THE MEDIUM FLAVOR NAME HERE
 118  flavor_large:       PUT THE LARGE FLAVOR NAME HERE
 119  flavor_xlarge:      PUT THE XLARGE FLAVOR NAME HERE
 120  flavor_xxlarge:     PUT THE XXLARGE FLAVOR NAME HERE
 121
 122 To get the images in your OpenStack environment, use the following
 123 OpenStack CLI command:
 124
 125 ::
 126
 127         openstack image list | grep 'ubuntu'
 128
 129 To get the flavor names used in your OpenStack environment, use the
 130 following OpenStack CLI command:
 131
 132 ::
 133
 134         openstack flavor list
 135
 136 **DNS parameters**
 137
 138 ::
 139
 140  dns_list: PUT THE ADDRESS OFTHE EXTERNAL DNS HERE (e.g. a comma-separated list of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems). THIS LIST MUST INCLUDE THE DNS SERVER THAT OFFERS DNS AS AS SERVICE (see DCAE section below for more details)
 141  external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE oam_network_cidr: 10.0.0.0/16
 142
 143 You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers
 144
 145 **DCAE Parameters**
 146
 147 DCAE spins up ONAP's data collection and analytics system in two phases.
 148 The first is the launching of a bootstrap VM that is specified in the
 149 ONAP Heat template. This VM requires a number of deployment specific
 150 conifiguration parameters being provided so that it can subsequently
 151 bring up the DCAE system. There are two groups of parameters.
 152
 153 The first group relates to the launching of DCAE VMs, including parameters such as
 154 the keystone URL and additional VM image IDs/names. DCAE VMs are
 155 connected to the same internal network as the rest of ONAP VMs, but
 156 dynamically spun up by the DCAE core platform. Hence these parameters
 157 need to be provided to DCAE. Note that although DCAE VMs will be
 158 launched in the same tenant as the rest of ONAP, because DCAE may use
 159 MultiCloud node as the agent for interfacing with the underying cloud,
 160 it needs a separate keystone URL (which points to MultiCloud node
 161 instead of the underlying cloud).
 162
 163 The second group of configuration parameters relate to DNS As A Service support (DNSaaS).
 164 DCAE requires DNSaaS for registering its VMs into organization-wide DNS service. For
 165 OpenStack, DNSaaS is provided by Designate. Designate support can be
 166 provided via an integrated service endpoint listed under the service
 167 catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud
 168 service. For the latter case, a number of parameters are needed to
 169 configure MultiCloud to use the correct Designate service. These
 170 parameters are described below:
 171
 172 ::
 173
 174  dcae_keystone_url: PUT THE KEYSTONE URL OF THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED (Note: put the MultiCloud proxy URL if the DNSaaS is proxyed by MultiCloud)
 175  dcae_centos_7_image: PUT THE CENTOS7 IMAGE ID/NAME AVAILABLE AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED
 176  dcae_security_group: PUT THE SECURITY GROUP ID/NAME TO BE USED AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED
 177  dcae_key_name: PUT THE ACCESS KEY-PAIR NAME REGISTER AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED
 178  dcae_public_key: PUT THE PUBLIC KEY OF A KEY-PAIR USED FOR DCAE BOOTSTRAP NODE TO COMMUNICATE WITH DCAE VMS
 179  dcae_private_key: PUT THE PRIVATE KEY OF A KEY-PAIR USED FOR DCAE BOOTSTRAP NODE TO COMMUNICATE WITH DCAE VMS
 180
 181  dnsaas_config_enabled: true or false FOR WHETHER DNSAAS IS PROXYED
 182  dnsaas_region: PUT THE REGION OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED
 183  dnsaas_tenant_id: PUT THE TENANT ID/NAME OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED
 184  dnsaas_keystone_url: PUT THE KEYSTONE URL OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED
 185  dnsaas_username: PUT THE USERNAME OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED
 186  dnsaas_password: PUT THE PASSWORD OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED
 187
 188 Instantiation
 189 ~~~~~~~~~~~~~
 190
 191 The ONAP platform can be instantiated via Horizon (OpenStack dashboard)
 192 or Command Line.
 193
 194 **Instantiation via Horizon:**
 195
 196 - Login to Horizon URL with your personal credentials
 197 - Click "Stacks" from the "Orchestration" menu
 198 - Click "Launch Stack"
 199 - Paste or manually upload the HEAT template file (onap_openstack.yaml) in the "Template Source" form
 200 - Paste or manually upload the HEAT environment file (onap_openstack.env) in the "Environment Source" form
 201 - Click "Next" - Specify a name in the "Stack Name" form
 202 - Provide the password in the "Password" form
 203 - Click "Launch"
 204
 205 **Instantiation via Command Line:**
 206
 207 - Install the HEAT client on your machine, e.g. in Ubuntu (ref. http://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html):
 208
 209 ::
 210
 211  apt-get install python-dev python-pip
 212  pip install python-heatclient        # Install heat client
 213  pip install python-openstackclient   # Install the Openstack client to support multiple services
 214
 215 -  Create a file (named i.e. ~/openstack/openrc) that sets all the
 216    environmental variables required to access Rackspace:
 217
 218 ::
 219
 220  export OS_AUTH_URL=INSERT THE AUTH URL HERE
 221  export OS_USERNAME=INSERT YOUR USERNAME HERE
 222  export OS_TENANT_ID=INSERT YOUR TENANT ID HERE
 223  export OS_REGION_NAME=INSERT THE REGION HERE
 224  export OS_PASSWORD=INSERT YOUR PASSWORD HERE
 225
 226 -  Run the script from command line:
 227
 228 ::
 229
 230  source ~/openstack/openrc
 231
 232 -  In order to install the ONAP platform, type:
 233
 234 ::
 235
 236  heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE       # Old HEAT client, OR
 237  openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME  # New Openstack client