Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.4.x
- Puppet >= 4.9.0 < 9.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'deric-beegfs', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet-beegfs
Upgrade from deric-beegfs
version 0.4.x
to 0.5.x
beegfs::storage_directory
expects an Array instead of just String- parameter
beegfs::major_version
renamed tobeegfs::release
beegfs::client::client_udp
renamed tobeegfs::client::client_udp_port
Usage
First of all choose which release to use, by defining:
beegfs::release: '6'
valid values are:
'2015.03'
'6'
'7'
'7.1'
You'll need one mgmtd server:
class { 'beegfs::mgmtd': }
in order to accept new storage and meta servers you have to (at least temporarily) enable allow_new_servers
and allow_new_targets
.
And probably many storage and meta servers:
class { 'beegfs::meta':
mgmtd_host => 192.168.1.1,
}
class { 'beegfs::storage':
mgmtd_host => 192.168.1.1,
}
It's easier to define shared settings for all servers at one place (Hiera, e.g. default.yaml
):
beegfs::mgmtd_host: '192.168.1.1'
so that you don't have to specify mgmtd_host
for each component.
defining a mount
beegfs::mount{ 'mnt-share':
cfg => '/etc/beegfs/beegfs-client.conf',
mnt => '/mnt/share',
user => 'beegfs',
group => 'beegfs',
}
Interfaces and networks
For meta and storage nodes you can specify interfaces for communication. The passed argument must be an array.
class { 'beegfs::meta':
mgmtd_host => 192.168.1.1,
interfaces => ['eth0', 'ib0'],
}
class { 'beegfs::storage':
mgmtd_host => 192.168.1.1,
interfaces => ['eth0', 'ib0']
}
In some cases, interfaces can have multiple ips, and only a subset of them should be used. In this case, the list of allowed subnets can be passed as the networks parameter. It should be an array if specified.
class { 'beegfs::meta':
mgmtd_host => 192.168.1.1,
interfaces => ['eth0', 'ib0'],
networks => ['192.168.1.0/24'],
}
Initialization
mgmtd
If beegfs::allow_first_run_init
is true
you may skip this step.
beegfs-setup-mgmtd -p /mnt/myraid1/beegfs-mgmtd
meta
If beegfs::allow_first_run_init
is true
you may skip this step.
Example 1
Initialize metadata storage directory of first metadata server and set "storage01" as management daemon host in config file:
beegfs-setup-meta -p /mnt/myraid1/beegfs-meta -s 1 -m storage01
Hiera support
All configuration could be specified in Hiera config files. Some settings are shared between all components, like:
beegfs::mgmtd_host: '192.168.1.1'
beegfs::mgmtd::allow_new_servers: true
beegfs::mgmtd::allow_new_targets: true
beegfs::release: 6
version could be also defined exactly, like:
beegfs::version: '2015.03.r9.debian7'
for module specific setting use correct namespace, e.g.:
beegfs::meta::interfaces:
- 'eth0'
Recent releases of Linux Kernel might include "deterministic interfaces naming" (like enp0s31f6
) that requires specifying which interface should be BeeGFS instances using:
beegfs::client::interfaces:
- "%{facts.networking.primary}"
beegfs::meta::interfaces:
- "%{facts.networking.primary}"
beegfs::storage::interfaces:
- "%{facts.networking.primary}"
Requirements
- Ruby 2.0 or newer
- at least Puppet 4.9
License
Apache License, Version 2.0
Acceptance test
Run specific image using:
BEAKER_set=debian9-5.5 rake acceptance
debug mode:
BEAKER_debug=true rake acceptance
preserve Docker container after finising test:
$ BEAKER_destroy=no rake acceptance
$ docker exec -it 98aa06308c67 bash
$ /opt/puppetlabs/bin/puppet apply /tmp/apply_manifest.pp.OveoVG
Rubocop
Update rubocop config with given target version:
mry --target=0.70.0 .rubocop.yml
deric-beegfs Changelog
2024-06-25 Release 1.0.0
- BC
puppetlabs/stdlib
>= 9.0.0 is required due to usage ofstdlib::ensure_package
function puppetlabs/apt
>= 9.0.0 needs this patch to work with ruby 3.0- Fix incorrected
puppetlabs/concat
dependency requirement - at least4.1.0
is needed (removed deprecatedis_string()
) - Puppet 8 compatible
2024-03-06 Release 0.8.2
- Support fetching packages over http via
package_source
param #36
2024-02-07 Release 0.8.1
- Fix unknown variables, revert to using inheritance #35
2024-02-03 Release 0.8.0
- Add optional
sys_file_event_log_mask
parameter #33 - Add parameter for client tuneFileCacheType #34
- Switch debian apt to https, use appropriate gpg key since 7.2.5
- Remove deprecated
has_key
function (removed in stdlib 9) - Fix types, remove lookup call
2023-08-10 Release 0.7.2
2022-05-18 Release 0.7.1
- Support name change for repo GPG key (since BeeGFS release 7.2.6) #25
- Make remoteFSync and connUseRDMA configurable #21
- Bump dependencies #22
- Better client resources ordering #23
2021-08-30 Release 0.7.0
- Adding optional use of sysAllowUserSetPattern #19
- Allow newer dependencies
- Support newer distribution releases, drop very old ones (#20)
2020-11-18 Release 0.6.0
- Support annomalies in versioning #16
- Add support for connNetFilterFile #17
- Extend list of supported distributions (though not all beegfs releases works on all distributions)
- Interfaces configured after setting up client package
2019-09-25 Release 0.5.0
Breaking Changes
beegfs::storage_directory
expects an Array instead of just String- parameter
beegfs::major_version
renamed tobeegfs::release
beegfs::client::client_udp
renamed tobeegfs::client::client_udp_port
Changes
beegfs::release
can be defined only globally (not for each subclass likebeegfs::meta
,beegfs::storage
) - we're using shared repository major release can't be different- add Puppet types #14
- add BeeGFS 7 support with templates copied from a clean install (to expose all options) #14
- add support for setting up admon #14
- add Yum repo and RPM install #14
- Full changes to previous release
2018-01-16 Release 0.4.1
- Add switch to enable quota support #12
- Add switch to enable ACL support #12
- Add switches to set sysAllowNewServers and sysAllowNewTargets #13
- Full changes to previous release
2017-11-02 Release 0.4.0
- Remove Puppet 3 support
- Upgrade apt module dependency
- Support setting tuneRefreshOnGetAttr #11
2017-08-10 Release 0.3.2
- Use deb9 release for Debian 9 Stretch
2017-07-27 Release 0.3.1
- Fixed autobuild dependency (#10)
2017-07-10 Release 0.3.0
- Autobuild configuration (#7)
- Support multiple storage directories (#8)
- Allow to set "storeAllowFirstRunInit" for meta, mgmtd and storage. (#9)
2017-06-29 Release 0.2.0
- Config files for BeeGFS 6
- Concat fix (#2)
- Allow changing log directory (#3)
Dependencies
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppetlabs/apt (>= 9.0.0 < 10.0.0)
- puppetlabs/concat (>= 4.1.0 < 10.0.0)
- puppetlabs/yumrepo_core (>= 1.0.3 < 3.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.