groundplex

Configures Snaplogic Groundplex nodes

Project URL RSS Feed Report issues

Module Stats

1,293 downloads

187 latest version

5.0 quality score

Version information

released Apr 25th 2023

This version is compatible with:

Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
Puppet >= 6.21.0 < 8.0.0
,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'arden-groundplex', '0.1.2'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add arden-groundplex

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install arden-groundplex --version 0.1.2

Documentation

arden/groundplex — version 0.1.2 Apr 25th 2023

groundplex

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

Description

This module installs and configures the Snaplogic Sidekick module on the current node. It also provides a baseline configuration for SAP connectivity and makes managing the additional service definitions relatively trivial.

Setup

What groundplex affects

Primarily does the following:

Installs the snaplogic-sidecar
Downloads and places the slpropgz file from your Snaplogic Organization
Adds appropriate entries into /etc/services to support connections to SAP instances

Setup Requirements

You'll need to have the following components configured:

snaplogic-sidekick package must be available to the node via your package manager

The following two puppet modules are also dependencies, however, the needed versions are not currently available on puppet forge.

sap - needed for some type alias definitions
etc_services - relevant for syntax changes introduced by this version

SAP Java Connector (Deprecated)

This process is no-longer needed as the Java Connector is bundled into the package.

Download the latest version of the SAP Java Connector from their website
Extract the archive and host the files libsapjco3.jnilib and libsapjco3.so on your puppet0.1.2 or a server your nodes can reach easily.
Calculate the checksums of each file and provide both the source URL and the checksum to the groundplex class.

Beginning with groundplex

The following puppet code defines a node as a standard execution engine (JCC).

class { 'groundplex':
  slpropz_source => 'https://elastic.snaplogic.com/api/1/rest/plex/config/ExampleOrg/shared/Example?expires=1623084093&user_id=someuser%40example.com&_sl_authproxy_key=SomeRandomTokenStuff
  server_type    => 'JCC',
}

Usage

Puppet configuration including SAP connection definitions.

class { 'groundplex':
  slpropz_source    => 'https://elastic.snaplogic.com/api/1/rest/plex/config/ExampleOrg/shared/Example?expires=1623084093&user_id=someuser%40example.com&_sl_authproxy_key=SomeRandomTokenStuff'
  server_type       => 'JCC',
  array_msg_servers => [
    {
      sid            => 'DEV',
      instance_class => 'cs-abap',
      number         => '01',
    },
    {
      sid            => 'QAS',
      instance_class => 'cs-abap',
      number         => '01',
    },
    {
      sid            => 'PRD',
      instance_class => 'cs-abap',
      number         => '01',
    },
  ],
}

Hiera configuration including SAP connection definitions.

groundplex::slpropz_source: 'https://elastic.snaplogic.com/api/1/rest/plex/config/ExampleOrg/shared/Example?expires=1623084093&user_id=someuser%40example.com&_sl_authproxy_key=SomeRandomTokenStuff'
groundplex::server_type: 'JCC'
groundplex::array_msg_servers:
  - sid: 'DEV'
    instance_class: 'cs-abap'
    number: '01'
  - sid: 'QAS'
    instance_class: 'cs-abap'
    number: '01'
  - sid: 'PRD'
    instance_class: 'cs-abap'
    number: '01'

Limitations

Currently only tested on RHEL/CentOS/Rocky 7 and 8.

Development

Make a pull request and we'll figure it out!

Reference

Classes

groundplex: Configures a Snaplogic on-premise execution engine.
groundplex::config: Performs zone creation and update operations. Internal class
groundplex::install: Install the snaplogic-sidekick package
groundplex::service: Internal class which ensures the groundplex process is running

Data types

Groundplex::PuppetUrl: Matches puppet:// paths
Groundplex::SapMessageServer
Groundplex::Sapjco3Config: Content definitions for SAP Java Connector library files.
Groundplex::ServerType: List of valid items to specify in /etc/security/limits.conf
Groundplex::SourceUrl: matches any valid URL type

Classes

`groundplex`

Configures a Snaplogic on-premise execution engine.

Parameters

The following parameters are available in the groundplex class:

service_user
service_group
server_type
slpropz_source
package
array_msg_servers
sapjco_config

`service_user`

Data type: String

Username of the snaplogic service account. Note that this is created by the installation of the agent RPM.

Default value: 'snapuser'

`service_group`

Data type: String

Group name of the snaplogic service user Note that this is created by the installation of the agent RPM.

Default value: 'snapuser'

`server_type`

Data type: Groundplex::ServerType

Determines the role this node will perform in the on-premise environment. Currently this is limited to the following:

JCC - An execution engine node which performs actual pipeline work
FeedMaster - Manages the data feed for Ultra Pipelines

Default value: 'JCC'

`slpropz_source`

Data type: Stdlib::HTTPSUrl

Full URL including API parameters to the snaplogic configuration file associated with this snaplex. This is retrieved from the Downloads tab of the Snaplex Settings dialog in Manager -> Project Spaces -> shared -> Snaplexes.

`package`

Data type: String

Name of the snaplogic agent package. Note that this assumes the presence of a custom repo / mirror which also hosts this file.

Default value: 'snaplogic-sidekick'

`array_msg_servers`

Data type: Array[Groundplex::SapMessageserver]

List of SAP ms server intances which should be added to the /etc/services file on this groundplex host.

Default value: []

`sapjco_config`

Data type: Optional[Groundplex::Sapjco3Config]

When provided, this overrides the default bundled version of SAPJCo with a different version. See the type definition for detail.

Default value: undef

`groundplex::config`

Performs zone creation and update operations. Internal class

Parameters

The following parameters are available in the groundplex::config class:

server_type
service_user
service_group
slpropz_source
array_msg_servers

`server_type`

Data type: Groundplex::ServerType

Controls whether this node is setup as a execution engine, or a feedmaster.

Default value: $groundplex::server_type

`service_user`

Data type: String

Account which runs the groundplex engine.

Default value: $groundplex::service_user

`service_group`

Data type: String

Primary group of the account which runs the groundplex engine.

Default value: $groundplex::service_group

`slpropz_source`

Data type: Stdlib::HTTPSUrl

Source from which the config file is downloaded initially. Note that this URL has an authentication component and currently can't be automatically refreshed.

Default value: $groundplex::slpropz_source

`array_msg_servers`

Data type: Array[Groundplex::SapMessageServer]

List of SAP message servers which are allowed to connect to this snaplogic instance. These are primarily used to create entries in /etc/services

Default value: $groundplex::array_msg_servers

`groundplex::install`

Install the snaplogic-sidekick package

Parameters

The following parameters are available in the groundplex::install class:

package
service_user
service_group
sapjco_config

`package`

Data type: String

Name of the RPM package needed to install the groundplex sidekick

Default value: $groundplex::package

`service_user`

Data type: String

Account which owns the groundplex files.

Default value: $groundplex::service_user

`service_group`

Data type: String

Primary group of the account which owns the files.

Default value: $groundplex::service_group

`sapjco_config`

Data type: Optional[Groundplex::Sapjco3Config]

When provided, this overrides the libsapjco3.so file that is included in Snaplogic by default.

Default value: undef

`groundplex::service`

Internal class which ensures the groundplex process is running

Data types

`Groundplex::PuppetUrl`

Matches puppet:// paths

Alias of

Pattern[/(?i:^puppet?:\/\/)/]

`Groundplex::SapMessageServer`

The Groundplex::SapMessageServer data type.

Alias of

Struct[=>]

Parameters

The following parameters are available in the Groundplex::SapMessageServer data type:

sid
instance_class
number
port_override

`sid`

Matches an SAP instance number

`instance_class`

Used to determine the port set to use for the instance alias

`number`

Two digit instance number (e.g. 01) which is appended to the port prefix determined from the instance class.

`port_override`

Used in exceptional cases to override the port calculation

`Groundplex::Sapjco3Config`

Content definitions for SAP Java Connector library files.

Alias of

Struct[=>]

Parameters

The following parameters are available in the Groundplex::Sapjco3Config data type:

source
sha256

`source`

Some form of URL to a copy of the libsapjco3.so library.

`sha256`

A sha256 hash matching the content of the file referenced by $source.

`Groundplex::ServerType`

List of valid items to specify in /etc/security/limits.conf

Alias of

Enum['JCC', 'FeedMaster']

`Groundplex::SourceUrl`

matches any valid URL type

Alias of

Variant[Stdlib::Httpurl, Stdlib::Httpsurl, Groundplex::PuppetUrl]

Modules

Discover

Contribute

Resources

About Forge

Getting Started

groundplex

Version information

This version is compatible with:

Start using this module

Documentation

groundplex

Table of Contents

Description

Setup

What groundplex affects

Setup Requirements

SAP Java Connector (Deprecated)

See Also

Beginning with groundplex

Usage

Limitations

Development

Reference

Table of Contents

Classes

Data types

Classes

groundplex

Parameters

service_user

service_group

server_type

slpropz_source

package

array_msg_servers

sapjco_config

groundplex::config

Parameters

server_type

service_user

service_group

slpropz_source

array_msg_servers

groundplex::install

Parameters

package

service_user

service_group

sapjco_config

groundplex::service

Data types

Groundplex::PuppetUrl

Groundplex::SapMessageServer

Parameters

sid

instance_class

number

port_override

Groundplex::Sapjco3Config

Parameters

source

sha256

Groundplex::ServerType

Groundplex::SourceUrl

Changelog

0.1.2 (2023-04-25)

Maintenance (2 changes)

0.1.1 (2022-03-14)

Bugfix (1 change)

0.1.0 (2021-06-09)

Feature (3 changes)

Bugfix (2 changes)

Maintenance (3 changes)

Dependencies

`groundplex`

`service_user`

`service_group`

`server_type`

`slpropz_source`

`package`

`array_msg_servers`

`sapjco_config`

`groundplex::config`

`server_type`

`service_user`

`service_group`

`slpropz_source`

`array_msg_servers`

`groundplex::install`

`package`

`service_user`

`service_group`

`sapjco_config`

`groundplex::service`

`Groundplex::PuppetUrl`

`Groundplex::SapMessageServer`

`sid`

`instance_class`

`number`

`port_override`

`Groundplex::Sapjco3Config`

`source`

`sha256`

`Groundplex::ServerType`

`Groundplex::SourceUrl`