Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

api

This module is for automatic installation & configuration of API(axway) on AWS
Project URLRSS FeedReport issues

3,366 downloads

3,366 latest version

3.0 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

  • 0.1.0 (latest)
released Sep 1st 2019
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
  • Puppet >= 5.5.10 < 7.0.0
  • , , , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'shobhitgoel-api', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add shobhitgoel-api
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install shobhitgoel-api --version 0.1.0

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

shobhitgoel/api — version 0.1.0 Sep 1st 2019

api

Table of Contents

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

Description

This module is for automatiic installation and configuration of API package. One have to simply change some parameters and everything will be done in background for you.

Setup

The setup is very easy: 1) For installing for non-HAproxy: simply change the parameters "front" & "back" in params.pp to false . Also you have to specifically mention the ip of your admin node in "file_front" & "file_back" pp files.

2) For installing with HA-Proxy: Change parameters "front" & "back" i params.pp to true.
Same as for non-HAproxy case put the ip of admin node in both the files.

Setup Requirements OPTIONAL

You'll be requiring 4 vm's one for your puppet master node and 3 for agent nodes. As on one agent you'll install ADMIN node and on other Back & Front nodes.

Make sure all the agents are properly connected with master node. For checking purpose type the command: "puppet agent -t --noop "

Beginning with api

After using and successful execution of this module you will be able to see front and back nodes on ADmin url. Url for admin node: https://<ip_admin>:8090 UN:admin pwd: changeme (You can change them in file_admin.pp as well).

URL for front node: https://<ip_front>:8075 UN:apiadmin pwd:changeme (can change in file_front.pp file).

Usage

1) For installing for non-HAproxy: simply change the parameters "front" & "back" in params.pp to false . Also you have to specifically mention the ip of your admin node in "file_front" & "file_back" pp files.

    2) For installing with HA-Proxy: Change parameters "front" & "back" i params.pp to true.
    Same as for non-HAproxy case put the ip of admin node in both the files.

After using and successful execution of this module you will be able to see front and back nodes on ADmin url. Url for admin node: https://<ip_admin>:8090 UN:admin pwd: changeme (You can change them in file_admin.pp as well).

Reference

In case you find any issue you can reach out to me on Git I will try to help you as much as i can.

Limitations

No limitations as of you.But try to remove that manual setting for ip of admin node as well in my next update.

Development

You can reach out to me on Git in case you have some doubts or some idea for making module more usable. We can work on it together.

Release Notes/Contributors/Etc. Optional

If you aren't using changelog, put your release notes here (though you should consider using changelog). You can also add any additional sections you feel are necessary or important to include here. Please use the ## header.