https://github.com/wso2/puppet-apim

https://github.com/wso2/puppet-apim

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wso2/puppet-apim
• Owner: wso2
• Created: 2016-08-09T05:43:03.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T06:16:13.000Z (2 months ago)
• Last Synced: 2024-07-18T06:24:40.207Z (2 months ago)
• Language: Shell
• Size: 6.12 MB
• Stars: 41
• Watchers: 153
• Forks: 42
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-wso2-apim - Puppet deployment scripts

README

        
# Puppet Modules for WSO2 API Manager

This repository contains the Puppet modules for profiles related to WSO2 API Manager and API Manager Analytics.

## Supported Puppet Versions

- Puppet 7.31.0

## Quick Start Guide

1. Download a product package. Product packages can be downloaded and copied to a local directory, or downloaded from a remote location.

    * **Local**: Download wso2am-4.3.0.zip from [here](https://wso2.com/api-management/install/) and copy it to the `/modules/apim_common/files/packs` directory in the **Puppetmaster**.

    * **Remote**:

        1. Change the value *$pack_location* variable in `/modules/apim_common/manifests/params.pp` to `remote`.

        2. Change the value *$remote_pack* variable of the relevant profile in `/modules/apim_common/manifests/params.pp` to the URL in which the package should be downloaded from, and remove it as a comment.

2. Set up the JDK distribution as follows:

   The Puppet modules for WSO2 products use Amazon Corretto as the JDK distribution. However, you can use any [supported JDK distribution](https://apim.docs.wso2.com/en/latest/install-and-setup/setup/reference/product-compatibility/#tested-jdks). The JDK Distribution can be downloaded and copied to a local directory, or downloaded from a remote location.

   * **local**: Download Amazon Corretto for Linux x64 from [here](https://corretto.aws/downloads/resources/17.0.6.10.1/amazon-corretto-17.0.6.10.1-linux-x64.tar.gz) and copy .tar into the `/modules/apim_common/files/jdk` directory.

   * **remote**: Change the value *$remote_jdk* variable in `/modules/apim_common/manifests/params.pp` to the URL in which the JDK should be downloaded from, and remove it as a comment.

   * To use a different jdk distribution, reassign the *$jdk_name* and the *$java_home* variables in `/modules/apim_common/manifests/params.pp` accordingly.

3. Run the relevant profile on the **Puppet agent**.

    1. Default profile:

        ```bash

        export FACTER_profile=apim

        puppet agent -vt

        ```

    2. Gateway profile:

       ```bash

       export FACTER_profile=apim_gateway

       puppet agent -vt

       ```

    3. Control Plane profile:

       ```bash

       export FACTER_profile=apim_control_plane

       puppet agent -vt

       ```

    4. Traffic Manager profile:

       ```bash

       export FACTER_profile=apim_tm

       puppet agent -vt

       ```

## Performance Tuning

System configurations can be changed through Puppet to optimize OS level performance. Performance tuning can be enabled by changing `$enable_performance_tuning` in `/modules/apim_common/manifests/params.pp` to `true`.

System files that will be updated when performance tuning is enabled are available in `/modules/apim_common/files/system`. Update the configuration values according to the requirements of your deployment.

## Manifests in a module

![Module architecture](docs/images/module_architecture.png "Module architecture")

The run stages for Puppet are described in `/manifests/site.pp`, and they are of the order Main -> Custom.

Each Puppet module contains the following .pp files.

* Main

    * params.pp: Contains all the parameters necessary for the main configuration and template.

    * init.pp: Contains the main script of the module.

* Custom

    * custom.pp: Used to add custom configurations to the Puppet module.