Code Monkey home page Code Monkey logo

puppet-apim-1's Introduction

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 5.4.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 a wso2am-3.2.0.zip, wso2am-analytics-3.2.0.zip, or wso2is-km-5.10.0.zip to your preferred deployment pattern and copy it to the <puppet_environment>/modules/apim_common/files/packs directory in the Puppetmaster.
    • Remote:
      1. Change the value $pack_location variable in <puppet_environment>/modules/apim_common/manifests/params.pp to remote.
      2. Change the value $remote_pack variable of the relevant profile in <puppet_environment>/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. 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 and copy .tar into the <puppet_environment>/modules/apim_common/files/jdk directory.
    • remote: Change the value $remote_jdk variable in <puppet_environment>/modules/apim_common/manifests/params.pp to the URL in which the JDK should be downloaded from, and remove it as a comment.
    • Reassign the $jdk_name variable in <puppet_environment>/modules/apim_common/manifests/params.pp to the name of the downloaded JDK distribution.
  3. Run the relevant profile on the Puppet agent.

    1. Default profile:
      export FACTER_profile=apim
      puppet agent -vt
    2. Gateway profile:
      export FACTER_profile=apim_gateway
      puppet agent -vt
    3. Key Manager profile:
      export FACTER_profile=apim_km
      puppet agent -vt
    4. IS as Key Manager profile:
      export FACTER_profile=apim_is_as_km
      puppet agent -vt
    5. Publisher profile:
      export FACTER_profile=apim_publisher
      puppet agent -vt
    6. Devportal profile:
      export FACTER_profile=apim_devportal
      puppet agent -vt
    7. Traffic Manager profile:
      export FACTER_profile=apim_tm
      puppet agent -vt
    8. Analytics profile:
      1. Dashboard:
        export FACTER_profile=apim_analytics_dashboard
        puppet agent -vt
      2. Worker:
        export FACTER_profile=apim_analytics_worker
        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 <puppet_environment>/modules/apim_common/manifests/params.pp to true.

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

Manifests in a module

Module architecture

The run stages for Puppet are described in <puppet_environment>/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.

puppet-apim-1's People

Contributors

rmsamitha avatar savidude avatar vimukthiperera avatar anuruddhal avatar irunika avatar vidurananayakkara avatar chamndesilva avatar mariangela avatar pubudu538 avatar thanu avatar ctienshi avatar chamilad avatar maheshika avatar ravihansa3000 avatar nishikadesilva avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.