Skip to content
This repository has been archived by the owner on Oct 16, 2020. It is now read-only.

Commit

Permalink
docs: Update Introduction (#58)
Browse files Browse the repository at this point in the history
* docs: Update Introduction

Update Introduction section of Intro-setup.rst

* fix: Miscellaneous formatting and spelling

* fix: Remove errant ':' character
  • Loading branch information
rayjh committed Mar 15, 2018
1 parent 97e6175 commit 3bf8216
Showing 1 changed file with 64 additions and 55 deletions.
119 changes: 64 additions & 55 deletions docs/Intro-Setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,83 +3,89 @@
Introduction
============

OpenPOWER Cluster Genesis (OPCG) enables greatly simplified configuration of clusters of
Cluster POWER-Up enables greatly simplified configuration of clusters of
bare metal OpenPOWER servers running Linux. It leverages widely used open
source tools such as Cobbler, Ansible and Python. Because it relies
solely on industry standard protocols such as IPMI and PXE boot, hybrid
clusters of OpenPOWER and x86 nodes can readily be supported. Currently
OPCG supports Ethernet networking with separate data and management
networks. OPCG can configure simple flat networks for typical HPC
Cluster POWER-Up supports Ethernet networking. Cluster POWER-Up can
configure simple flat networks for typical HPC
environments or more advanced networks with VLANS and bridges for
OpenStack environments. OPCG also configures the switches in the
cluster. Currently Mellanox SX1410 is supported for the data network and
the Lenovo G8052 is supported for the management network.
OpenStack environments. Complex heterogenous clusters can be easily deployed
using POWER-Up's interface and node templates. Cluster POWER-Up configures
the switches in the cluster with support for multiple switch vendors.

Overview
--------

OPCG is designed to be easy to use. If you are implementing one of the
supported architectures with supported hardware, OPCG eliminates the
need for custom scripts or programming. It does this via a configuration
file (config.yml) which drives the cluster configuration. The
configuration file is a yaml text file which the user edits. Example
YAML files are included. The configuration process is driven from a
"deployer" node which does not need to remain in the cluster when
finished. The process is as follows;
Cluster POWER-Up is designed to be easy to use. If you are implementing
one of the supported architectures with supported hardware, it eliminates
the need for custom scripts or programming. It does this via a text
configuration file (config.yml) which drives the cluster configuration.
The configuration file is a YAML text file which the user edits. Several
example config files are included docs directory. The configuration
process is driven from a "deployer" node which can be removed from the
cluster when finished. The POWER-Up process is as follows;

#. Rack and cable the hardware.
#. Initialize hardware.

- initialize switches with static ip address, userid and password.
- initialize switches with static IP address, userid and password.
- insure that all cluster compute nodes are set to obtain a DHCP
address on their BMC ports.
address on their BMC ports and they are configured to support
PXE boot on one of their network adapters.

#. Install the OpenPOWER Cluster Genesis software on the deployer node.
#. Edit an existing config.yml file.
#. Run the OPCG software
#. Power on the cluster compute nodes.
#. Install the Cluster POWER-Up software on the deployer node.
#. Edit an existing config.yml file to drive the configuration.
#. Run the POWER-Up software

When finished, OPCG generates a YAML formatted inventory file which can
When finished, Cluster POWER-Up generates a YAML formatted inventory file
with detailed information about your cluster nodes. This file can
be read by operational management software and used to seed
configuration files needed for installing a solution software stack.

Hardware and Architecture Overview
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The OpenPOWER Cluster Genesis software supports clusters of servers
The POWER-Up software supports clusters of servers
interconnected with Ethernet. The
servers must support IPMI and PXE boot. Currently single racks with single
or redundant data switches (with MLAG) are supported. Multiple racks can
be interconnected with traditional two tier access-aggregation
networking. In the future we plan to support two tier leaf-spine networks
with L3 interconnect capable of supporting VXLAN.
servers must support IPMI and PXE boot. Multiple racks can
be configured with traditional two tier access-aggregation
networking. POWER-Up configures both a management and
data network. In simple / cost sensitive setups, the management
and data networks can be configured on the same physical switch.
Power-Up can configure VLANs and bonded networks with as many ports
as the hardware supports. Redundant data switches (ie MLAG) are also
supported. (Currently only implemented on Mellanox switches.)

Networking
~~~~~~~~~~

The data network is implemented using the Mellanox SX1410 10 Gb switch.
Currently OPCG supports up to four ethernet interfaces. These interfaces
can be bonded in pairs with support for LAG or MLAG.

Templates are used to define multiple network configurations in the config.yml file.
These can be physical ports, bonded ports, Linux bridges or vLANS. Physical ports can be
renamed to ease installation of additional software stack elements.

Management and/or Data switches can be set to "passive" mode to allow
deployment without supplying login credentials to the switch management
interfaces. This mode requires the user to manually write switch MAC address
tables to file and to configure the management and/or data switch in accordance
with the defined networks. The client networks will still be configured by
Cluster Genesis.
Cluster POWER-Up supports Cisco, Mellanox and Lenovo switches. Not all
functionality is enabled on all switch types. Currently redundant
networking (MLAG) is only implemented on Mellanox switches. Port channel
support is only implemented on Cisco (NX-OS) and Mellanox switches.
POWER-Up can configure any number of node interfaces on cluster nodes.
To facilitate installation of higher level software, interfaces can be
optionally renamed.

Interface templates are used to define network configurations
in the config.yml file. These can be physical ports, bonded ports,
Linux bridges or VLANS. Interface templates can be entered using
Ubuntu or Red Hat network configuration syntax. Once defined, interface
templates can be applied to any node template. Node interfaces can
optionally be configured with static IP addresses. These can be assigned
sequentially or from a list.

Compute Nodes
~~~~~~~~~~~~~

OPCG supports clusters of heterogeneous compute nodes. Users can define any number of
node types by creating templates in a config file. Node templates can
include any network templates defined in the network templates section. The combination of
node templates and network templates allows great flexibility in building heterogeneous
clusters with nodes dedicated to specific purposes.
Cluster POWER-Up supports clusters of heterogeneous compute nodes. Users
can define any number of node types by creating templates in a config file.
Node templates can include any network templates defined in the network
templates section. The combination of node templates and network templates
allows great flexibility in building heterogeneous clusters with nodes
dedicated to specific purposes.

.. _supported-hardware:

Expand All @@ -91,30 +97,33 @@ Supported Hardware
OpenPOWER Compute Nodes;

- S812LC
- S822LC
- Tyan servers derived from the above 2 nodes are generally supported.
- S821LC
- S822LC (Minsky)
- SuperMicro OpenPOWER servers

x86 Compute Nodes;

- Lenovo x3550
- Lenovo x3650

Many other x86 nodes should work, but we have only tested with Lenovo and some Supermicro nodes.

**Switches**

For information on adding additional switch support using
Genesis' switch class API, (see :ref:`developerguide`)
POWER-Up's switch class API, (see :ref:`developerguide`)

Data Switches;
Supported Switches;

- Mellanox SX1410
- Mellanox SX1710
- Cisco 5K (FEXes supported)
- Lenovo G8052, G7028, G7052 (bonding not currently supported)

Support for Lenovo G8264 is planned

Management Switches;

- Lenovo G8052
Notes;
Other Mellanox switches may work but have not been tested
Lenovo G8264 has not been tested
Other Cisco NX-OS based switches may work but have not been tested

Prerequisite hardware setup
============================
Expand Down

0 comments on commit 3bf8216

Please sign in to comment.