Forge Home

apimanager

WSO2 API Manager puppet module.

12,667 downloads

8,663 latest version

1.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.9.1 (deleted)
  • 1.9.1-1 (latest)
  • 0.1.1 (deleted)
  • 0.1.0 (deleted)
released Sep 3rd 2015
This version is compatible with:
  • Puppet 3.x

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'thilina-apimanager', '1.9.1-1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add thilina-apimanager
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install thilina-apimanager --version 1.9.1-1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

thilina/apimanager — version 1.9.1-1 Sep 3rd 2015

apimanager

Table of Contents

  1. Module Description - What the module does and why it is useful
  2. Backwards compatibility information
  3. Setup - The basics of getting started with apimanager module
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Module Description

This is apimanager module will install WSO2 API Manager

Setup

Beginning with apimanager module

If you want a server installed with the default options you can run,
include 'apimanager'

If you want to install API Manager as a given specific roles, i.e. publisher, store, keymanager, gateway you can run,

include 'apimanager::keymanager'
include 'apimanager::gateway'
include 'apimanager::pubstore'

Usage

Reference

Classes

  • apimanager: Installs and manages the WSO2 base module in the standalone mode
  • apimanager::params: Builds a hash of apimanager module information.
  • apimanager::keymanager: Install and configure the API Manager as the keymanager.
  • apimanager::gateway: Install and configure the API Manager as the gateway.
  • apimanager::pubstore: Install and configure the API Manager as both publisher and store.

Parameters

apimanager

version
This is to specify the version of the API Manager, e.g.: 1.9.1
offset
Offset of the carbon server that will be deployed, default value is 0. This will overide the CARBON_HOME/repository/conf/carbon.xml offset value.
config_database
This is to specify which config database to use, example value will be 'config'
maintenance_mode
To specify the maintenance mode to be used during cleanup and initialization processes.
Allowed values are as follows,
refresh: To remove the lock file and restart the carbon server.
new: To stop process and remove carbon home.
zero: To stop process, remove carbon home and remove the product pack.
depsync
Whether to specify deployment synchronization functionality is used or not.
sub_cluster_domain
This will be used in clustered setup.
Allowed values, mgt, worker.
clustering
To specify whether the node is in a clustered setup or not.
cloud
To specify whether the node is running on a cloud environment.
amtype
Allowed values apimanager, pubstore, gateway, keymanager
owner
e.g.: 'root'
group
e.g.: 'root'
target
To specify the target folder where to extract the product pack and create carbon home
e.g.: '/mnt'
members
To specify the well known members in a clustered setup.
e.g.: {'192.168.18.122' => 4010 }
port_mapping
To specify the port mapping values.
e.g.: { 8280 => 9763, 8243 => 9443 }

Limitations

This module has been tested on:

  • Ubuntu 12.04, 14.04

Testing on other platforms has been minimal and cannot be guaranteed.

Development

This module is maintained by WSO2, Inc.