Version information
released Sep 20th 2021
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 7.0.0
Start using this module
Add this module to your Puppetfile:
mod 'jonhallettuob-existdb', '0.5.0'
Learn more about managing modules with a PuppetfileDocumentation
jonhallettuob/existdb — version 0.5.0 Sep 20th 2021
eXistdb Puppet module
Table of Contents
- Description
- Setup - The basics of getting started with existdb
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
Description
This module installs the eXist database software and starts it as a service.
Setup
Beginning with existdb
To use this module, add these declarations to your Puppetfile:
mod 'puppetlabs-stdlib','4.25.1'
mod 'puppetlabs-java', '2.1.0'
mod 'puppet-archive', '3.0.0'
mod 'puppet-nginx','0.15.0'
mod 'jonhallettuob-existdb', '0.5.0'
To install eXistdb and start it as a service with default parameters:
class { 'java':
package => 'java-1.8.0-openjdk-devel',
}
class { 'existdb': }
Or equivalently in Hiera:
---
classes:
- java
- existdb
java::package: 'java-1.8.0-openjdk-devel'
To configure a reverse proxy to make eXistdb appear on port 443, add mod 'puppet-nginx', '0.9.0'
to your Puppetfile and then in Hiera:
classes:
- existdb::reverseproxy
existdb::reverseproxy::servers:
'server.example.com':
server_cert_name: 'server.example.com'
uri_path: '/exist/apps/example.com'
Usage
Set up eXistdb and its data in specific directories:
class existdb {
exist_home => '/usr/local/exist',
exist_data => '/var/lib/exist',
}
Reference
class existdb (
$exist_home = '/usr/local/existdb',
$exist_data = '/var/lib/existdb',
$exist_cache_size = '128M',
$exist_collection_cache_size = '24M',
$exist_revision = 'eXist-5.3.0',
$exist_version = '5.3.0',
$java_home = '/usr/lib/jvm/jre',
$exist_user = 'existdb',
$exist_group = 'existdb',
) {
...
}
class existdb::reverseproxy (
$servers,
$exist_home = '/usr/local/existdb',
) {
...
}
define existdb::reverseproxy::server {
$server_name,
$server_cert_name = $server_name,
$ssl_cert_path = "/etc/pki/tls/certs/${server_cert_name}.crt",
$ssl_cert = undef,
$ssl_key_path = "/etc/pki/tls/private/${server_cert_name}.key",
$ssl_key = undef,
$uri_path = '',
$proxy_redirect = 'default',
$location_cfg_append = undef,
$raw_append = undef,
$format_log = 'combined',
) {
...
}
Limitations
The module was developed on CentOS 7 using Puppet 4 and hasn't been tested on any other systems.
Dependencies
- puppetlabs-java (>= 1.6.0 < 3.0.0)
- puppet-nginx (>= 0.9.0 < 1.0.0)
BSD 3-Clause License Copyright (c) 2017, eXist-db.org 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 the copyright holder 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.