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
- Puppet >= 7.0.0 < 9.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'toto-twit_motd', '1.1.1'Learn more about managing modules with a PuppetfileDocumentation
twit_motd
Table of Contents
Module Description
This module sets up your motd. A message will appear stating that your system is managed by Puppet and will also display the added modules.
Usage
Use twit_motd::register { $module_name: } at the end of your init.pp and the module name will be add into the motd.
class your_class () {
include twit_motd
...
contain your_class::params
contain your_class::config
...
Class['your_class::params']
-> Class['your_class::config']
twit_motd::register { $module_name: }
}
Also you can add text into the $motd_motd variable to add a custom message as well. Output will be the follows:
==============================[ NOTICE ]==============================
This system is monitored by puppet.
Local changes could be lost!
If you have any questions, please contact your@e-mail.ltd
======================================================================
Custom Message
======================================================================
Registered puppet modules:
-- twit_motd
-- ...
Reference
See REFERENCE.md.
OS-Support
This module is supported on the following operating systems:
- Debian
- 9
- 10
- 11
- 12
- Ubuntu
- 18.04
- 20.04
- 22.04
- FreeBSD
- 12
- 13
Requirements
Reference
Table of Contents
Classes
Public Classes
twit_motd: Setup dedicated motd to setup motd.twit_motd::notify: Notifiy the motd service for specific OStwit_motd::params: Defines the OS params
Private Classes
twit_motd::config: Configure the motd
Defined types
twit_motd::register: Register a motd message into motd.
Classes
twit_motd
This module can be use in all other modules to announce the module usage in motd
Parameters
The following parameters are available in the twit_motd class:
motd_mailcontact
Data type: Stdlib::Email
Specify the email address as contact in motd
Default value: 'your@e-mail.ltd'
motd_motd
Data type: Optional[String[1]]
A string of a custom motd message
Default value: undef
twit_motd::notify
Notifiy the motd service for specific OS
twit_motd::params
All defined params for different OS types
Defined types
twit_motd::register
This register can be used from modules to put a message into the motd
Parameters
The following parameters are available in the twit_motd::register defined type:
content
Data type: String
String of a message
Default value: ''
order
Data type: String
Define the position of the message
Default value: '10'
Dependencies
- puppetlabs/stdlib (>= 8.1.0 < 9.4.1)
- puppetlabs/concat (>= 7.1.1 < 9.0.0)
MIT License Copyright (c) 2023 Torsten Wilms Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.