puppet-globus

Overview

This module manages Globus Connect Server.

Supported Versions of Globus

Currently this module supports Globus 5.4, at least 5.4.61

Usage

Globus v5.4

The steps performed by this module are to install Globus and run the globus endpoint setup and globus node setup commands.

The following is the minimum parameters that must be passed to setup Globus v5.4.

class { 'globus':
  display_name  => 'REPLACE My Site Globus',
  owner         => 'REPLACE-user@example.com',
  organization  => 'REPLACE-My Site',
}

Globus CLI

To install the Globus CLI to /opt/globus-cli and create symlink for executable at /usr/bin/globus:

include globus::cli

Globus Timer

To install the Globus Timer CLI to /opt/globus-timer and create symlink for executable at /usr/bin/globus-timer:

include globus::timer

Globus SDK

To install the Globus SDK to /opt/globus-sdk:

include globus::sdk

Facts

The globus_info fact exposes the information stored in /var/lib/globus-connect-server/info.json. Example:

# facter -p globus_info
{
  endpoint_id => "1c6b6e6a-3791-4213-b3e6-00000001",
  domain_name => "00000001.8443.data.globus.org",
  manager_version => "5.4.11",
  DATA_TYPE => "info#1.0.0",
  client_id => "1c6b6e6a-3791-4213-b3e6-00000001",
  api_version => "1.3.0"
}

Reference

http://treydock.github.io/puppet-module-globus/

Compatibility

Tested using

• RedHat/CentOS 7
• RedHat/Rocky 8 & 9
• Debian 11
• Ubuntu 20.04 & 22.04

Reference

Table of Contents

Classes

Public Classes

• globus: Manage Globus
• globus::cli: Manage Globus CLI
• globus::sdk: Manage Globus SDK
• globus::timer: Manage Globus Timer

Private Classes

• globus::config: Manage globus configs
• globus::install: manage Globus install
• globus::python: Manage Globus Python dependency
• globus::repo::deb: Manage globus repo
• globus::repo::el: Manage globus repo
• globus::service: Manage Globus service
• globus::user: Manage globus user and group

Functions

• globus::endpoint_setup_args
• globus::node_setup_args

Classes

globus

Manage Globus

Examples

Install and setup a Globus v5.4 endpoint

class { 'globus':
  display_name  => 'REPLACE My Site Globus',
  owner         => 'REPLACE-user@example.com',
}

Parameters

The following parameters are available in the globus class:

• release_url
• gcs_repo_baseurl
• gcs_repo_testing_baseurl
• enable_testing_repos
• extra_gridftp_settings
• manage_service
• run_setup_commands
• manage_firewall
• manage_epel
• manage_user
• group_gid
• user_uid
• package_name
• display_name
• project_id
• project_admin
• owner
• organization
• deployment_key
• keywords
• department
• contact_email
• contact_info
• info_link
• description
• public
• incoming_port_range
• outgoing_port_range
• ip_address
• export_node
• import_node

release_url

Data type: Variant[Stdlib::Httpsurl, Stdlib::Httpurl]

Release URL of Globus release RPM

Default value: 'https://downloads.globus.org/toolkit/globus-connect-server/globus-connect-server-repo-latest.noarch.rpm'

gcs_repo_baseurl

Data type: Variant[Stdlib::Httpsurl, Stdlib::Httpurl]

Globus Connect Server repo baseurl

Default value: "https://downloads.globus.org/globus-connect-server/stable/rpm/el/${facts['os']['release']['major']}/\$basearch/"

gcs_repo_testing_baseurl

Data type: Variant[Stdlib::Httpsurl, Stdlib::Httpurl]

Globus testing repo baseurl

Default value: "https://downloads.globus.org/globus-connect-server/testing/rpm/el/${facts['os']['release']['major']}/\$basearch/"

enable_testing_repos

Data type: Boolean

Boolean that sets if testing repos should be added

Default value: false

extra_gridftp_settings

Data type: Array

Additional settings for GridFTP

Default value: []

manage_service

Data type: Boolean

Boolean to set if globus-gridftp-server service is managed

Default value: true

run_setup_commands

Data type: Boolean

Boolean to set if the commands to setup Globus are run (v4 and v5)

Default value: true

manage_firewall

Data type: Boolean

Boolean to set if firewall rules are managed by this module

Default value: true

manage_epel

Data type: Boolean

Boolean to set if EPEL is managed by this repo

Default value: true

manage_user

Data type: Boolean

Boolean to set if the gcsweb user and group are managed by this module

Default value: true

group_gid

Data type: Optional[Integer]

The gcsweb group GID

Default value: undef

user_uid

Data type: Optional[Integer]

The gcsweb user UID

Default value: undef

package_name

Data type: String

Globus package name

Default value: 'globus-connect-server54'

display_name

Data type: String[1]

Display name to use when running 'globus-connect-server endpoint setup'

project_id

Data type: Optional[String[1]]

--project-id use when running 'globus-connect-server endpoint setup'

Default value: undef

project_admin

Data type: Optional[String[1]]

--project-admin use when running 'globus-connect-server endpoint setup'

Default value: undef

owner

Data type: String[1]

--owner use when running 'globus-connect-server endpoint setup'

organization

Data type: String[1]

--organization use when running 'globus-connect-server endpoint setup'

deployment_key

Data type: Stdlib::Absolutepath

--deployment-key use when running 'globus-connect-server endpoint setup' The parent directory of this path must be writable by gcsweb user

Default value: '/var/lib/globus-connect-server/gcs-manager/deployment-key.json'

keywords

Data type: Optional[Array]

--keywords use when running 'globus-connect-server endpoint setup'

Default value: undef

department

Data type: Optional[String]

--department use when running 'globus-connect-server endpoint setup'

Default value: undef

contact_email

Data type: Optional[String]

--contact-email use when running 'globus-connect-server endpoint setup'

Default value: undef

contact_info

Data type: Optional[String]

--contact-info use when running 'globus-connect-server endpoint setup'

Default value: undef

info_link

Data type: Optional[String]

--info-link use when running 'globus-connect-server endpoint setup'

Default value: undef

description

Data type: Optional[String]

--description use when running 'globus-connect-server endpoint setup'

Default value: undef

public

Data type: Boolean

When false pass --private flag to 'globus-connect-server endpoint setup'

Default value: true

incoming_port_range

Data type: Array[Stdlib::Port, 2, 2]

--incoming-port-range use when running 'globus-connect-server node setup'

Default value: [50000, 51000]

outgoing_port_range

Data type: Optional[Array[Stdlib::Port, 2, 2]]

--outgoing-port-range use when running 'globus-connect-server node setup'

Default value: undef

ip_address

Data type: Optional[Stdlib::IP::Address]

--ip-address use when running 'globus-connect-server node setup'

Default value: undef

export_node

Data type: Optional[Stdlib::Absolutepath]

--export-node use when running 'globus-connect-server node setup'

Default value: undef

import_node

Data type: Optional[Stdlib::Absolutepath]

--import-node use when running 'globus-connect-server node setup'

Default value: undef

globus::cli

Manage Globus CLI

Examples

include ::globus::cli

Parameters

The following parameters are available in the globus::cli class:

• ensure
• install_path
• manage_python

ensure

Data type: String[1]

The ensure parameter for PIP installed CLI

Default value: 'present'

install_path

Data type: Stdlib::Absolutepath

Path to install Globus CLI virtualenv

Default value: '/opt/globus-cli'

manage_python

Data type: Boolean

Boolean to set if Python is managed by this class

Default value: true

globus::sdk

Manage Globus SDK

Examples

include globus::sdk

Parameters

The following parameters are available in the globus::sdk class:

• ensure
• install_path
• manage_python

ensure

Data type: String[1]

The ensure parameter for PIP installed SDK

Default value: 'present'

install_path

Data type: Stdlib::Absolutepath

Path to install Globus CLI virtualenv

Default value: '/opt/globus-sdk'

manage_python

Data type: Boolean

Boolean to set if Python is managed by this class

Default value: true

globus::timer

Manage Globus Timer

Examples

include ::globus::timer

Parameters

The following parameters are available in the globus::timer class:

• ensure
• install_path
• manage_python

ensure

Data type: String[1]

The ensure parameter for PIP installed globus-timer-cli

Default value: 'present'

install_path

Data type: Stdlib::Absolutepath

Path to install Globus Timer CLI virtualenv

Default value: '/opt/globus-timer'

manage_python

Data type: Boolean

Boolean to set if Python is managed by this class

Default value: true

Functions

globus::endpoint_setup_args

Type: Ruby 4.x API

The globus::endpoint_setup_args function.

globus::endpoint_setup_args(Hash $values)

The globus::endpoint_setup_args function.

Returns: Any

values

Data type: Hash

globus::node_setup_args

Type: Ruby 4.x API

The globus::node_setup_args function.

globus::node_setup_args(Hash $values)

The globus::node_setup_args function.

Returns: Any

values

Data type: Hash

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v10.0.0 (2023-11-29)

Full Changelog

Changed

• Updates to support Globus Connect Server 5.4.61+ #41 (treydock)
• Major updates, see description #40 (treydock)

v9.0.0 (2023-03-17)

Full Changelog

Changed

• Updates - Including drop Debian 9 support #36 (treydock)

v8.0.0 (2022-08-10)

Full Changelog

Changed

• Require python module >= 6.3.0 #34 (treydock)

Added

• Set allowed puppet-epel version to \< 5.0.0 #32 (yorickps)

Fixed

• Fix ensure_packages usage #33 (treydock)

v7.0.0 (2022-04-05)

Full Changelog

Changed

• Replace CentOS 8 with Rocky 8 #31 (treydock)
• Move globus-timer-cli into dedicated class to avoid conflicts with globus-cli #30 (treydock)

v6.0.1 (2022-04-04)

Full Changelog

Fixed

• Fix execution condition of Exec['globus-node-setup'] #29 (cmd-ntrf)

v6.0.0 (2021-09-07)

Full Changelog

Changed

• Drop Puppet 5 support, add Puppet 7 #25 (treydock)

Added

• Support globus::cli and globus::sdk on ubuntu 20.04 #28 (treydock)
• Update module dependency ranges #27 (treydock)
• Support installing globus-timer-cli #24 (treydock)

Fixed

• Fix node setup fact and only run gcs_manager once node is actually setup #26 (treydock)

v5.2.0 (2020-12-29)

Full Changelog

Added

• Add globus_info fact #23 (treydock)

v5.1.0 (2020-12-29)

Full Changelog

Added

• Use Python 3 for globus::cli and globus::sdk #22 (treydock)

v5.0.0 (2020-12-14)

Full Changelog

Changed

• Rename repo baseurl parameters #18 (treydock)
• BREAKING Switch default to Globus v5.4, numerous parameter changes #17 (treydock)

Added

• Use python3 for EL8 python installs #20 (treydock)
• Support Debian and Ubuntu #19 (treydock)

Fixed

• Fix globus-connect-server setup commands for Globus v5.4 #21 (treydock)

v4.2.0 (2020-11-18)

Full Changelog

Added

• Improve globus::cli and add globus::sdk #15 (treydock)

v4.1.0 (2019-11-14)

Full Changelog

Added

• Add testing repos that are disabled #13 (treydock)

v4.0.0 (2019-10-30)

Full Changelog

Changed

• Support Globus v5 #10 (treydock)

Added

• Use module Hiera data #12 (treydock)
• Add globus CLI class #11 (treydock)

v3.0.1 (2019-07-09)

Full Changelog

Fixed

• Fix repo URLs #9 (treydock)

v3.0.0 (2019-05-15)

Full Changelog

Changed

• Use datatypes for all parameters #6 (treydock)

Added

• Use PDK #8 (treydock)
• Use puppet strings #7 (treydock)
• Support Puppet 5 and 6 and update module dependency versions #5 (treydock)

2.1.0 (2019-05-14)

Full Changelog

Added

• Use beaker4 and update some module development files #4 (treydock)
• add setting of MyProxy CaSubjectDN #3 (gtallan)
• Allow epel management to be disabled #2 (treydock)

2.0.1 (2017-10-28)

Full Changelog

2.0.0 (2017-10-26)

Full Changelog

1.0.0 (2017-10-26)

Full Changelog

0.0.1 (2017-10-26)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator