ibm_profile
Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 6.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'enterprisemodules-ibm_profile', '0.3.0'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
Overview
The ibm_profile
module allows an easy path from first simple installation to a fully customized Enterprise setup. It is part of our family of Puppet modules to install, manage IBM MQ and IBM IIB with Puppet. Besides the ibm_profile
module, this family also contains:
- mq_config For configuring IBM MQ.
- mq_install For installing IBM MQ software on Linux systems
- iib_config For configuring IBM Integration Bus on Linux systems
- iib_install For installing IBM Integration Bus on Linux systems
License
Most of the Enterprise Modules modules are commercial modules. This one is NOT. It is an Open Source module. You are free to use it any way you like. It, however, is based on our commercial Puppet WebLogic modules.
Description
The ibm_profile::mq_system
class contains all the Puppet code to install, create and populate a running MQ manager with all required objects. This class is an easy way to get started. It contains the following stages (These are not puppet stages):
sysctl
(Set all required sysctl parameters)limits
(Set all required OS limits)groups_and_users
(Create required groups and users)packages
(Install all required packages)firewall
(Open required firewall rules)mq_software
(Install required Oracle database software)mq_manager
(Define the MQ manager)mq_authorizations
(Define the MQ authorizations)mq_queues_and_topics
(Define all MQ queues and topics)
All these stages have a default implementation. This implementation is suitable to get started with. These classed all have parameters you can customize through hiera values. The defaults are specified in the module's data/default.yaml
file.
But sometimes this is not enough and you would like to add some extra definitions, you can, for example, add a Puppet class to be executed after the systctl
stage is done and before the limits
is done. You can do this by adding the next line to your yaml data:
ibm_profile::mq_machine::before_sysctl: my_profile::my_extra_class
or after:
ibm_profile::mq_machine::after_sysctl: my_profile::my_extra_class
If you want to, you can also skip this provided class:
ibm_profile::mq_machine::sysctl: skip
Or provide your own implementation:
ibm_profile::mq_machine::sysctl: my_profile::my_own_implementation
This mechanism can be used for all named stages and makes it easy to move from an easy setup with a running standard MQ setup to a fully customized setup using a lot of your own classes plugged in.
Check here to see the full documentation for this module.
This module has a couple of convenient classes to help you setup your IBM MQ and/or IBM Integration Bus environment:
ibm_profile::mq_machine
Ensure MQ is installed and configured.ibm_profile::iib_machine
Ensure IBM Integration Bus is installed and configured
All of these classes contain some steps. All of these stapes have default implementations, but you can add extra Puppet code to the catalog and remove or override the default implementation. This can all be done by adding values to your hiera files.
Check here to see the full documentation for this module.
Setup
Requirements
The ibm_profile
module requires:
-
Puppet module
enterprisemodules-easy_type
installed. -
Puppet module
enterprisemodules-mq_install
installed. -
Puppet module
enterprisemodules-mq_config
installed. -
Puppet module
enterprisemodules-iib_install
installed. -
Puppet module
enterprisemodules-iib_config
installed. -
Puppet version 4.10.8 or higher. Can be Puppet Enterprise or Puppet Open Source
-
A valid IBM MQ license and/or IBM Integration Bus License
-
A valid Enterprise Modules license for usage.
-
Runs on most Linux systems.
-
Windows systems are NOT supported
This module uses some other public Puppet forge modules. Check the metadata to ensure you have all dependencies installed.
We support MQ and IIB versions:
[TODO]
Installing the ibm_profile module
To install these modules, you can use a Puppetfile
mod 'enterprisemodules/ibm_profile' ,'0.1.0'
Then use the librarian-puppet
or r10K
to install the software.
You can also install the software using the puppet module
command:
puppet module install enterprisemodules-ibm_profile
Usage
To get started, include the ibm_profile::mq_machine
class in your role, make sure you have a module called software
that has a folder files
and that directory contains the next files:
[TODO]
Run Puppet and you have a Server with MQ installed a MQ Queue Manager named ?? Check the documentation for all the settings you can manage. Here is a list of the most basic stuff you'd probably want to change:
[TODO]
Reference
Here you can find some more information regarding this puppet module:
- The
ibm_profile
documentation - The
mq_install
documentation - The
mq_config
documentation - The
iib_install
documentation - The
iib_config
documentation
Here are related blog posts:
[TODO]
Limitations
This module runs on most Linux versions. It requires a puppet version higher than 4.10.8. The module does NOT run on windows systems.
Changelog
All notable changes to this project will be documented in this file.
Release 0.3.0
Features
- [mq_machine] Add support for standby queue managers
Bugfixes
None
Release 0.2.0
Features
- [mq_machine] Add support for channel authorization records
- [mq_machine] Add support for authentication_info and authorization
Bugfixes
- [mq_machine] Add parameters for packages
Release 0.1.0
Features
- Install basic MQ systems
Bugfixes
None
Known Issues
- No good firewall implementation
Dependencies
- enterprisemodules/easy_type (>= 2.5.0 < 4.0.0)
- enterprisemodules/mq_config (>= 1.3.0 < 2.0.0)
- enterprisemodules/mq_install (>= 1.1.1 < 2.0.0)
- enterprisemodules/iib_config (>= 1.0.10 < 2.0.0)
- enterprisemodules/iib_install (>= 1.0.14 < 2.0.0)
- ipcrm-echo (>= 0.1.5 < 1.0.0)
- herculesteam-augeasproviders_core (>= 2.1.4 < 3.0.0)
- herculesteam-augeasproviders_sysctl (>= 2.2.0 < 3.0.0)
- saz-limits (>= 3.0.2 < 4.0.0)
- puppetlabs-firewall (>= 1.12.0 < 2.0.0)
- crayfishx-firewalld (>= 3.4.0 < 4.0.0)
- puppetlabs-stdlib (>= 4.25.0 < 5.0.0)