figlet
Version information
This version is compatible with:
- ArchLinux, CentOS, Debian, RedHat, Ubuntu
Start using this module
Add this module to your Puppetfile:
mod 'zanloy-figlet', '1.0.1'Learn more about managing modules with a PuppetfileDocumentation
figlet
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with figlet
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
figlet is a program that makes large ascii text art from standard text input.
Module Description
This module allows you to use figlet text in other modules as well as create basic files with figlet text (eg: /etc/motd). An example of this is:
__ _ _ _
/ _(_) __ _| | ___| |_
| |_| |/ _` | |/ _ \ __|
| _| | (_| | | __/ |_
|_| |_|\__, |_|\___|\__|
|___/
Setup
What figlet affects
The figlet module will need to have figlet application installed on the puppet master. This can be done by calling "include figlet::install" in the node definition for your puppet master. It does not need to be installed on agents to use the function.
Setup Requirements
- figlet sets up a function and several facts so it will require that pluginsync is enabled.
- To install figlet on RedHat based systems, you will also need the repoforge repository. If you plan to use the "include figlet::install" method of installation on a RedHat system, then you need to have the yguenane/repoforge module installed and setup. There is a direct dependency to Yumrepo['repoforge'] and will fail if this is not in the catalog.
Beginning with figlet
To install the figlet module, you can either install from the forge:
puppet module install zanloy/figlet
or install from github (execute in the modules directory):
git clone https://github.com/zanloy/puppet-figlet.git figlet
Usage
To install figlet on the puppet master (include only in puppet master's node definition)
include figlet::install
The figlet modules does not have any declarable classes on its own. It is designed to be used in other modules. A good example of this is to setup a figlet banner in your motd file:
file { '/etc/motd':
content => figlet("$::hostname"),
}
Reference
The figlet module create one function and two facts.
figlet($string, $font, $width)
Facts (should only be relevant on the puppet master):
figlet_fonts (comma separated string of fonts installed on node)
figlet_fonts_array (array of fonts installed)
Limitations
This module has only been tested on the following distros:
- Ubuntu 14.04
- RHEL 6.5
Development
This module is pretty basic but if you have any improvements, then please add a new issue with tag [feature] or you are always welcome to add it yourself and send a pull request.
Dependencies
- puppetlabs/stdlib (>= 3.2.0)
Copyright (c) 2013 Zan Loy 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. Copyright (c) 2012 Zan Loy 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.