puppet-module-mofed

Table of Contents

1. Overview
2. Usage - Configuration options
3. Reference - Parameter and detailed reference to all options
   • Facts
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module
6. TODO
7. Additional Information

Overview

The MOFED Puppet module manages Mellanox OFED for Linux.

Usage

mofed

Install and configure MOFED from site specific yum repo server.

class { 'mofed':
  repo_baseurl => 'http://example.com/mlnx/$releasever/3.4-2.0.0.0-rhel7.3/'
  repo_gpgkey  => 'http://example.com/mlnx/$releasever/3.4-2.0.0.0-rhel7.3/RPM-GPG-KEY-Mellanox',
}

mofed::interface

Add IPoIB interface

mofed::interface { 'ib0':
  ensure         => 'present',
  ipaddr         => '10.0.0.1',
  netmask        => '255.255.0.0',
  connected_mode => 'no',
}

The same interface can be defined in Hiera if the mofed class is included

mofed::interfaces:
  ib0:
    ensure: 'present'
    ipaddr: '10.0.0.1'
    netmask: '255.255.0.0'
    connected_mode: 'no'    

mofed::opensm

Add opensm that is set for 2 ports.

class { 'mofed::opensm':
  ports => ['mlx4_1 1', 'mlx4_1 2'],
}

mofed::srp

Add srp for 2 ports.

class { 'mofed::srp':
  ports => ['mlx4_1 1', 'mlx4_1 2'],
}

Reference

http://treydock.github.io/puppet-module-mofed/

Facts

has_mellanox_infiniband

This boolean fact will return true if the system has a Mellanox Infiniband card.

mellanox_ofed_version

Returns the Mellanox OFED version that is installed

infiniband_hcas

Moved to treydock/infiniband module

infiniband_hca_port_guids

Moved to treydock/infiniband module

Limitations

This module has been tested on:

• RedHat 7 x86_64

Development

Testing

Testing requires the following dependencies:

• rake
• bundler

Install gem dependencies

bundle install

Run unit tests

bundle exec rake test

If you have Vagrant >= 1.2.0 installed you can run system tests

bundle exec rake beaker

TODO

Further Information

Reference

Table of Contents

Classes

Public Classes

• mofed: Manage Mellanox OFED
• mofed::opensm: Manage OpenSM
• mofed::srp: Manage SRP

Private Classes

• mofed::config
• mofed::install
• mofed::repo
• mofed::service

Defined types

• mofed::interface: Manage IPoIB interface

Classes

mofed

Manage Mellanox OFED

Examples

Basic usage using local yum repo for MOFED

class { 'mofed':
  repo_baseurl => 'http://example.com/mlnx/$releasever/3.4-2.0.0.0-rhel7.3/'
  repo_gpgkey  => 'http://example.com/mlnx/$releasever/3.4-2.0.0.0-rhel7.3/RPM-GPG-KEY-Mellanox',
}

Parameters

The following parameters are available in the mofed class:

• manage_repo
• repo_baseurl
• repo_gpgcheck
• repo_gpgkey
• repo_exclude
• repo_priority
• manage_packages
• package_ensure
• package_name
• extra_packages
• extra_packages_hiera_merge
• manage_service
• restart_service
• openibd_service_name
• openibd_service_ensure
• openibd_service_enable
• openibd_service_hasstatus
• openibd_service_hasrestart
• manage_config
• openib_config_path
• openib_shellvars
• interfaces

manage_repo

Data type: Boolean

Boolean to set if MOFED repo should be managed

Default value: true

repo_baseurl

Data type: Optional[String]

The baseurl of the yumrepo resource

Default value: undef

repo_gpgcheck

Data type: Enum['1','0']

The gpgcheck of the yumrepo resource

Default value: '1'

repo_gpgkey

Data type: Optional[String]

The gpgkey of the yumrepo resource

Default value: undef

repo_exclude

Data type: Optional[String]

The exclude of the yumrepo resource

Default value: undef

repo_priority

Data type: Optional[String]

The priority of the yumrepo resource

Default value: undef

manage_packages

Data type: Boolean

Boolean to determine if packages should be managed

Default value: true

package_ensure

Data type: String

The package ensure property

Default value: 'present'

package_name

Data type: String

The MOFED package name to install

Default value: 'mlnx-ofed-basic'

extra_packages

Data type: Optional[Array]

An array of additional packages to install

Default value: undef

extra_packages_hiera_merge

Data type: Boolean

Boolean that sets if extra_packages should have values merged from hiera

Default value: false

manage_service

Data type: Boolean

Boolean that determines if the openibd service should be managed

Default value: true

restart_service

Data type: Boolean

Boolean that sets of openibd should be restarted

Default value: false

openibd_service_name

Data type: String

Name of the openibd service

Default value: 'openibd'

openibd_service_ensure

Data type: String

openibd service ensure property

Default value: 'running'

openibd_service_enable

Data type: Boolean

openibd service enable property

Default value: true

openibd_service_hasstatus

Data type: Boolean

openibd service hasstatus property

Default value: true

openibd_service_hasrestart

Data type: Boolean

openibd service hasrestart property

Default value: true

manage_config

Data type: Boolean

Boolean that sets if configs should be managed

Default value: true

openib_config_path

Data type: Stdlib::Absolutepath

Path to openib.conf

Default value: '/etc/infiniband/openib.conf'

openib_shellvars

Data type: Hash

Hash of shellvar resources

Default value: {}

interfaces

Data type: Hash

Hash of mofed::interface resources

Default value: {}

mofed::opensm

Manage OpenSM

Examples

Manage OpenSM on two specific ports

class { 'mofed::opensm':
  ports => ['mlx4_1 1', 'mlx4_1 2'],
}

Parameters

The following parameters are available in the mofed::opensm class:

• ensure
• ports
• sweep

ensure

Data type: Enum['present', 'absent', 'disabled']

State of opensm. present will run opensm. disabled will install and configure opensm but disable services. absent will remove opensm.

Default value: 'present'

ports

Data type: Array

Ports used by opensm

Default value: []

sweep

Data type: Integer

Value passsed to opensm -s argument.

Default value: 10

mofed::srp

Manage SRP

Examples

Manage SRP for specific ports

class { 'mofed::srp':
 ports => ['mlx4_1 1', 'mlx4_1 2'],
}

Parameters

The following parameters are available in the mofed::srp class:

• ensure
• ports
• srp_daemon_config
• ib_srp_options

ensure

Data type: Enum['present', 'absent', 'disabled']

State of srp. present will run opensm. disabled will install and configure opensm but disable services. absent will remove opensm.

Default value: 'present'

ports

Data type: Array

Ports used by srp daemon.

Default value: []

srp_daemon_config

Data type: Optional[Variant[String, Array]]

Define lines in srp_daemon.conf

Default value: undef

ib_srp_options

Data type: Optional[Hash[String, Variant[String,Integer], 1]]

Options passed to ib_srp kernel module

Default value: undef

Defined types

mofed::interface

Manage IPoIB interface

Examples

Add IPoIB interface

mofed::interface { 'ib0':
  ensure         => 'present',
  ipaddr         => '10.0.0.1',
  netmask        => '255.255.0.0',
  connected_mode => 'no',
}

Parameters

The following parameters are available in the mofed::interface defined type:

• ipaddr
• netmask
• gateway
• ensure
• enable
• nm_controlled
• connected_mode
• mtu
• bonding
• bonding_slaves
• bonding_opts

ipaddr

Data type: Optional[Stdlib::IP::Address]

IP address, required when ensure=present

Default value: undef

netmask

Data type: Optional[Stdlib::IP::Address]

Netmask address, required when ensure=present

Default value: undef

gateway

Data type: Optional[Stdlib::IP::Address]

Gateway address.

Default value: undef

ensure

Data type: Enum['present', 'absent']

Interface ensure value.

Default value: 'present'

enable

Data type: Boolean

Boolean of whether to enable the interface at boot.

Default value: true

nm_controlled

Data type: Optional[Enum['yes','no']]

Value for nm_controlled on interface

Default value: undef

connected_mode

Data type: Enum['yes', 'no']

The value for setting interface to connected mode.

Default value: 'yes'

mtu

Data type: Optional[Integer]

The MTU of the interface.

Default value: undef

bonding

Data type: Boolean

If this interface is a bonding interface

Default value: false

bonding_slaves

Data type: Array[String]

Array of interfaces that should be enslaved in the bonding interface

Default value: []

bonding_opts

Data type: String

The bonding options to use for this bonding interface

Default value: 'mode=active-backup miimon=100'

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v5.0.1 (2024-10-22)

Full Changelog

Fixed

• Actually use stdlib 9.x function #28 (treydock)

v5.0.0 (2024-10-22)

Full Changelog

Changed

• Drop EL7, Require stdlib 9.x, support newer dependencies #27 (treydock)

v4.0.0 (2024-10-07)

Full Changelog

Changed

• Use puppet/network for network interface dependency #26 (treydock)
• Major updates - read description #25 (treydock)

v3.1.0 (2022-04-07)

Full Changelog

Added

• Replace CentOS 8 with Rocky 8 - do not set NM_CONTROLLED=no for EL8 by default #23 (treydock)

v3.0.0 (2021-05-19)

Full Changelog

Changed

• Drop Puppet 5, add Puppet 7, drop EL6 #21 (treydock)

Added

• Add repo_priority parameter #22 (treydock)

v2.3.1 (2020-12-03)

Full Changelog

Fixed

• Avoid invalid hash data warning #19 (treydock)

v2.3.0 (2020-12-02)

Full Changelog

Added

• Allow repo GPG check to be disabled #17 (treydock)

v2.2.0 (2020-04-29)

Full Changelog

Added

• Better support for interface ensure=absent #16 (treydock)

v2.1.0 (2020-04-03)

Full Changelog

Added

• Allow repo exclude to be set #15 (treydock)

v2.0.0 (2019-12-11)

Full Changelog

Changed

• Change how mofed::interface resources are defined #11 (treydock)

Added

• Support EL8 #14 (treydock)
• Module cleanup #13 (treydock)
• PDK convert #12 (treydock)

1.5.0 (2019-04-26)

Full Changelog

Added

• Support only Puppet 5 and 6 and update module dependency ranges #10 (treydock)
• Move some infiniband facts to infiniband module #9 (treydock)

1.4.2 (2018-07-31)

Full Changelog

Fixed

• Fix infiniband_hca_port_guids when IB stack is not functional #8 (treydock)

1.4.1 (2018-07-31)

Full Changelog

Added

• Document with puppet-strings #7 (treydock)

Fixed

• Fix facts to not produce 'unexpected return' errors #6 (treydock)

1.4.0 (2018-07-18)

Full Changelog

Added

• Add infiniband_hcas fact and infiniband_hca_port_guids fact #5 (treydock)

1.3.0 (2018-05-18)

Full Changelog

Added

• Add mellanox_ofed_version fact #3 (treydock)

Fixed

• Fix has_mellanox_infiniband fact to not throw error without lspci present #4 (treydock)

1.2.0 (2017-11-13)

Full Changelog

Added

• Use data types for all parameters #2 (treydock)

1.1.0 (2017-11-02)

Full Changelog

Added

• Support hiera merging extra_packages #1 (treydock)

1.0.0 (2017-10-26)

Full Changelog

0.0.1 (2017-10-26)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator