apics

Table of Contents

1. Description
2. Setup - The basics of getting started with apics
   • Setup requirements
   • Beginning 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.