Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet >=3.8.0 <5.0.0
- RedHat,CentOS,OracleLinux,Scientific,Debian,Ubuntu
Start using this module
Documentation
puppet-kong module
Table of Contents
- Overview
- Setup - The basics of getting started with kong
- Usage
- Parameters
- Limitations - OS compatibility, etc.
- Development
Overview
The puppet-kong module installs the Kong package, manages the Kong admin configuration and manages the Kong service.
By default this module installs packages from the Kong website, with all package dependencies.
Setup
What puppet-kong affects:
- the Kong package
- the Kong admin configuration (/etc/kong/kong.yml)
- the Kong service
Beginning with puppet-kong
To install Kong:
class { 'kong': }
Usage
If you do not want package dependencies installed by this module:
class { 'kong':
manage_package_dependencies => false,
}
If you do not want package fetching to be handled by this module:
class { 'kong':
manage_package_fetch => false,
}
Versioning
With the default setting of manage_package_fetch set to true, the
version parameter determines what package version will attempt to be
installed, after fetching it.
The native package providers that Puppet defaults to using (apt, yum) do not support package installation from a package in a local directory. Package providers dpkg and rpm do, but they do not support the versionable package attribute.
As a consequence, this module currently only supports new Kong installations
or package upgrades when manage_package_fetch is set to true (Only
new installations are supported on OSX, not upgrades).
If the ability to downgrade the package version is important to you, simply
include the Kong package in your own local repository, and set the
manage_package_fetch parameter to false - this will result in the
native package provider being used during installation and Puppet doing the
right thing based on the version parameter.
Parameters
admin_api_listen
Defaults to 0.0.0.0:8001
base_url
Defaults to https://downloadkong.org
cassandra_consistency
Defaults to ONE
cassandra_contact_points
Defaults to single contact point [ '127.0.0.1:9042' ]
cassandra_data_centers
Used only when the replication strategy is set to NetworkTopologyStrategy.
Variable type: Array
cassandra_keyspace
Defaults to kong
cassandra_password
Optional
cassandra_replication_factor
Used only when the replication strategy is set to SimpleStrategy.
Defaults to 1
cassandra_replication_strategy
Defaults to SimpleStrategy
cassandra_ssl_certificate_authority
Absolute path to the trusted CA certificate in PEM format when cassandra_ssl_verify
is set to true
cassandra_ssl_enabled
Defaults to false
cassandra_ssl_verify
Defaults to false
cassandra_user
Optional
cassandra_timeout
Connection and reading timeout (in ms). Defaults to 5000.
cluster_advertise
Optional address:port used by the node to communicate with other Kong nodes in the cluster.
cluster_encrypt
Optional key for encrypting network traffic within Kong.
cluster_listen
Defaults to 0.0.0.0:7946
cluster_listen_rpc
Defaults to 127.0.0.1:7373
cluster_ttl_on_failure
Optional override of Kong default (3600)
config_file_group
Defaults to 0
config_file_mode
Defaults to 0644
config_file_owner
Defaults to root
config_file_path
Defaults to /etc/kong/kong.yml
custom_plugins
An array of additional plugins that Kong needs to load.
database
Which database to use. Options are cassandra or postgres
Defaults to cassandra. Note that the database is not managed by this
module.
dns_resolver
Defaults to dnsmasq
dns_resolvers_available
A hash of DNS resolvers Kong can use. Defaults to dnsmasq, port 8053.
kong_path
Defaults to /usr/local/bin/kong
manage_init_file
Defaults to true
manage_package_dependencies
Defaults to true
manage_package_fetch
Defaults to true
memory_cache_size
Defaults to 128
nginx_conf
The nginx.conf file included in the kong.yml configuration.
nginx_working_dir
Defaults to /usr/local/kong/
package_manage
Defaults to true
package_provider
When manage_package_fetch is set to true, this value is used to
determine the package manager used to install the downloaded package.
postgres_database
Defaults to kong
postgres_host
Defaults to 127.0.0.1
postgres_password
No default. Required if database is set to postgres
postgres_port
Defaults to 5432
postgres_user
No default. Required if database is set to postgres
proxy_listen
Defaults to 0.0.0.0:8000
proxy_listen_ssl
Defaults to 0.0.0.0:8443
send_anonymous_reports
Defaults to true
service_enable
Defaults to true
service_ensure
Defaults to running
service_manage
Defaults to true
ssl_cert_path
Optional path to the SSL certificate that Kong will use when listening on the https port
ssl_key_path
Optional path to the SSL certificate key that Kong will use when listening on the https port
staging_dir
Directory where the downloaded packages are stored when manage_package_fetch
is set to true
use_staging
Use the puppet/staging module for fetching the package rather than puppet/archive.
Defaults to false
version
Determines the package version to fetch if manage_package_fetch is set
to true. Otherwise, determines the version of Kong to install from the local
package repository. Defaults to 0.8.3
Limitations
This module has received limited testing on:
- CentOS/RHEL 5/6/7
- Debian 6/7/8
- Ubuntu 12.04/14.04/15.04
The following platforms should also work, but have not been tested:
- Amazon Linux
- Archlinux
- Darwin
Module dependencies
If using CentoOS/RHEL 5/6/7, you will need to ensure that the stahnma-epel
module is installed.
Development
Patches are welcome.
2016-06-05 Release 0.0.3
Summary
This release provides several bugfixes, bumps the default version to 0.8.2 and adds new parameters for the 0.8.x version of Kong.
Features
- Applies modulesync changes (from Voxpupuli modulesync_configs).
- Changes default version to 0.8.3.
- Adds new configuration parameters for 0.8.x.
- Splits off the nginx.conf contents into a new variable.
- Cleans up the kong.yml template, double quoting variables and removes (most) commented sections taken from the default upstream file.
- Adds better documentation for parameters.
- Changes validation of certain IP addresses to IPv4 only.
- Adds validation of the database type.
- Adds
dns_resolvers_availableparameter. - Replaces
proxy_listen_addressandproxy_listen_portparameters withproxy_listen. - Replaces
proxy_listen_ssl_addressandproxy_listen_ssl_portparameters withproxy_listen_ssl. - Replaces
admin_api_listen_addressandadmin_api_listen_portparameters withadmin_api_listen. - Replaces
cluster_listen_addressandcluster_listen_portparameters withcluster_listen. - Replaces
cluster_listen_rpc_addressandcluster_listen_rpc_portparameters withcluster_listen_rpc. - Changes
config_file_groupto 0 rather than root in preparation for FreeBSD support. - Adds better validation of parameters.
- Adds
staging_dirparameter.
Bugfixes
- Fixes
custom_pluginsto be empty since supported plugins are loaded by default. - Fixes printing of
cassandra_ssl_*values. - Fixes metadata.json formatting.
- Fixes variable quoting in initscripts.pp.
- Fixes the Upstart script to include
start. - Fixes inconsistent Puppet-managed template headers.
- Fixes installation issues due to the native package provider not supporting the source package attribute.
- Attempts to fix up non-working OSX installation.
2016-04-12 Release 0.0.1
- Initial module release.
Dependencies
- puppet/archive (>=0.5.1 <2.0.0)
- stahnma/epel (>=1.0.0 <2.0.0)
- puppet/staging (>=1.0.6 <2.0.0)
- puppetlabs/stdlib (>=4.6.0 <5.0.0)
- camptocamp/systemd (>=0.2.2 <2.0.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 Ben Spiccia
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.