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/16.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.