Skip to content

Latest commit

 

History

History
348 lines (314 loc) · 20.7 KB

README.md

File metadata and controls

348 lines (314 loc) · 20.7 KB
Raw

What is DAI/DS?

Thank you for your interest in DAI/DS!

DAI/DS (Data Access Interface and Data Store) is a data-centric framework supporting a suite of domain-specific adapters that organizes data gathered from components. The data store is a multi-tier "container" that hosts data defined by UCS (Unified Control System) and made available to components.

DAI/DS and UCS

The Unified Control System (UCS) is intended to be part of a comprehensive software solution for the deployment and management of High Performance Computing (HPC) systems. The control system not only provides the system environment for the execution of applications and their workflows, but also provides the obvious point of control and service for administrators and operation staff who must configure, manage, track, tune, interpret and service the system to maximize availability of resource for the applications.

UCS is a flexible software stack that assists development of new designs by OEMs and system vendors, often from new hardware targeted specifically for HPC. A unique feature of UCS, as compared to previous systems, is integration provided by a data-centric architecture. The control system gathers, organizes, and tracks system data to provide an accurate view of the system at all times. The data is organized by a Data Access Interface (DAI) component, and stored into the Data Store (DS) component. The DAI is an integrating component and is able to glean much of the data it organizes from its interaction with the other components.

https://unifiedcontrolsystem.github.io/

Travis CI     Build Status      Coverity Scan Build Status

The DAI/DS public GitHub project has been integrated with Travis continuous integration.

All pull requests will be built and tested automatically by Travis.

Building Instructions

DAI-DS is a Java 11 application with Python 3.6 command line tool(s). Both methods require internet access to correctly build.

There are 2 ways to build DAI. The first is using docker and is by far the most portable way. The second way is to use a host and install all the prerequisites needed to do the build. Access to the internet is required in both cases but proxies are allowed. In both build cases, the output will appear in <repo_root>/build/ folder will be populated and the distribution files location in <repo_root>/build/distributions/.

Docker Build

This is by far the most portable method. First install and configure docker. The details depend on the specific OS distribution. The general steps are:

  1. Install and configure the docker package via the package manager on the OS (docker has documentation on this: https://docs.docker.com/).

    • Make sure the installed service is running and has internet access
    • Configure all docker users

  2. Get and extract the DAI source tarball or another method to get the DAI source tree.

  3. 'cd' to the extracted source tree's root.

  4. In the source tree at the root do the following (Any proxy in 'http_proxy' environment variable will be honored by the docker build script and execution):

    $ docker-build/docker-build.sh build

    or

    $ ./gradlew dockerBuild

This will build a docker image called 'dai_builder', then run the container doing the ./gradlew build inside. The gradle persistent files for the container will be stored at ~/.gradle/docker. This will save time for subsequent builds.

Host Build

This is more complicated but is more useful for developers.

  1. Make sure the host contains the following packages (actual names vary by OS distribution, the names below are for OpenSuse Leap 15.1): 
    git
rpm-build
python3
python3-devel
python3-pip
python3-setuptools
python3-wheel
java-11-openjdk
java-11-openjdk-devel

NOTE: Examine the docker-build/Dockerfile for how it's done for a docker container.

  1. If a proxy is required for external access then please make sure of the following items:
    • Make sure gradle can access the internet by placing the updated lines in the ~/.gradle/gradle.properties file:
    systemProp.http.proxyHost=<proxy_host>
systemProp.http.proxyPort=<proxy_port>
systemProp.https.proxyHost=<proxy_host>
systemProp.https.proxyPort=<proxy_port>
systemProp.https.proxyUser=<proxy_user_if_needed>
systemProp.https.proxyPassword=<proxy_password_if_needed>
    • Python 3's pip requires the proxy variable 'HTTPS_PROXY' is set to the proxy of the environment the host is inside.
  2. Set the following properties in the ~/.gradle/gradle.properties file: 
    systemProp.includeDebugSymbols=true
  3. Get and extract the DAI source tarball or another method to get the DAI source tree.
  4. 'cd' to the extracted source tree's root.
  5. Build the deployable components. 
    $ ./gradlew build

Run Requirements and Install Instructions (Deployment)

Pre-requisites:

  1. System must have at least 32GB of RAM and 8 cores to run smoothly.
  2. Java 11 JDK
  3. The "curl" program must be installed on DAI-DS hosts.
  4. The "sqlcmd" program must be installed on DAI-DS hosts and accessable via the PATH variable. It is part of the VoltDB install at /opt/voltdb. Indirectly this means voltdb must be install on DAI-DS hosts even if using the voltdb container.
  5. Both docker and docker-compose must be installed and configured for the root user (additional users is optional) if using 3rd party docker components.
  6. ALL configuration files changed to support the target system. This includes:
    • SystemManifest.json
    • MachineConfig.json
    • NearlineConfig.json
    • ProviderMonitoringNetworkForeignBus.json
    • ProviderProvisionerNetworkForeignBus.json
    • LocationTranslationMap.json - If the contents of this file do not correlate with the MachineConfig.json file's contents, the provisioning and monitoring providers may not function as expected. Make sure ALL Foreign names match a DAI name and no "location" is missing or unexpected.
  7. The real target API (or EventSim service) must be available for the ProviderMonitoringNetworkForeignBus and ProviderProvisionerNetworkForeignBus to connect.
  8. If the deployment system for the first use case below does not have internet access you must download and save the following docker images from Docker Hub then copy and reload them onto the target system's local docker repository:
    • postgres:11.4
    • rabbitmq:3.7-management
    • voltdb/voltdb-community:9.2.1
    • openjdk:11.0.5-jdk
  9. Python 3.5 or 3.6 plus the following PIP packages (for hosts installing cli or eventsim-cli):
    • requests
    • clustershell
    • python-dateutil
    • progress
    • texttable
    • timeout-decorator

Packages (.rpm files are shown but there are .deb equivelents if enabled in the build$)

Package NameRequiredDescription
dai-{version}.noarch.rpmYesThis package contains the istallation of the DAI-DS application. A configuration RPM must be installed for the DAI-DS to function correctly.
dai-3rd-party-{version}.noarch.rpmNo*This package contains the docker images and docker-compoose YAML files that are used for testing or quick trials. This includes VoltDB, Postgres DB, and RabbitMQ containers. Starting these contains is turnkey and they will all be ready for use.
dai-cli-{version}.noarch.rpm YesThis package contains the UCS CLI program minus it's configuration. A configuration RPM must be installed.
dai-hw1-config-{version}.noarch.rpm No**This package contains the DAI-DS configuration for hardware configuration #1. Only one configuration can be installed on the DAI-DS host at a time!
dai-hw2-config-{version}.noarch.rpm No**This package contains the DAI-DS configuration for hardware configuration #2. Only one configuration can be installed on the DAI-DS host at a time!
dai-hw3-config-{version}.noarch.rpm No**This package contains the DAI-DS configuration for hardware configuration #3. Only one configuration can be installed on the DAI-DS host at a time!
dai-postgres-schema-{version}.noarch.rpmYes***This package contains stuff to populate the postgres schema. It must be installed on the same server with the postgres database install. This need not be the same location as VoltDB or DAI.
dai-volt-schema-{version}.noarch.rpm Yes***This package contains the schema files and loadable JAR files for VoltDB setup. This does not contain the loadVoltDbInitialData.sh script. This is intended to be loaded on the VoltDB server host where the sqlcmd is present after VoltDB install is completed. The loadVoltDbInitialData.sh script can be run from the DAI-DS installed host remotely to populate the schema with initial data.
EventSim Related
dai-eventsim-server-{version}.noarch.rpmNo**This package contains the EventSim REST server that takes rquests from the EventSim CLI and simulates the target systems behavior wrt telemetry, events, inventory, etc...
dai-eventsim-cli-{version}.noarch.rpm No*This package contains the EventSim CLI for simulating scenarios during simulation. The EventSim configuration RPM must be installed for EventSim to function correctly.
dai-eventsim-config-{version}.noarch.rpmNo*This package contains the DAI-DS configuration for EventSim using a small machine configuration. Only one configuration can be installed on the DAI-DS host at a time!
  • $   To enable Debian compatible packages add "systemProp.includeDebianPackages=true" to your ~/.gradle/gradle.properties file and rebuild DAI-DS.
  • *   When testing with EventSim or using EventSim for evaluation these must be installed. On a real system voltDB, Postgres, and RabbitMQ servers must manually be installed.
  • **  When using Eventsim for trial or testing the EventSim server, EventSim CLI, and EventSim configuration should be installed.
  • *** These are not installed on DAI-DS systems unless DAI-DS is also on a host with the Postgres or VoltDB databases.

Use Cases for Installation

Installation of all DAI-DS packages are in the /opt/ucs/** tree.

NOTE: This single host using eventsim scenario's below run on a single system out-of-the box if you edit the /etc/hosts file and add "am01-nmn.local" and "am01-nmn" as an aliases for the system. Then stop using the services (see below). If you are behind a proxy please make sure that the no_proxy and NO_PROXY environmental variables have the ".local" domain excluded from the proxy lookups. The non-domain alias name "am01-nmn" is required only for the voltdb container to start correctly. Also you must set the hostname to "am01-nmn.local".

Testing and Evaluation on One Host (Docker and Eventsim)

Scenario:
As stated in the title this is a single system for testing or evaluation using docker for third party copmponents.
Install DAI-DS Packages:
  • dai-3rd-party-{version}.noarch.rpm
  • dai-{version}.noarch.rpm
  • dai-cli-{version}.noarch.rpm
  • dai-eventsim-server-{version}.noarch.rpm
  • dai-eventsim-cli-{version}.noarch.rpm
  • dai-eventsim-config-{version}.noarch.rpm
Third Party Component Setup:
  1. # systemctl start dai-postgres.service
  2. # systemctl start dai-rabbitmq.service
  3. # systemctl start dai-voltdb.service
  4. # systemctl start dai-manager.service
  5. # systemctl start dai-eventsim.service

Testing and Evaluation on One Host (Non-Docker and Eventsim)

Scenario:
As stated in the title this is a single system for testing or evaluation without using docker.
Manually Install on your Host:
  • VoltDB 9.1.* or 9.2.*
  • PostgreSQL 11.4.*
  • RabittMQ 3.7.*
Install DAI-DS Packages:
  • dai-postgres-schema-{version}.noarch.rpm
  • dai-volt-schema-{version}.noarch.rpm
  • dai-{version}.noarch.rpm
  • dai-cli-{version}.noarch.rpm
  • dai-eventsim-server-{version}.noarch.rpm
  • dai-eventsim-cli-{version}.noarch.rpm
  • dai-eventsim-config-{version}.noarch.rpm
Third Party Component Setup:
  1. Configure Postgres with users and "dai" database and restart postgres service on your host
  2. Configure and start RabbitMQ on your host
  3. Configure and start VoltDB on your host (make sure both locahhost and management IPs on this host are active)
  4. Populate VoltDB DB by running: /opt/ucs/share/for_voltdb/setupVoltDbSchema.sh
  5. Populate Postgres DB schema by running: /opt/ucs/share/for_postgres/setupInitialPostgresSchema.sh
Start DAI-DS:
  1. # systemctl start dai-manager.service

Fully Separate Installs (Multi-host)

This procedure assumes you have a configuration for you machine layout already defined and called my-config.noarch.rpm.

Scenario:
This scenerio assumes that you have a separate host for each role in the DAI-DS system. We will define a VoltDB server host (voltdb), a RabbitMQ server host (rabbitmq), a Postgres DB server host (postgres), 2 DAI-DS software hosts (dai1 and dai2), and an administrator access node (admin).
Install and Setup postgres Host:
  1. Install PostgreSQL 11.4.* on this host
  2. Configure Postgres with users and "dai" database and restart postgres service on this host
  3. Install dai-postgres-schema-{version}.noarch.rpm
  4. Populate Postgres DB's schema by running: /opt/ucs/share/for_postgres/setupInitialPostgresSchema.sh
Install and Setup voltdb Host:
  1. Install VoltDB 9.2.* on this host
  2. Install dai-volt-schema-{version}.noarch.rpm on this host
  3. Install my-config.noarch.rpm on this host
  4. Configure and start VoltDB on this host (make sure both locahhost and management IPs on this host are active)
  5. Populate VoltDB DB by running: /opt/ucs/share/for_voltdb/setupVoltDbSchema.sh
Install rabbitmq Host:
  1. Install RabittMQ 3.7.*
  2. Configure for remote access and start RabbitMQ on your host
Install dai1 and dai2 Hosts:
  1. Install dai-{version}.noarch.rpm on hosts dai1 and dai2
  2. Install my-config.noarch.rpm on hosts dai1 and dai2
Install admin Host:
  1. Install dai-cli-{version}.noarch.rpm on this host
  2. Install my-config.noarch.rpm on this host
Start DAI-DS on dai1 and dai2:
  1. # systemctl start dai-manager.service

Checking for Running DAI Components:

If your host system has the Java JDK 8 or newer installed (JRE alone is not enough) then there is an included script called show_adapters which will show a detailed list of running DAI-DS java processes. This tool must be run as the root user.

If you don't have a new Java JDK installed, and are using the services then use the normal systemctl tool to check the status of the services.

Log Output:

Log output in either execution case will be in:

  • /opt/ucs/log/* for EventSim and DAI components log files.
  • /opt/ucs/docker/tier1/log/* for voltdb and the schema population containers log files.
  • Postgres logs are not available at this time.

Uninstalling DAI and Third Party Components:

Since all DAI-DS components are RPMs (or debian packages) use the normal method of uninstallation for your distribution. Please not that all services will be stopped gracefully during uninstallation. Log files will remain in the /opt/ucs.** tree.

Notes When Using Docker Containers:

  • Postgres persistent data is stored in /opt/ucs/docker/tier2/data/pgdata
    • To clear the data and start over do the following as root: 
      # systemctl stop dai-manager dai-voltdb dai-rabbitmq dai-postgres
# rm -rf /opt/ucs/docker/tier2/data/pgdata
    • To backup the data (as root): 
      # systemctl stop dai-manager dai-voltdb dai-rabbitmq dai-postgres
# recursively copy/tar /opt/ucs/docker/tier2/data/pgdata
  • If you start all services together with one command, expect errors and restarts of the dai-manager service until all other services are running and setup.

Notes About VoltDB and Huge Memory Pages:

  • If VoltDB fails to start with an error message about improper setting for huge pages in the kernel then do the following to fix the issue:
    • To fix the immediate problem, as root enter the following 2 commands (will not survive a reboot): 
      # echo never >/sys/kernel/mm/transparent_hugepage/enabled
# echo never >/sys/kernel/mm/transparent_hugepage/defrag
    • To make these changes permanent:
      1. Make sure that the sysfsutils package is installed on your system (the host if using VoltDB in a container).
      2. Edit /etc/sysfs.conf and add the following 2 lines to the end of the file:
          kernel/mm/transparent_hugepage/enabled = never
    kernel/mm/transparent_hugepage/defrag = never
      1. Now on reboot, the kernel values will be set correctly for VoltDB.