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-kubernetes', '0.1.2'Learn more about managing modules with a PuppetfileDocumentation
Kubernetes
Table of Contents
- Description
- Setup - The basics of getting started with kubernetes
- 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
The Puppet kubernetes module installs and configures the Kubernetes system which arranges containers into logical units to improve management and discovery.
Description
This module installs and configures Kubernetes. Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.
It groups containers that make up an application into logical units for easy management and discovery.
Setup
Setup Requirements
The included configuration tool, kube_tools auto generates all the security parameters, the bootstrap token, and other configurations for your cluster into a file. The kube_tool requires Ruby 2.3 and above.
First install the module puppet module install puppetlabs-kubernetes --version 0.1.0. We would suggest doing this on a local machine and not a Puppet server as you need cfssl installed.
To install cfssl, see Cloudflare's cfssl documentation. Change directory into the root of the module and issue bundle install.
Then cd into the tools directory. You will now be able to run the kube_tool.
To look at the kube_tools help menu. Just issue ./kube_tool.rb this will print out:
Commands:
kube_tool.rb build_hiera FQDN, IP, BOOTSTRAP_CONTROLLER_IP, ETCD_INITIAL_CLUSTER, ETCD_IP, KUBE_API_ADVERTISE_ADDRESS, INSTALL_DASHBOARD # Pass the cluster params to build your hiera configuration
kube_tool.rb help [COMMAND] # Describe available commands or one specific command
So to generate the hiera file for my cluster I would use:
./kube_tool.rb build_hiera kubernetes 172.17.10.101 172.17.10.101 "etcd-kube-master=http://172.17.10.101:2380,etcd-kube-replica-master-01=http://172.17.10.210:2380,etcd-kube-replica-master-02=http://172.17.10.220:2380" "%{::ipaddress_enp0s8}" "%{::ipaddress_enp0s8}" true
The parameters are:
FQDN: the cluster fqdn.BOOTSTRAP_CONTROLLER_IP: the ip address of the controller puppet will use to create things like cluster role bindings, kube dns, and the Kubernetes dashboard.ETCD_INITIAL_CLUSTER: the server addresses. When in production, include three, five, or seven nodes for etcd.ETCD_IPandETCD_IP KUBE_API_ADVERTISE_ADDRESS: we recommend passing the fact for the interface to be used by the cluster.INSTALL_DASHBOARD: a boolean to install the dashboard or not.
The tool creates a kubernetes.yaml file. To view the file contents on screen, run the cat command.
Add the kubernetes.yaml file to the Hiera directory on your Puppet server.
The tool also creates a bootstrap token and base64 encodes any values that need to be encoded for Kubernetes. If you run the cat command again, all the values are re-generated, including the certificates and tokens. You can then use Jenkins or Bamboo to add the Hiera file to your control repository or version control application.
If you don't want to use the kube_tools configuration tool and want to manually configure the module, all of the parameters are listed in the Reference section and in the init.pp file.
Begininning with kubernetes
After your kubernetes.yaml file has been added to the Hiera directory on your Puppet server, configure your node with one of the following parameters:
Bootstrap Controller
A bootstrap controller is the node a cluster uses to add cluster addons (such as kube dns, cluster role bindings etc). After the cluster is bootstrapped, the bootstrap controller becomes a normal controller.
To make a node a bootstrap controller, add the following code to the manifest:
class {'kubernetes':
controller => true,
bootstrap_controller => true,
}
Controller
A controller in Kubernetes contains the control plane and etcd. In a production cluster you should have three, five, or seven controllers.
To make a node a controller, add the following code to the manifest:
class {'kubernetes':
controller => true,
}
Worker
A worker node runs your applications. You can add as many of these as Kubernetes can handle. For information about nodes in Kubernetes, see the Kubernetes docs.
To make a node a worker node, add the following code to the manifest:
class {'kubernetes':
worker => true,
}
Please note that a node can not be a controller and a worker. It must be one or the other.
Reference
Parameters
kubernetes_version
The version of the Kubernetes containers to install.
Defaults to 1.7.3.
kubernetes_package_version
The version the Kubernetes OS packages to install, such as kubectl and kubelet.
Defaults to 1.7.3.
cni_version
The version of the cni package to install.
Defaults to 0.5.1.
kube_dns_version
The version of kube DNS to install.
Defaults to 1.14.2.
controller
Specifies whether to set the node as a Kubernetes controller.
Valid values are true, false.
Defaults to false.
bootstrap_controller
Specifies whether to set the node as the bootstrap controller.
The bootstrap controller is used only for creating the initial cluster.
Valid values are true, false.
Defaults to false.
bootstrap_controller_ip
The IP address of the bootstrap controller.
Defaults to undef.
worker
Specifies whether to set a node as a worker.
Defaults to undef.
manage_epel
Specifies whether you to manage epel for a RHEL box.
Valid values are true, false.
Defaults to false.
kube_api_advertise_address
The IP address you want exposed by the API server.
An example with hiera would be kubernetes::kube_api_advertise_address:"%{::ipaddress_enp0s8}".
Defaults to undef.
etcd_version
The version of etcd to use.
Defaults to 3.0.17.
etcd_ip
The IP address you want etcd to use for communications.
An example with hiera would be kubernetes::etcd_ip:"%{::ipaddress_enp0s8}".
Defaults to undef.
etcd_initial_cluster
This will tell etcd how many nodes will be in the cluster and is passed as a string.
A Hiera example is kubernetes::etcd_initial_cluster: etcd-kube-master=http://172.17.10.101:2380,etcd-kube-replica-master-01=http://172.17.10.210:2380,etcd-kube-replica-master-02=http://172.17.10.220:2380.
Defaults to undef.
bootstrap_token
The token Kubernetes uses to start components.
For information on bootstrap tokens, see https://kubernetes.io/docs/admin/bootstrap-tokens/
Defaults to undef.
bootstrap_token_name
The name of the bootstrap token.
An example with hiera would be kubernetes::bootstrap_token_name: bootstrap-token-95e1e0.
Defaults to undef.
bootstrap_token_description
The base64 encoded description of the bootstrap token.
A Hiera example is kubernetes::bootstrap_token_description: VGhlIGRlZmF1bHQgYm9vdHN0cmFwIHRva2VuIHBhc3NlZCB0byB0aGUgY2x1c3RlciB2aWEgUHVwcGV0Lg== # lint:ignore:140chars.
bootstrap_token_id
The base64 encoded ID the cluster uses to point to the token.
A Hiera example is kubernetes::bootstrap_token_id: OTVlMWUwDQo=.
Defaults to undef.
bootstrap_token_secret
The base64 encoded secret which validates the bootstrap token.
An example with hiera would be kubernetes::bootstrap_token_secret: OTVlMWUwLmFlMmUzYjkwYTdmYjlkMzYNCg==.
Defaults to undef.
bootstrap_token_usage_bootstrap_authentication
The base64 encoded bool which uses the bootstrap token. (true = dHJ1ZQ==)
An example with hiera would be kubernetes::bootstrap_token_usage_bootstrap_authentication: dHJ1ZQ==.
Defaults to undef.
bootstrap_token_usage_bootstrap_signing
The base64 encoded bool which uses the bootstrap signing. (true = dHJ1ZQ==)
An example with hiera would be kubernetes::bootstrap_token_usage_bootstrap_signing: dHJ1ZQ==.
Defaults to undef.
certificate_authority_data
The string value for the cluster ca certificate data.
Defaults to undef.
client_certificate_data_controller
The client certificate for the controller. Must be a string value.
Defaults to undef.
client_certificate_data_controller_manager
The client certificate for the controller manager. Must be a string value.
Defaults to undef.
client_certificate_data_scheduler
The client certificate for the scheduler. Must be a string value.
Defaults to undef.
client_certificate_data_worker
The client certificate for the kubernetes worker. Must be a string value.
Defaults to undef.
client_key_data_controller
The client certificate key for the controller. Must be a string value.
Defaults to undef.
client_key_data_controller_manager
The client certificate key for the controller manager. Must be a string value.
Defaults to undef.
client_key_data_scheduler
The client certificate key for the scheduler. Must be a string value.
Defaults to undef.
client_key_data_worker
The client certificate key for the kubernetes worker. Must be a string value.
Defaults to undef.
apiserver_kubelet_client_crt
The certificate for the kubelet api server. Must be a certificate value and not a file.
Defaults to undef.
apiserver_kubelet_client_key
The client key for the kubelet api server. Must be a certificate value and not a file.
Defaults to undef.
apiserver_crt
The certificate for the api server. Must be a certificate value and not a file.
Defaults to undef.
apiserver_key
The key for the api server. Must be a certificate value and not a file.
Defaults to undef.
ca_crt
The ca certificate for the cluster. Must be a certificate value and not a file.
Defaults to undef.
ca_key
The ca key for the cluster. Must be a certificate value and not a file.
Defaults to undef.
front_proxy_ca_crt
The ca certificate for the front proxy. Must be a certificate value and not a file.
Defaults to undef.
front_proxy_ca_key
The ca key for the front proxy. Must be a certificate value and not a file.
Defaults to undef.
front_proxy_client_crt
The client certificate for the front proxy. Must be a certificate value and not a file.
Defaults to undef.
front_proxy_client_key
The client key for front proxy. Must be a certificate value and not a file.
Defaults to undef.
sa_key
The key for the service account. Must be a certificate value and not a file.
Defaults to undef.
sa_pub
The public key for the service account. Must be a certificate value and not a file.
Defaults to undef.
cni_network_provider
The network deployment URL that kubectl can locate.
We support networking providers that supports cni.
This defaults to https://git.io/weave-kube-1.6.
install_dashboard
Specifies whether the kubernetes dashboard is installed.
Valid values are true, false.
Defaults to false.
Limitations
This module supports Kubernetes 1.6 and above.
This module supports only Puppet 4 and above.
This module has been tested on the following OS
RedHat 7.x
CentOS 7.x
Ubuntu 16.04
Development
If you would like to contribute to this module please follow the rules in the CONTRIBUTING.md.
Version 0.1.2
Supports Kubernetes up to 1.8.x
Version 0.1.1
Hotfix for kubeproxy
Version 0.1.0
First release Supports Kubernetes 1.6 - 1.7.5
Dependencies
- puppetlabs-stdlib (>= 4.19.0 < 5.0.0)
- puppetlabs-apt (>= 4.1.0 < 4.3.0)
- stahnma-epel (>= 1.2.2 < 1.3.0)
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.