docker_ucp
Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.2.1 < 5.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-docker_ucp', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with docker_ucp
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
The Docker Universal Control Plane (UCP) module helps with setting up a UCP controller, and joining nodes to it.
Module Description
This module provides a single class, docker_ucp
, which uses the
official docker/ucp
container to bootstrap a UCP controller, or join
a node to at existing UCP.
Setup
The module assumes Docker is already installed on the host. If you would like to do that with Puppet look at the Docker module.
You can install the module using the Puppet module tool like so:
puppet module install puppetlabs/docker_ucp
Usage
The included class has two modes of operation:
Installing a Controller
class { 'docker_ucp':
controller => true,
}
This will install a UCP controller using Docker, with the default
admin/orca
username and password. Remember to login and change the
password once UCP is up and running.
The class takes a number of parameters, depending on your specific setup. Consult the UCP documentation for details of this options.
class { 'docker_ucp':
controller => true,
host_address => ::ipaddress_eth1,
version => '1.0.0',
usage => false,
tracking => false,
subject_alternative_names => ::ipaddress_eth1,
external_ca => false,
swarm_scheduler => 'binpack',
swarm_port => 19001,
controller_port => 19002,
preserve_certs => true,
docker_socket_path => '/var/run/docker.sock',
license_file => '/etc/docker/subscription.lic',
}
Note that license_file
option will only work with versions of UCP
later than 0.8.0.
Joining a Node to UCP
Version =< 1
You can use the same class on another node to join it to an existing UCP.
class { 'docker_ucp':
ucp_url => 'https://ucp-controller.example.com',
fingerprint => 'the-ucp-fingerprint-for-your-install',
}
The default username and password are used, so it's likely that you'll need to provide those in parameters. The class also takes a number of other parameters useful for joininng. Again these should map to the options in the official UCP documetation.
class { 'docker_ucp':
ucp_url => 'https://ucp-controller.example.com',
fingerprint => 'the-ucp-fingerprint-for-your-install',
username => 'admin',
password => 'orca',
host_address => ::ipaddress_eth1,
subject_alternative_names => ::ipaddress_eth1,
replica => true,
version => '0.8.0',
usage => false,
tracking => false,
}
Version 2 and above
In UCP version 2 Docker has changed the underlying cluster scheduler from Swarm legacy to Swarm mode, because of that change the join flags have also changed. To join to a v2 manager (formally a controller in v1) please use the following:
class { 'docker_ucp':
version => '2.1.0',
token => 'Your join token here',
listen_address => '192.168.1.2',
advertise_address => '192.168.1.2',
ucp_manager => '192.168.1.1',
}
Installing a Docker Trusted Registry
To install a Docker trusted registry (DTR) on to your UCP cluster, please see the following example.
docker_ucp::dtr {'Dtr install':
install => true,
dtr_version => 'latest',
dtr_external_url => 'https://172.17.10.104',
ucp_node => 'ucp-04',
ucp_username => 'admin',
ucp_password => 'orca4307',
ucp_insecure_tls => true,
dtr_ucp_url => 'https://172.17.10.101',
require => [ Class['docker_ucp']
}
In this example we are setting the install => true
this tells Puppet we want to configure a new registry. We set the dtr_version
, this can be any version of the registry that is compatible with your UCP cluster. The dtr_external_url
is the URL you will use to hit the registry, ucp_node
is the node in the cluster that the registry will run on, user name and password are self explanatory. ucp_insecure_tls => true
allows the use of self signed SSL certs, this should be set to false in a production environment. dtr_ucp_url
is the URL that the registry will use to contact the UCP cluster.
Joining a replica to your Docker Trusted Registry Cluster
To join a replica to your DTR cluster please see the following example.
docker_ucp::dtr {'Dtr install':
join => true,
dtr_version => 'latest',
ucp_node => 'ucp-03',
ucp_username => 'admin',
ucp_password => 'orca4307',
ucp_insecure_tls => true,
dtr_ucp_url => 'https://172.17.10.101',
require => [ Class['docker_ucp']
}
In this example we set mostly the same flags as installing the initial install. The main difference is that we have used the join
flag not the install
flag. Please note you can not use install
and join
in the same block of Puppet code.
To remove your Docker Trusted Registry.
To remove the DTR from your UCP cluster you need to pass some flags, the flags are the same as the install flags, except we are setting ensure => 'absent'
docker_ucp::dtr {'Dtr install':
ensure => 'absent',
dtr_version => 'latest',
dtr_external_url => 'https://172.17.10.104',
ucp_node => 'ucp-04',
ucp_username => 'admin',
ucp_password => 'orca4307',
ucp_insecure_tls => true,
dtr_ucp_url => 'https://172.17.10.101',
}
Limitations
As of Docker UCP 0.8, UCP only supports RHEL 7.0, 7.1, 7.2, Ubuntu 14.04, 16.04 and CentOS 7.1, therefore the module only works on those operating systems too.
Maintainers
This module is maintained by:
Gareth Rushgrove gareth@puppet.com
Scott Coulton scott.coulton@puppet.com
Supported Version 1.0.0
This release adds full support for Docker Trusted Registry (DTR). Docker Trusted Registry (DTR) is the enterprise-grade image storage solution from Docker. You install it behind your firewall so that you can securely store and manage the Docker images you use in your applications.
2016-02-15 - Version 0.1.0
This is the initial release of the Docker UCP Puppet module.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2016 Puppet Labs 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.