Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/stackhpc/ansible-role-cluster-infra

Ansible Galaxy role for generating OpenStack infrastructure for Cluster-as-a-Service
https://github.com/stackhpc/ansible-role-cluster-infra

Last synced: 4 days ago
JSON representation

Ansible Galaxy role for generating OpenStack infrastructure for Cluster-as-a-Service

Awesome Lists containing this project

README 

          
OpenStack Cluster-as-a-Service Infrastructure

=============================================



This role generates software-defined OpenStack infrastructure that can

be used for generating complex application topologies on demand.

A recent version of OpenStack Heat is used to achieve this.



Requirements

------------



The OpenStack APIs should be accessible from the target host.  OpenStack

Newton or later is required.  Client credentials should have been set

in the environment, or using the `clouds.yaml` format.



In terms of Python packages, the requirements are:

- ansible

- jmespath (required by `json_query` filter)



Role Variables

--------------



`cluster_venv`: Optional path to a python virtualenv in which the python

`shade` package is installed.



`cluster_auth_type`: Optional name of the OpenStack authentication plugin to

use.



`cluster_auth`: Optional dictionary containing authentication information.



`cluster_cloud`: Optional name of the OpenStack client config cloud name to use.



`cluster_state`: Desired state of the cluster, one of `present`, `absent`, or

`query`.  The default value is `present`. If the value is `query`, the cluster

will not be updated, but its configuration will be queried and an Ansible

inventory generated.



`cluster_name`: Name to give the Heat stack

It defaults to `cluster`



`cluster_environment_nodenet`: An environment file specifying the resource to

use for the per-node network resource, `Cluster::NodeNet`. *NOTE*: This option is

deprecated, in favour of resources for defining `nodenet_resource` within groups

and a global default resource using `nodenet_resource` within `cluster_params`.



`cluster_environment_instance`: An environment file specifying the resource to

use for the instances, `Cluster::Instance`. *NOTE*: This option is deprecated,

in favour of resources for specific groups through adding a definition for

`node_resource` to the group, and a global default resource through

defining `node_resource` whithin `cluster_params`.



`cluster_environment`: A list of environment files to use when creating the

Heat stack.



`cluster_params`: Parameters that are passed in to the Heat stack.



  * `cluster_prefix`: Name prefix to use for instance hostname construction.



  * `cluster_groups`: JSON-structured list of node groups, each of which is

     described by a dict, containing the following:



    * `name`: A name to refer to this group

    * `flavor`: The name or UUID of an instance flavor to use for deploying this group.

    * `image`: The name or UUID of an image to use for deploying this group.

    * `user`: The name of a cloud user for which SSH keys have been provisioned and

      passwordless sudo has been configured.  Could be (for example), `centos`, `debian`

      or `ubuntu`.

    * `num_nodes`: The number of nodes to create within this group.

    * `volume_size`: Optional size in GB of volumes used to boot instances in

      this group when the `instance-w-volume.yaml` environment is used.

    * `volume_type`: Optional type of volumes used to boot instances in this

      group when the `instance-w-volume.yaml` environment is used.



  * `cluster_keypair`: Name of an SSH key pair to use to access the instances.



  * `cluster_az`: Name of the availability zone in which to create the

    instances.



  * `cluster_config_drive`: Whether to provide metadata via a config drive.

    Default is `false`.



  * `cluster_net`: JSON-structure list of networks, each of which is described

    by a dict, containing the following:



    * `net`: Name or UUID of a neutron network to attach the instances to.

    * `subnet`: Name or UUID of a neutron subnet to attach the instances to.

    * `security_groups`: Optional list of names or UUIDs of security groups to

      add the instances' ports to.  Security groups can be present or absent

      on each listed network.

    * `floating_net`: Optional name or UUID of a neutron network to attach

      floating IPs to when the `Cluster::NodeNet1WithFIP` or

      `Cluster::NodeNet2WithFIP` resources are used.



  * `node_resource`: A resource name from the library of custom node resource 

     names.  This resource type is used as a default for groups which do not

     override with a specific node resource type.



     Valid options include:



    * `Cluster::Instance`: An instance with ephemeral storage only.

      This is the default.

    * `Cluster::InstanceWithVolume`: An instance provisioned with a Cinder volume.



  * `nodenet_resource`: A resource name from the library of custom network 

    resources for node networking.  This resource type is used for groups that

    don't specify a network configuration for instances of the group.



    Valid options include:



    * `Cluster::NodeNet1`: A single network with no floating IP associated.

      This is the default.

    * `Cluster::NodeNet1WithFIP`: A single network with floating IP allocated

      and associated with the port.

    * `Cluster::NodeNet1WithPreallocatedFIP`: A single network with floating IP

      (taken from a pre-allocated and supplied list) and associated with the port.

    * `Cluster::NodeNet2`: Two network interfaces.  The first two networks listed

      in `cluster_net` are used.

    * `Cluster::NodeNet2WithFIP`: Two network interfaces.  The first two networks listed

      in `cluster_net` are used.  A floating IP will be allocated from the first network

      and associated with the instance.

    * `Cluster::NodeNet2WithFIPSRIOV`: Two network interfaces.  The first interface

      has a floating IP attached (using the `floating_net` and `security_groups`).

      The second interface is configured as an SR-IOV port resource, for

      high-performance internal networking.  The first two networks listed

      in `cluster_net` are used.

    * `Cluster::NodeNet3`: Three network interfaces.  The first three networks listed

      in `cluster_net` are used.



  * `router_networks`: An optional list of IP subnet CIDRs that should be added as

    permitted networks.  This is needed if a port is associated with a gateway node that

    is performing IP routing between subnets.  These should match the format of `allowed_address_pairs`

    [https://docs.openstack.org/heat/rocky/template_guide/openstack.html#OS::Neutron::Port-prop-allowed_address_pairs here].

    A simple, permissive configuration for `router_networks` would be: 

    

```

router_networks:

  - ip_address: "0.0.0.0/0"

```



`cluster_inventory`: After deployment, an inventory file is generated,

which can be used in subsequent Ansible-driven configuration.



`cluster_roles`: A set of group assignments to make in the Ansible inventory file

that is generated.  This parameter is a list of dicts of the form:



  * `name`: Name of the group to define in the Ansible inventory.

  * `groups`: A list of groups selected from the dict objects supplied to `cluster_groups`, above.



`cluster_group_vars`: A dictionary mapping inventory groups to group variables

to be defined for that group. The group variables for each group are defined as

a dictionary mapping variable names to their values.



`cluster_environment_group`: An optional Ansible group name to which all

cluster hosts and localhost will be added. This can be useful if there is a

single group that represents an environment such as

development/staging/production.



Dependencies

------------



This role depends on the python `shade` package being installed on the target

host. The package may be installed in a python virtual environment, in which

case the path to the virtualenv should be specified in the `cluster_venv`

variable.



The [stackhpc.os-shade](https://galaxy.ansible.com/stackhpc/os-shade/) role may

be used to install the python `shade` package.



Example Playbook

----------------



The following playbook creates a Heat stack for a cluster containing a `login`

group and a `compute` group.



    ---

    # This playbook uses the Ansible OpenStack modules to create a cluster

    # using a number of baremetal compute node instances, and configure it

    # for a SLURM partition

    - hosts: openstack

      roles:

        - role: stackhpc.cluster-infra

          cluster_name: "openhpc"

          cluster_params:

            cluster_prefix: "ohpc"

            cluster_keypair: "admin_rsa"

            cluster_net:

              - net: "internal"

                subnet: "internal"

                floating_net: "external"

                security_groups:

                  - "default"

                  - "slurm"

            cluster_groups:

              - name: "login"

                flavor: "compute-B"

                image: "CentOS7-OpenHPC"

                num_nodes: 1

                node_resource: "Cluster::InstanceWithVolume"

                node_resource: "Cluster::NodeNet1WithFIP"

              - name: "compute"

                flavor: "compute-A"

                image: "CentOS7-OpenHPC"

                num_nodes: 16

          cluster_group_vars:

            cluster:

              ansible_user: centos



Author Information

------------------



- Stig Telfer ()

- Bharat Kunwar ()