Installation High-Level Overview - Bare Metal Deployment
========================================================

The setup presumes that you have 6 or more bare metal servers already setup
with network connectivity on at least 1 or more network interfaces for all
servers via a TOR switch or other network implementation.

The physical TOR switches are **not** automatically configured from the OPNFV
reference platform.  All the networks involved in the OPNFV infrastructure as
well as the provider networks and the private tenant VLANs needs to be manually
configured.

The Jumphost can be installed using the bootable ISO or by using the
(``opnfv-apex*.rpm``) RPMs and their dependencies.  The Jumphost should then be
configured with an IP gateway on its admin or public interface and configured
with a working DNS server.  The Jumphost should also have routable access
to the lights out network for the overcloud nodes.

``opnfv-deploy`` is then executed in order to deploy the undercloud VM and to
provision the overcloud nodes.  ``opnfv-deploy`` uses three configuration files
in order to know how to install and provision the OPNFV target system.
The information gathered under section
`Execution Requirements (Bare Metal Only)`_ is put into the YAML file
``/etc/opnfv-apex/inventory.yaml`` configuration file.  Deployment options are
put into the YAML file ``/etc/opnfv-apex/deploy_settings.yaml``.  Alternatively
there are pre-baked deploy_settings files available in ``/etc/opnfv-apex/``.
These files are named with the naming convention
os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in place
of the ``/etc/opnfv-apex/deploy_settings.yaml`` file if one suites your
deployment needs.  Networking definitions gathered under section
`Network Requirements`_ are put into the YAML file
``/etc/opnfv-apex/network_settings.yaml``.  ``opnfv-deploy`` will boot the
undercloud VM and load the target deployment configuration into the
provisioning toolchain.  This information includes MAC address, IPMI,
Networking Environment and OPNFV deployment options.

Once configuration is loaded and the undercloud is configured it will then
reboot the overcloud nodes via IPMI.  The nodes should already be set to PXE
boot first off the admin interface.  The nodes will first PXE off of the
undercloud PXE server and go through a discovery/introspection process.

Introspection boots off of custom introspection PXE images. These images are
designed to look at the properties of the hardware that is being booted
and report the properties of it back to the undercloud node.

After introspection the undercloud will execute a Heat Stack Deployment to
continue node provisioning and configuration.  The nodes will reboot and PXE
from the undercloud PXE server again to provision each node using Glance disk
images provided by the undercloud.  These disk images include all the necessary
packages and configuration for an OPNFV deployment to execute.  Once the disk
images have been written to node's disks the nodes will boot locally and
execute cloud-init which will execute the final node configuration. This
configuration is largly completed by executing a puppet apply on each node.

Installation High-Level Overview - VM Deployment
================================================

The VM nodes deployment operates almost the same way as the bare metal
deployment with a few differences mainly related to power management.
``opnfv-deploy`` still deploys an undercloud VM. In addition to the undercloud
VM a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1
control node and 1 or more compute nodes for a Non-HA Deployment) will be
defined for the target OPNFV deployment.  The part of the toolchain that
executes IPMI power instructions calls into libvirt instead of the IPMI
interfaces on baremetal servers to operate the power managment.  These VMs are
then provisioned with the same disk images and configuration that baremetal
would be.

To Triple-O these nodes look like they have just built and registered the same
way as bare metal nodes, the main difference is the use of a libvirt driver for
the power management.

Installation Guide - Bare Metal Deployment
==========================================

This section goes step-by-step on how to correctly install and provision the
OPNFV target system to bare metal nodes.

Install Bare Metal Jumphost
---------------------------

1a. If your Jumphost does not have CentOS 7 already on it, or you would like to
    do a fresh install, then download the Apex bootable ISO from the OPNFV
    artifacts site <http://artifacts.opnfv.org/apex.html>.  There have been
    isolated reports of problems with the ISO having trouble completing
    installation successfully. In the unexpected event the ISO does not work
    please workaround this by downloading the CentOS 7 DVD and performing a
    "Virtualization Host" install.  If you perform a "Minimal Install" or
    install type other than "Virtualization Host" simply run
    ``sudo yum groupinstall "Virtualization Host"``
    ``chkconfig libvirtd on && reboot``
    to install virtualzation support and enable libvirt on boot. If you use the
    CentOS 7 DVD proceed to step 1b once the CentOS 7 with "Virtualzation Host"
    support is completed.

1b. If your Jump host already has CentOS 7 with libvirt running on it then
    install the install the RDO Newton Release RPM and epel-release:

    ``sudo yum install https://repos.fedorapeople.org/repos/openstack/openstack-newton/rdo-release-newton-4.noar
{
  "id": 38,
  "title": "Yardstick-TC046",
  "originalTitle": "Yardstick-TC046",
  "tags": [
    "yardstick-tc"
  ],
  "style": "dark",
  "timezone": "browser",
  "editable": true,
  "hideControls": false,
  "sharedCrosshair": false,
  "rows": [
    {
      "collapse": false,
      "editable": true,
      "height": "",
      "panels": [
        {
          "content": "<h5 style=\"font-family:Verdana\"> <a style=\"color:#31A7D3\"><center>OPNFV_Yardstick_TC046 - Control Node Openstack Service High Availability - Keystone </center> </a></h5>\n<center>\n<p>This test case will verify the high availability of the user service provided by OpenStack (keystone) on control node. For more information see <a style=\"color:#31A7D3\"; href=\"http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/opnfv_yardstick_tc046.html\">TC046</a></p>\n</center>\n\n\n",
          "editable": true,
          "error": false,
          "id": 6,
          "isNew": true,
          "links": [],
          "mode": "html",
          "span": 12,
          "style": {},
          "title": "",
          "type": "text"
        }
      ],
      "title": "New row"
    },
    {
      "collapse": false,
      "editable": true,
      "height": "",
      "panels": [
        {
          "content": "",
          "editable": true,
          "error": false,
          "id": 9,
          "isNew": true,
          "links": [],
          "mode": "markdown",
          "span": 12,
          "style": {},
          "title": "Test Case Execution",
          "type": "text"
        }
      ],
      "title": "New row"
    },
    {
      "collapse": false,
      "editable": true,
      "height": "300px",
      "panels": [
        {
          "aliasColors": {},
          "bars": false,
          "datasource": "yardstick-vtc",
          "decimals": 2,
          "editable": true,
          "error": false,
          "fill": 1,
          "grid": {
            "leftLogBase": 1,
            "leftMax": null,
            "leftMin": null,
            "rightLogBase": 1,
            "rightMax": null,
            "rightMin": null,
            "threshold1": null,
            "threshold1Color": "rgba(216, 200, 27, 0.27)",
            "threshold2": null,
            "threshold2Color": "rgba(234, 112, 112, 0.22)"
          },
          "hideTimeOverride": false,
          "id": 1,
          "interval": "",
          "isNew": true,
          "leftYAxisLabel": "sla_pass",
          "legend": {
            "alignAsTable": true,
            "avg": true,
            "current": false,
            "hideEmpty": false,
            "hideZero": false,
            "max": true,
            "min": true,
            "rightSide": false,
            "show": true,
            "sort": "avg",
            "sortDesc": false,
            "total": false,
            "values": true
          },
          "lines": true,
          "linewidth": 2,
          "links": [],
          "nullPointMode": "connected",
          "percentage": false,
          "pointradius": 5,
          "points": false,
          "renderer": "flot",
          "rightYAxisLabel": "",
          "seriesOverrides": [],
          "span": 12,
          "stack": false,
          "steppedLine": false,
          "targets": [
            {
              "alias": "$tag_pod_name - $tag_deploy_scenario",
              "dsType": "influxdb",
              "groupBy": [
                {
                  "params": [
                    "pod_name"
                  ],
                  "type": "tag"
                },
                {
                  "params": [
                    "task_id"
                  ],
                  "type": "tag"
                },
                {
                  "params": [
                    "deploy_scenario"
                  ],
                  "type": "tag"
                }
              ],
              "hide": false,
              "measurement": "opnfv_yardstick_tc046",
              "query": "SELECT \"sla_pass\" FROM \"opnfv_yardstick_tc046\" WHERE \"pod_name\" =~ /$POD$/ AND \"deploy_scenario\" =~ /$SCENARIO$/ AND $timeFilter GROUP BY \"pod_name\", \"task_id\", \"deploy_scenario\"",
              "refId": "A",
              "resultFormat": "time_series",
              "select": [
                [
                  {
                    "params": [
                      "sla_pass"
                    ],
                    "type": "field"
                  }
                ]
              ],
              "tags": [
                {
                  "key": "pod_name",
                  "operator": "=~",
                  "value": "/$POD$/"
                },
                {
                  "condition": "AND",
                  "key": "deploy_scenario",
                  "operator": "=~",
                  "value": "/$SCENARIO$/"
                }
              ]
            }
          ],
          "timeFrom": "7d",
          "timeShift": null,
          "title": "SLA PASS",
          "tooltip": {
            "shared": true,
            "value_type": "cumulative"
          },
          "type": "graph",
          "x-axis": true,
          "y-axis": true,
          "y_formats": [
            "none",
            "short"
          ]
        }
      ],
      "showTitle": false,
      "title": "Row"
    },
    {
      "collapse": false,
      "editable": true,
      "height": "",
      "panels": [
        {
          "content": "",
          "editable": true,
          "error": false,
          "id": 10,
          "isNew": true,
          "links": [],
          "mode": "markdown",
          "span": 12,
          "style": {},
          "title": "Daily Averages",
          "type": "text"
        }
      ],
      "title": "New row"
    },
    {
      "collapse": false,
      "editable": true,
      "height": "",
      "panels": [
        {
          "columns": [],
          "datasource": "yardstick-vtc",
          "editable": true,
          "error": false,
          "fontSize": "90%",
          "height": "",
          "id": 2,
          "isNew": true,
          "links": [],
          "minSpan": 2,
          "pageSize": 100,
          "repeat": "POD",
          "scopedVars": {
            "POD": {
              "selected": true,
              "text": "lf-pod2",
              "value": "lf\\-pod2"
            }
          },
          "scroll": true,
          "showHeader": true,
          "sort": {
            "col": 2,
            "desc": false
          },
          "span": 12,
          "styles": [
            {
              "dateFormat": "YYYY-MM-DD HH:mm:ss",
              "pattern": "Time",
              "type": "date"
            },
            {
              "colorMode": null,
              "colors": [
                "rgba(245, 54, 54, 0.9)",
                "rgba(237, 129, 40, 0.89)",
                "rgba(50, 172, 45, 0.97)"
              ],
              "decimals": 2,
              "pattern": "deploy_scenario",
              "thresholds": [],
              "type": "string",
              "unit": "short"
            },
            {
              "colorMode": null,
              "colors": [
                "rgba(245, 54, 54, 0.9)",
                "rgba(237, 129, 40, 0.89)",
                "rgba(50, 172, 45, 0.97)"
              ],
              "dateFormat": "YYYY-MM-DD HH:mm:ss",
              "decimals": 2,
              "pattern": "/.*/",
              "thresholds": [],
              "type": "number",
              "unit": "ms"
            }
          ],
          "targets": [
            {
              "alias": "",
              "dsType": "influxdb",
              "groupBy": [
                {
                  "params": [
                    "deploy_scenario"
                  ],
                  "type": "tag"
                }
              ],
              "measurement": "opnfv_yardstick_tc046",
              "query": "SELECT mean(\"rtt.ares\") FROM \"opnfv_yardstick_tc046\" WHERE \"pod_name\" =~ /$POD$/ AND \"deploy_scenario\" =~ /$SCENARIO$/ AND $timeFilter GROUP BY \"deploy_scenario\"",
              "rawQuery": false,
              "refId": "A",
              "resultFormat": "table",
              "select": [
                [
                  {
                    "params": [
                      "rtt.ares"
                    ],
                    "type": "field"
                  },
                  {
                    "params": [],
                    "type": "mean"
                  }
                ]
              ],
              "tags": [
                {
                  "key": "pod_name",
                  "operator": "=~",
                  "value": "/$POD$/"
                },
                {
                  "condition": "AND",
                  "key": "deploy_scenario",
                  "operator": "=~",
                  "value": "/$SCENARIO$/"
                }
              ]
            }
          ],
          "timeFrom": "7d",
          "title": "$POD",
          "transform": "table",
          "transparent": false,
          "type": "table"
        }
      ],
      "showTitle": false,
      "title": "New row"
    },
    {
      "collapse": false,
      "editable": true,
      "height": "250px",
      "panels": [
        {
          "aliasColors": {},
          "bars": false,
          "datasource": "yardstick-vtc",
          "editable": true,
          "error": false,
          "fill": 1,
          "grid": {
            "leftLogBase": 1,
            "leftMax": null,
            "leftMin": 0,
            "rightLogBase": 1,
            "rightMax": null,
            "rightMin": null,
            "threshold1": null,
            "threshold1Color": "rgba(216, 200, 27, 0.27)",
            "threshold2": null,
            "threshold2Color": "rgba(234, 112, 112, 0.22)"
          },
          "height": "",
          "id": 3,
          "interval": "",
          "isNew": true,
          "leftYAxisLabel": "<sla_pass>",
          "legend": {
            "alignAsTable": false,
            "avg": false,
            "current": false,
            "hideEmpty": false,
            "hideZero": false,
            "max": false,
            "min": false,
            "rightSide": false,
            "show": true,
            "total": false,
            "values": false
          },
          "lines": true,
          "linewidth": 1,
          "links": [],
          "minSpan": 2,
          "nullPointMode": "connected",
          "percentage": false,
          "pointradius": 1,
          "points": true,
          "renderer": "flot",
          "repeat": "POD",
          "scopedVars": {
            "POD": {
              "selected": true,
              "text": "lf-pod2",
              "value": "lf\\-pod2"
            }
          },
          "seriesOverrides": [
            {
              "alias": "os-odl_l2-nofeature-ha",
              "color": "#7EB26D"
            },
            {
              "alias": "os-nosdn-nofeature-ha",
              "color": "#E24D42"
            },
            {
              "alias": "os-onos-nofeature-ha",
              "color": "#6ED0E0"
            },
            {
              "alias": "os-nosdn-ovs-ha",
              "color": "#EAB839"
            },
            {
              "alias": "os-odl_l3-nofeature-ha",
              "color": "#E5A8E2"
            },
            {
              "alias": "os-odl_l2-bgpvpn-ha",
              "color": "#E0752D"
            },
            {
              "alias": "os-odl_l2-sfc-ha",
              "color": "#508642"
            }
          ],
          "span": 12,
          "stack": false,
          "steppedLine": false,
          "targets": [
            {
              "alias": "$tag_deploy_scenario",
              "dsType": "influxdb",
              "groupBy": [
                {
                  "params": [
                    "24h"
                  ],
                  "type": "time"
                },
                {
                  "params": [
                    "deploy_scenario"
                  ],
                  "type": "tag"
                },
                {
                  "params": [
                    "pod_name"
                  ],
                  "type": "tag"
                },
                {
                  "params": [
                    "null"
                  ],
                  "type": "fill"
                }
              ],
              "measurement": "opnfv_yardstick_tc046",
              "query": "SELECT mean(\"sla_pass\") FROM \"opnfv_yardstick_tc046\" WHERE \"pod_name\" =~ /$POD$/ AND \"deploy_scenario\" =~ /$SCENARIO$/ AND $timeFilter GROUP BY time(24h), \"deploy_scenario\", \"pod_name\" fill(null)",
              "rawQuery": false,
              "refId": "A",
              "resultFormat": "time_series",
              "select": [
                [
                  {
                    "params": [
                      "sla_pass"
                    ],
                    "type": "field"
                  },
                  {
                    "params": [],
                    "type": "mean"
                  }
                ]
              ],
              "tags": [
                {
                  "key": "pod_name",
                  "operator": "=~",
                  "value": "/$POD$/"
                },
                {
                  "condition": "AND",
                  "key": "deploy_scenario",
                  "operator": "=~",
                  "value": "/$SCENARIO$/"
                }
              ]
            }
          ],
          "timeFrom": "7d",
          "timeShift": null,
          "title": "$POD",
          "tooltip": {
            "shared": true,
            "value_type": "individual"
          },
          "type": "graph",
          "x-axis": true,
          "y-axis": true,
          "y_formats": [
            "none",
            "short"
          ]
        }
      ],
      "showTitle": false,
      "title": ""
    }
  ],
  "time": {
    "from": "now-7d",
    "to": "now"
  },
  "timepicker": {
    "now": true,
    "refresh_intervals": [
      "5s",
      "10s",
      "30s",
      "1m",
      "5m",
      "15m",
      "30m",
      "1h",
      "2h",
      "1d"
    ],
    "time_options": [
      "5m",
      "15m",
      "1h",
      "6h",
      "12h",
      "24h",
      "2d",
      "7d",
      "30d"
    ]
  },
  "templating": {
    "list": [
      {
        "allFormat": "regex values",
        "current": {
          "tags": [],
          "text": "lf-pod2",
          "value": "lf\\-pod2"
        },
        "datasource": "yardstick-vtc",
        "hideLabel": false,
        "includeAll": true,
        "label": "",
        "multi": true,
        "multiFormat": "regex values",
        "name": "POD",
        "options": [
          {
            "selected": false,
            "text": "All",
            "value": "(elxg482ls42|ericsson\\-pod1|ericsson\\-pod2|huawei\\-pod1|huawei\\-pod2|huawei\\-us\\-deploy\\-bare\\-1|intel\\-pod5|intel\\-pod6|lf\\-pod1|lf\\-pod2|opnfv\\-jump\\-1|opnfv\\-jump\\-2|orange\\-fr\\-pod2|unknown|zte\\-pod1)"
          },
          {
            "selected": false,
            "text": "elxg482ls42",
            "value": "elxg482ls42"
          },
          {
            "selected": false,
            "text": "ericsson-pod1",
            "value": "ericsson\\-pod1"
          },
          {
            "selected": false,
            "text": "ericsson-pod2",
            "value": "ericsson\\-pod2"
          },
          {
            "selected": false,
            "text": "huawei-pod1",
            "value": "huawei\\-pod1"
          },
          {
            "selected": false,
            "text": "huawei-pod2",
            "value": "huawei\\-pod2"
          },
          {
            "selected": false,
            "text": "huawei-us-deploy-bare-1",
            "value": "huawei\\-us\\-deploy\\-bare\\-1"
          },
          {
            "selected": false,
            "text": "intel-pod5",
            "value": "intel\\-pod5"
          },
          {
            "selected": false,
            "text": "intel-pod6",
            "value": "intel\\-pod6"
          },
          {
            "selected": false,
            "text": "lf-pod1",
            "value": "lf\\-pod1"
          },
          {
            "selected": true,
            "text": "lf-pod2",
            "value": "lf\\-pod2"
          },
          {
            "selected": false,
            "text": "opnfv-jump-1",
            "value": "opnfv\\-jump\\-1"
          },
          {
            "selected": false,
            "text": "opnfv-jump-2",
            "value": "opnfv\\-jump\\-2"
          },
          {
            "selected": false,
            "text": "orange-fr-pod2",
            "value": "orange\\-fr\\-pod2"
          },
          {
            "selected": false,
            "text": "unknown",
            "value": "unknown"
          },
          {
            "selected": false,
            "text": "zte-pod1",
            "value": "zte\\-pod1"
          }
        ],
        "query": "SHOW TAG VALUES WITH KEY = \"pod_name\"",
        "refresh": false,
        "regex": "",
        "type": "query",
        "useTags": false
      },
      {
        "allFormat": "regex values",
        "current": {
          "tags": [],
          "text": "All",
          "value": "(os\\-nosdn\\-nofeature\\-ha|os\\-nosdn\\-ovs\\-ha|os\\-odl_l2\\-bgpvpn\\-ha|os\\-odl_l2\\-nofeature\\-ha|os\\-odl_l2\\-nofeature\\-noha|os\\-odl_l2\\-sfc\\-ha|os\\-odl_l3\\-nofeature\\-ha|os\\-onos\\-nofeature\\-ha)"
        },
        "datasource": "yardstick-vtc",
        "hideLabel": false,
        "includeAll": true,
        "label": "",
        "multi": true,
        "multiFormat": "regex values",
        "name": "SCENARIO",
        "options": [
          {
            "selected": true,
            "text": "All",
            "value": "(os\\-nosdn\\-nofeature\\-ha|os\\-nosdn\\-ovs\\-ha|os\\-odl_l2\\-bgpvpn\\-ha|os\\-odl_l2\\-nofeature\\-ha|os\\-odl_l2\\-nofeature\\-noha|os\\-odl_l2\\-sfc\\-ha|os\\-odl_l3\\-nofeature\\-ha|os\\-onos\\-nofeature\\-ha)"
          },
          {
            "selected": false,
            "text": "os-nosdn-nofeature-ha",
            "value": "os\\-nosdn\\-nofeature\\-ha"
          },
          {
            "selected": false,
            "text": "os-nosdn-ovs-ha",
            "value": "os\\-nosdn\\-ovs\\-ha"
          },
          {
            "selected": false,
            "text": "os-odl_l2-bgpvpn-ha",
            "value": "os\\-odl_l2\\-bgpvpn\\-ha"
          },
          {
            "selected": false,
            "text": "os-odl_l2-nofeature-ha",
            "value": "os\\-odl_l2\\-nofeature\\-ha"
          },
          {
            "selected": false,
            "text": "os-odl_l2-nofeature-noha",
            "value": "os\\-odl_l2\\-nofeature\\-noha"
          },
          {
            "selected": false,
            "text": "os-odl_l2-sfc-ha",
            "value": "os\\-odl_l2\\-sfc\\-ha"
          },
          {
            "selected": false,
            "text": "os-odl_l3-nofeature-ha",
            "value": "os\\-odl_l3\\-nofeature\\-ha"
          },
          {
            "selected": false,
            "text": "os-onos-nofeature-ha",
            "value": "os\\-onos\\-nofeature\\-ha"
          }
        ],
        "query": "SHOW TAG VALUES WITH KEY = \"deploy_scenario\"",
        "refresh": false,
        "regex": "",
        "type": "query",
        "useTags": false
      }
    ]
  },
  "annotations": {
    "list": []
  },
  "refresh": "15m",
  "schemaVersion": 8,
  "version": 9,
  "links": []
}