docker_ee

contributions requested

pdk

tasks

Installs and configures Docker Enterprise Edition.

Project URL RSS Feed Report issues

Module Stats

2,305 downloads

2,305 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Oct 30th 2019

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
RedHat

Tasks:

assign_leader

assign_node

enable_kubernetes_scheduler

inspect_scheduler

inspect_self

list_nodes

nfs_restart

and 3 more. See all tasks

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'fervid-docker_ee', '1.0.9'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add fervid-docker_ee

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install fervid-docker_ee --version 1.0.9

Documentation

fervid/docker_ee — version 1.0.9 Oct 30th 2019

docker_ee

Description
Setup - The basics of getting started with docker_ee
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

Docker Enterprise Edition is a large piece of vendor software. This module simplifies the installation on RedHat. The only input needed is the Docker URL assigned to you by the vendor.

This module installs Docker Enterprise Edition. Use it instead of a manual install.

Setup

Setup Requirements

This module requires that, at a minimum, the Docker EE URL be passed in as a parameter.

Beginning with docker_ee

The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.

Usage

class { '::docker_ee':
  docker_ee_url  => 'https://storebits.docker.com/ee/abc123',
}

Reference

Classes

Public classes

docker_ee: Main class, includes all other classes.

Private classes

docker_ee::pre_install: Adds the YUM meta information necessary to configure the YUM repo.
docker_ee::yum_memcache: Reset the YUM memchache to reflect the newly added repository.
docker_ee::install: Installs the Docker Enterprise Edition package.

Parameters

The following parameters are available in the ::docker_ee class

`docker_ee_url`

Required.

Data type: Stdlib::Httpurl

The Docker EE URL you will be assigned by the vendor.

`docker_os_version`

Optional.

Data Type: Numeric

The version of the RedHat OS you are using.

Limitations

This currently only works for RedHat.

Development

Any contributions are welcomed!

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

assign_leader

Create a Docker UCP leader

Parameters
docker_image	e.g. docker/ucp:3.1.0 `String`
pod_cidr	e.g. 10.0.0.0/16 `String`
ucp_admin_password	UCP Admin password `String`
ucp_admin_username	UCP Admin username (e.g. root) `String`
ucp_load_balancer	e.g. ucp.autostructure.io `String`

assign_node

Assign a node a UCP manager or worker role

Parameters
join_token	The token from the command 'docker swarm join-token manager/worker' (e.g. SWMTKN-1-0lna8pilvsrl0ul0ie9r0m1s0g6xqhs7gyup2t1b5no3c9fx1n-dxv7s17j6eowpoq3fky2102ex). The type of token dictates the role assigned. There is one token for managers and one for workers. `String`
ucp_addr	e.g. ucp.domain.com, 192.168.0.100, etc. `String`

enable_kubernetes_scheduler

Set Docker scheduler to Kubernetes and turn off Swarm (MUST be run on a UCP manager).

Parameters
node	Target node's hostname `String`

inspect_scheduler

Report on any node's scheduler setting (must run on manager nodes only, but can specify workers or managers in the node parameter.)

Parameters
node	The target node's hostname `String`

inspect_self

Report on a node's scheduler setting (manager nodes only)

list_nodes

Only run on UCP managers, outputs all the clustered nodes

nfs_restart

Restart the nfs service

print_manager_token

Display Docker UCP manager token (docker swarm join-token manager).

print_tokens

Display Docker UCP manager token (docker swarm join-token manager).

print_worker_token

Display Docker UCP worker token (docker swarm join-token worker).

docker_ee

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Tasks:

Start using this module

Documentation

docker_ee

Table of Contents

Description

Setup

Setup Requirements

Beginning with docker_ee

Usage

Reference

Classes

Public classes

Private classes

Parameters

docker_ee_url

docker_os_version

Limitations

Development

What are tasks?

Tasks in this module release

assign_leader

assign_node

enable_kubernetes_scheduler

inspect_scheduler

inspect_self

list_nodes

nfs_restart

print_manager_token

print_tokens

print_worker_token

Release 1.0.3

Release 1.0.1

Release 1.0.0

Summary

Release 0.1.5

Summary

Release 0.1.4

Summary

Dependencies

Contributions Requested

PDK

Bolt Tasks

Bolt Tasks

`docker_ee_url`

`docker_os_version`