Version information
released Nov 5th 2019
This version is compatible with:
- Puppet Enterprise >=3.8.0 <6.0.0
- Puppet >=3.8.0 <6.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'appuio-openshift', '2.2.6'
Learn more about managing modules with a PuppetfileDocumentation
appuio/openshift — version 2.2.6 Nov 5th 2019
Puppet module for managing OpenShift - the Ansible part
Table of Contents
- Description
- Setup - The basics of getting started with openshift
- 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
Description
This Puppet module manages Ansible for setting up an OpenShift cluster with the official openshift-ansible Playbooks.
Setup
What openshift
affects
The module has two "roles":
openshift::role::ansible_master
:- Installs Ansible
- Checks out
openshift-ansible
from git - Configures SSH for Ansible
- Writes the inventory file in YAML format
openshift::role::node
:- Installs required packages
- Enables NetworkManager
- Add some missing CA certificates
Setup Requirements
Required modules:
Beginning with openshift
On the host you want to run Ansible, apply the ansible_master
role and pass the inventory to it:
class { 'openshift::role::ansible_master':
host_groups => {
'OSEv3' => {
children => ["nodes", "masters"],
},
masters => {
vars => {
osm_default_node_selector => "foo=bar",
},
hosts => {
"master1.example.com" => {},
"master2.example.com" => {},
},
children => ["etcd"],
},
nodes => {
hosts => {
"node[1:9].example.com" => {
custom_var => true,
},
},
},
}
}
This parameters can also be configured in Hiera.
An all nodes, apply the node
role:
class { 'openshift::role::node': }
Usage
Reference
Classes
Public Classes
openshift::role::ansible_master
: Installs and configures Ansible.
[host_groups] Default: {}. Hash of Ansible inventory data.
[playbooks_source] Default: https://github.com/openshift/openshift-ansible.git. Git repository where the Ansible plabooks are stored.
[playbooks_version] Default: master Git reference to check out
openshift::role::node
: Prepares node for OpenShift.
No parameters available.
Limitations
This Puppet module only runs on CentOS and RHEL.
Development
- Fork it (https://github.com/appuio/puppet-openshift/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
CHANGELOG
v2.2.6
- Fix changelog
v2.2.5
- Accept Hash for group children
v2.2.4
- Add parameter to "openshift::role::ansible_master" class to control management of Ansible configuration (not inventory).
v2.2.3
- Enable Ansible option "show_custom_stats" to always show statistics
v2.2.1
- Quote resource "NetworkManager" so it's a string
v2.2.0
- Initial public release
Dependencies
- puppetlabs/vcsrepo (>=1.0.0)
- puppetlabs/inifile (>=1.0.0)
Copyright (c) 2016, VSHN AG, info@vshn.ch All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of VSHN nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.