From 37d09b0ac9933dad89832f8f31adfef6b7266efd Mon Sep 17 00:00:00 2001 From: Trey Dockendorf Date: Mon, 7 Oct 2024 09:32:49 -0400 Subject: [PATCH] Release v4.0.0 --- CHANGELOG.md | 9 ++ REFERENCE.md | 228 +++++++++++++++++++++++++------------------------- metadata.json | 2 +- 3 files changed, 124 insertions(+), 115 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ef4269..a57edae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v4.0.0](https://github.com/treydock/puppet-module-mofed/tree/v4.0.0) (2024-10-07) + +[Full Changelog](https://github.com/treydock/puppet-module-mofed/compare/v3.1.0...v4.0.0) + +### Changed + +- Use puppet/network for network interface dependency [\#26](https://github.com/treydock/puppet-module-mofed/pull/26) ([treydock](https://github.com/treydock)) +- Major updates - read description [\#25](https://github.com/treydock/puppet-module-mofed/pull/25) ([treydock](https://github.com/treydock)) + ## [v3.1.0](https://github.com/treydock/puppet-module-mofed/tree/v3.1.0) (2022-04-07) [Full Changelog](https://github.com/treydock/puppet-module-mofed/compare/v3.0.0...v3.1.0) diff --git a/REFERENCE.md b/REFERENCE.md index e761e2f..35ef1eb 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,8 +9,8 @@ #### Public Classes * [`mofed`](#mofed): Manage Mellanox OFED -* [`mofed::opensm`](#mofedopensm): Manage OpenSM -* [`mofed::srp`](#mofedsrp): Manage SRP +* [`mofed::opensm`](#mofed--opensm): Manage OpenSM +* [`mofed::srp`](#mofed--srp): Manage SRP #### Private Classes @@ -21,7 +21,7 @@ ### Defined types -* [`mofed::interface`](#mofedinterface): Manage IPoIB interface +* [`mofed::interface`](#mofed--interface): Manage IPoIB interface ## Classes @@ -44,46 +44,46 @@ class { 'mofed': The following parameters are available in the `mofed` class: -* [`manage_repo`](#manage_repo) -* [`repo_baseurl`](#repo_baseurl) -* [`repo_gpgcheck`](#repo_gpgcheck) -* [`repo_gpgkey`](#repo_gpgkey) -* [`repo_exclude`](#repo_exclude) -* [`repo_priority`](#repo_priority) -* [`manage_packages`](#manage_packages) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) -* [`extra_packages`](#extra_packages) -* [`extra_packages_hiera_merge`](#extra_packages_hiera_merge) -* [`manage_service`](#manage_service) -* [`restart_service`](#restart_service) -* [`openibd_service_name`](#openibd_service_name) -* [`openibd_service_ensure`](#openibd_service_ensure) -* [`openibd_service_enable`](#openibd_service_enable) -* [`openibd_service_hasstatus`](#openibd_service_hasstatus) -* [`openibd_service_hasrestart`](#openibd_service_hasrestart) -* [`manage_config`](#manage_config) -* [`openib_config_path`](#openib_config_path) -* [`openib_shellvars`](#openib_shellvars) -* [`interfaces`](#interfaces) - -##### `manage_repo` +* [`manage_repo`](#-mofed--manage_repo) +* [`repo_baseurl`](#-mofed--repo_baseurl) +* [`repo_gpgcheck`](#-mofed--repo_gpgcheck) +* [`repo_gpgkey`](#-mofed--repo_gpgkey) +* [`repo_exclude`](#-mofed--repo_exclude) +* [`repo_priority`](#-mofed--repo_priority) +* [`manage_packages`](#-mofed--manage_packages) +* [`package_ensure`](#-mofed--package_ensure) +* [`package_name`](#-mofed--package_name) +* [`extra_packages`](#-mofed--extra_packages) +* [`extra_packages_hiera_merge`](#-mofed--extra_packages_hiera_merge) +* [`manage_service`](#-mofed--manage_service) +* [`restart_service`](#-mofed--restart_service) +* [`openibd_service_name`](#-mofed--openibd_service_name) +* [`openibd_service_ensure`](#-mofed--openibd_service_ensure) +* [`openibd_service_enable`](#-mofed--openibd_service_enable) +* [`openibd_service_hasstatus`](#-mofed--openibd_service_hasstatus) +* [`openibd_service_hasrestart`](#-mofed--openibd_service_hasrestart) +* [`manage_config`](#-mofed--manage_config) +* [`openib_config_path`](#-mofed--openib_config_path) +* [`openib_shellvars`](#-mofed--openib_shellvars) +* [`interfaces`](#-mofed--interfaces) + +##### `manage_repo` Data type: `Boolean` Boolean to set if MOFED repo should be managed -Default value: ``true`` +Default value: `true` -##### `repo_baseurl` +##### `repo_baseurl` Data type: `Optional[String]` The baseurl of the yumrepo resource -Default value: ``undef`` +Default value: `undef` -##### `repo_gpgcheck` +##### `repo_gpgcheck` Data type: `Enum['1','0']` @@ -91,39 +91,39 @@ The gpgcheck of the yumrepo resource Default value: `'1'` -##### `repo_gpgkey` +##### `repo_gpgkey` Data type: `Optional[String]` The gpgkey of the yumrepo resource -Default value: ``undef`` +Default value: `undef` -##### `repo_exclude` +##### `repo_exclude` Data type: `Optional[String]` The exclude of the yumrepo resource -Default value: ``undef`` +Default value: `undef` -##### `repo_priority` +##### `repo_priority` Data type: `Optional[String]` The priority of the yumrepo resource -Default value: ``undef`` +Default value: `undef` -##### `manage_packages` +##### `manage_packages` Data type: `Boolean` Boolean to determine if packages should be managed -Default value: ``true`` +Default value: `true` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -131,7 +131,7 @@ The package ensure property Default value: `'present'` -##### `package_name` +##### `package_name` Data type: `String` @@ -139,39 +139,39 @@ The MOFED package name to install Default value: `'mlnx-ofed-basic'` -##### `extra_packages` +##### `extra_packages` Data type: `Optional[Array]` An array of additional packages to install -Default value: ``undef`` +Default value: `undef` -##### `extra_packages_hiera_merge` +##### `extra_packages_hiera_merge` Data type: `Boolean` Boolean that sets if extra_packages should have values merged from hiera -Default value: ``false`` +Default value: `false` -##### `manage_service` +##### `manage_service` Data type: `Boolean` Boolean that determines if the openibd service should be managed -Default value: ``true`` +Default value: `true` -##### `restart_service` +##### `restart_service` Data type: `Boolean` Boolean that sets of openibd should be restarted -Default value: ``false`` +Default value: `false` -##### `openibd_service_name` +##### `openibd_service_name` Data type: `String` @@ -179,7 +179,7 @@ Name of the openibd service Default value: `'openibd'` -##### `openibd_service_ensure` +##### `openibd_service_ensure` Data type: `String` @@ -187,39 +187,39 @@ openibd service ensure property Default value: `'running'` -##### `openibd_service_enable` +##### `openibd_service_enable` Data type: `Boolean` openibd service enable property -Default value: ``true`` +Default value: `true` -##### `openibd_service_hasstatus` +##### `openibd_service_hasstatus` Data type: `Boolean` openibd service hasstatus property -Default value: ``true`` +Default value: `true` -##### `openibd_service_hasrestart` +##### `openibd_service_hasrestart` Data type: `Boolean` openibd service hasrestart property -Default value: ``true`` +Default value: `true` -##### `manage_config` +##### `manage_config` Data type: `Boolean` Boolean that sets if configs should be managed -Default value: ``true`` +Default value: `true` -##### `openib_config_path` +##### `openib_config_path` Data type: `Stdlib::Absolutepath` @@ -227,7 +227,7 @@ Path to openib.conf Default value: `'/etc/infiniband/openib.conf'` -##### `openib_shellvars` +##### `openib_shellvars` Data type: `Hash` @@ -235,7 +235,7 @@ Hash of shellvar resources Default value: `{}` -##### `interfaces` +##### `interfaces` Data type: `Hash` @@ -243,7 +243,7 @@ Hash of mofed::interface resources Default value: `{}` -### `mofed::opensm` +### `mofed::opensm` Manage OpenSM @@ -261,11 +261,11 @@ class { 'mofed::opensm': The following parameters are available in the `mofed::opensm` class: -* [`ensure`](#ensure) -* [`ports`](#ports) -* [`sweep`](#sweep) +* [`ensure`](#-mofed--opensm--ensure) +* [`ports`](#-mofed--opensm--ports) +* [`sweep`](#-mofed--opensm--sweep) -##### `ensure` +##### `ensure` Data type: `Enum['present', 'absent', 'disabled']` @@ -275,7 +275,7 @@ State of opensm. `present` will run opensm. Default value: `'present'` -##### `ports` +##### `ports` Data type: `Array` @@ -283,7 +283,7 @@ Ports used by opensm Default value: `[]` -##### `sweep` +##### `sweep` Data type: `Integer` @@ -291,7 +291,7 @@ Value passsed to opensm `-s` argument. Default value: `10` -### `mofed::srp` +### `mofed::srp` Manage SRP @@ -309,12 +309,12 @@ class { 'mofed::srp': The following parameters are available in the `mofed::srp` class: -* [`ensure`](#ensure) -* [`ports`](#ports) -* [`srp_daemon_config`](#srp_daemon_config) -* [`ib_srp_options`](#ib_srp_options) +* [`ensure`](#-mofed--srp--ensure) +* [`ports`](#-mofed--srp--ports) +* [`srp_daemon_config`](#-mofed--srp--srp_daemon_config) +* [`ib_srp_options`](#-mofed--srp--ib_srp_options) -##### `ensure` +##### `ensure` Data type: `Enum['present', 'absent', 'disabled']` @@ -324,7 +324,7 @@ State of srp. `present` will run opensm. Default value: `'present'` -##### `ports` +##### `ports` Data type: `Array` @@ -332,25 +332,25 @@ Ports used by srp daemon. Default value: `[]` -##### `srp_daemon_config` +##### `srp_daemon_config` Data type: `Optional[Variant[String, Array]]` Define lines in srp_daemon.conf -Default value: ``undef`` +Default value: `undef` -##### `ib_srp_options` +##### `ib_srp_options` Data type: `Optional[Hash[String, Variant[String,Integer], 1]]` Options passed to ib_srp kernel module -Default value: ``undef`` +Default value: `undef` ## Defined types -### `mofed::interface` +### `mofed::interface` Manage IPoIB interface @@ -371,43 +371,43 @@ mofed::interface { 'ib0': The following parameters are available in the `mofed::interface` defined type: -* [`ipaddr`](#ipaddr) -* [`netmask`](#netmask) -* [`gateway`](#gateway) -* [`ensure`](#ensure) -* [`enable`](#enable) -* [`nm_controlled`](#nm_controlled) -* [`connected_mode`](#connected_mode) -* [`mtu`](#mtu) -* [`bonding`](#bonding) -* [`bonding_slaves`](#bonding_slaves) -* [`bonding_opts`](#bonding_opts) +* [`ipaddr`](#-mofed--interface--ipaddr) +* [`netmask`](#-mofed--interface--netmask) +* [`gateway`](#-mofed--interface--gateway) +* [`ensure`](#-mofed--interface--ensure) +* [`enable`](#-mofed--interface--enable) +* [`nm_controlled`](#-mofed--interface--nm_controlled) +* [`connected_mode`](#-mofed--interface--connected_mode) +* [`mtu`](#-mofed--interface--mtu) +* [`bonding`](#-mofed--interface--bonding) +* [`bonding_slaves`](#-mofed--interface--bonding_slaves) +* [`bonding_opts`](#-mofed--interface--bonding_opts) -##### `ipaddr` +##### `ipaddr` -Data type: `Optional[Stdlib::Compat::Ip_address]` +Data type: `Optional[Stdlib::IP::Address]` IP address, required when ensure=present -Default value: ``undef`` +Default value: `undef` -##### `netmask` +##### `netmask` -Data type: `Optional[Stdlib::Compat::Ip_address]` +Data type: `Optional[Stdlib::IP::Address]` Netmask address, required when ensure=present -Default value: ``undef`` +Default value: `undef` -##### `gateway` +##### `gateway` -Data type: `Optional[Stdlib::Compat::Ip_address]` +Data type: `Optional[Stdlib::IP::Address]` Gateway address. -Default value: ``undef`` +Default value: `undef` -##### `ensure` +##### `ensure` Data type: `Enum['present', 'absent']` @@ -415,23 +415,23 @@ Interface ensure value. Default value: `'present'` -##### `enable` +##### `enable` Data type: `Boolean` Boolean of whether to enable the interface at boot. -Default value: ``true`` +Default value: `true` -##### `nm_controlled` +##### `nm_controlled` -Data type: `Optional[Variant[Boolean, Enum['yes','no']]]` +Data type: `Optional[Enum['yes','no']]` Value for nm_controlled on interface -Default value: ``undef`` +Default value: `undef` -##### `connected_mode` +##### `connected_mode` Data type: `Enum['yes', 'no']` @@ -439,23 +439,23 @@ The value for setting interface to connected mode. Default value: `'yes'` -##### `mtu` +##### `mtu` Data type: `Optional[Integer]` The MTU of the interface. -Default value: ``undef`` +Default value: `undef` -##### `bonding` +##### `bonding` Data type: `Boolean` If this interface is a bonding interface -Default value: ``false`` +Default value: `false` -##### `bonding_slaves` +##### `bonding_slaves` Data type: `Array[String]` @@ -463,7 +463,7 @@ Array of interfaces that should be enslaved in the bonding interface Default value: `[]` -##### `bonding_opts` +##### `bonding_opts` Data type: `String` diff --git a/metadata.json b/metadata.json index 60dfb27..4a5953b 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "treydock-mofed", - "version": "3.1.0", + "version": "4.0.0", "author": "treydock", "summary": "Mellanox OFED Puppet module", "license": "Apache-2.0",