Version information
Start using this module
Add this module to your Puppetfile:
mod 'trulabs-kamailio', '0.0.6'
Learn more about managing modules with a PuppetfileDocumentation
puppet-kamailio
Description
Puppet module for Kamailio
=======
Overview
This module provides a simple interface for managing Kamailio deployments with Puppet.
Module Description
Kamailio is a very fast and configurable SIP proxy. kamailio.org
Setup
For the minimal setup, add:
include 'kamailio'
in your manifest.
You may want to configure a few options, e.g.:
class { '::kamailio':
service_manage => true,
service_enable => true,
service_ensure => 'running',
manage_repo => true,
with_tls => true,
with_websockets => true,
with_ephem_auth => true,
manage_config => false,
}
On an empty host:
apt-get update && apt-get install -y puppet
## This will also pull puppetlabs-apt and puppetlabs-stdlib
puppet module install trulabs-kamailio
puppet apply -v /etc/puppet/modules/kamailio/tests/init.pp --show_diff --noop
Parameters
#####service_manage
If set to true, Puppet takes care of the service according to service_enable
and service_ensure
. Default is 'true'.
#####service_enable
Configures whether Kamailio should be enabled. Applies if service_manage
is true. Default is 'true'.
#####service_ensure
If service_manage
is true and service_enable
is true, this parameter tells Puppet whether Kamailio should be running. Default is 'running'.
#####manage_repo
Should Puppet manage apt sources?
#####with_tls
Whether TLS should be enabled, plus basic configuration.
#####with_websockets
Whether the WebSockets module should be installed.
#####with_ephem_auth
Whether the ephemeral authentication module should be installed.
#####manage_config
Should Puppet deploy the configuration files?
#####package_ensure
Version or status of the package, e.g. 'latest' (which is also default) or '4.1.6+wheezy'
Author
Truphone Labs
Giacomo Vacca <giacomo.vacca@gmail.com>
License
See LICENSE file.
##Tests
Run tests with: sudo puppet apply -v tests/init.pp --modulepath modules/:/etc/puppet/modules --show_diff --noop
##Limitations
This module has been built and tested with Puppet 2.7.
The module has been tested on:
- Debian 7
##Contributors The list of contributors can be found at: https://github.com/trulabs/puppet-kamailio/graphs/contributors
Dependencies
Copyright (c) 2014, Truphone All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Truphone nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.