Forge Home

apics

Manages Oracle API Platform gateway nodes.

5,480 downloads

1,837 latest version

5.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.

Version information

  • 0.8.0 (latest)
  • 0.7.0
  • 0.6.0
  • 0.5.3
  • 0.5.2 (deleted)
  • 0.5.1
  • 0.5.0
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Sep 10th 2020
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
  • , ,
Tasks:
  • gateway

Start using this module

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

Add this module to your Puppetfile:

mod 'whanwells-apics', '0.8.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add whanwells-apics
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install whanwells-apics --version 0.8.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

whanwells/apics — version 0.8.0 Sep 10th 2020

apics

Table of Contents

  1. Description
  2. Setup - The basics of getting started with apics
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

The apics module provides types and tasks for managing an Oracle API Platform gateway node.

Setup

Setup Requirements

Users of this module are responsible for the following prerequisites:

  • Installing the unzip package
  • Installing a certified Oracle JDK
  • Creating the gateway node user and group

Beginning with apics

Extract the gateway node installer.

apics::gateway_installer { '/opt/installer':
  ensure => present,
  owner  => 'oracle',
  group  => 'oracle',
  source => '/tmp/ApicsGatewayInstaller.zip',
}

Create the gateway property file in the installer directory.

apics::gateway_props { '/opt/installer/gateway-props.json':
  ensure  => present,
  owner   => 'oracle',
  group   => 'oracle',
  content => {
    'nodeInstallDir'  => '/opt/oracle/gateway',
    'listenIpAddress' => $facts['ipaddress'],
    # ...
  },
}

Usage

Executing gateway actions

Use the apics::gateway task to execute gateway actions on nodes.

bolt task run apics::gateway --targets node1 \
  java_home=/usr/java/default \
  path=/opt/installer \
  file=gateway-props.json \
  action=status

To pass additional key value pairs to the action, pass a JSON array of pairs to the keyvalue parameter.

bolt task run apics::gateway --targets node1 \
  java_home=/usr/java/default \
  path=/opt/installer \
  file=gateway-props.json \
  action=join \
  keyvalue='["logicalGatewayId=123"]'

Reference

See REFERENCE.md.

Limitations

For a list of supported operating systems, see metadata.json.

Development

Acceptance tests for this module leverage puppet_litmus.