REFERENCE.md

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