puppet-module-openondemand

Table of Contents

1. Overview
   • Supported Versions of Open OnDemand
2. Usage - Configuration options
3. Reference - Parameter and detailed reference to all options
4. Limitations - OS compatibility, etc.

Overview

Manage Open OnDemand installation and configuration.

Supported Versions of Open OnDemand

The following are the versions of this module and the supported versions of Open OnDemand:

• Module 0.x supports Open OnDemand 1.x

Usage

All configuration can be done through the openondemand class. Example configurations will be done in Hiera format.

include ::openondemand

Install specific versions of OnDemand from 1.6 repo with OpenID Connect support.

openondemand::repo_release: '1.6'
openondemand::ondemand_package_ensure: "1.6.11-1.el7"
openondemand::mod_auth_openidc_ensure: "2.3.11-1.el7"

Configure OnDemand SSL certs

openondemand::servername: ondemand.osc.edu
openondemand::ssl:
  - "SSLCertificateFile /etc/pki/tls/certs/%{lookup('openondemand::servername')}.crt"
  - "SSLCertificateKeyFile /etc/pki/tls/private/%{lookup('openondemand::servername')}.key"
  - "SSLCertificateChainFile /etc/pki/tls/certs/%{lookup('openondemand::servername')}-interm.crt"

If you already declare the apache class you may wish to only include apache in this module:

openondemand::declare_apache: false
apache::version::scl_httpd_version: '2.4'
apache::version::scl_php_version: '7.0'
apache::default_vhost: false

Add support for interactive apps

openondemand::host_regex: '[\w.-]+\.osc\.edu'
openondemand::node_uri: '/node'
openondemand::rnode_uri: '/rnode'

Setup OnDemand to authenticate with OpenID Connect system, in these examples the IdP is Keycloak.

openondemand::servername: ondemand.osc.edu
openondemand::auth_type: 'openid-connect'
openondemand::auth_configs:
  - 'Require valid-user'
openondemand::user_map_cmd: /opt/ood/ood_auth_map/bin/ood_auth_map.regex
openondemand::logout_redirect: "/oidc?logout=https%3A%2F%2F%{lookup('openondemand::servername')}"
openondemand::oidc_uri: '/oidc'
openondemand::oidc_provider: 'idp.osc.edu/auth/realms/osc'
openondemand::oidc_provider_token_endpoint_auth: 'client_secret_basic'
openondemand::oidc_provider_scope: 'openid email'
openondemand::oidc_provider_client_id: ondemand.osc.edu
openondemand::oidc_crypto_passphrase: 'SOMEHASH'
openondemand::oidc_provider_client_secret: 'SUPERSECRET'

Configure OnDemand via git repo that contains app configs, locales and public files

openondemand::servername: ondemand.osc.edu
openondemand::apps_config_repo: https://github.com/OSC/osc-ood-config.git
openondemand::apps_config_revision: v30
openondemand::apps_config_repo_path: "%{lookup('openondemand::servername')}/apps"
openondemand::locales_config_repo_path: "%{lookup('openondemand::servername')}/locales"
openondemand::public_files_repo_paths:
  - "%{lookup('openondemand::servername')}/public/logo.png"
  - "%{lookup('openondemand::servername')}/public/favicon.ico"

Define a cluster. The following example is based on a cluster at OSC using Torque

openondemand::clusters:
  owens:
    cluster_title: 'Owens'
    url: 'https://www.osc.edu/supercomputing/computing/owens'
    login_host: 'owens.osc.edu'
    job_adapter: torque
    job_host: 'owens-batch.ten.osc.edu'
    job_bin: /opt/torque/bin
    job_lib: /opt/torque/lib64
    job_version: '6.0.1'
    batch_connect:
      basic:
        script_wrapper: 'module restore\n%s'
      vnc:
        script_wrapper: 'module restore\nmodule load ondemand-vnc\n%s'

Install additional apps of specific versions as well as hide some apps

openondemand::install_apps:
  bc_osc_rstudio_server:
    ensure: "0.8.2-1.el7"
  bc_desktop:
    mode: '0700'

Add usr apps with a default group

openondemand::usr_app_defaults:
  group: staff
openondemand::usr_apps:
  user1:
    gateway_src: /home/user1/ondemand/share
  user2:
    group: faculty
    gateway_src: /home/user2/ondemand/share

Add dev app users

openondemand::dev_app_users:
  - user1
  - user2

Reference

http://osc.github.io/puppet-module-openondemand/

Limitations

This module has been tested on:

• CentOS 7 x86_64
• RedHat 7 x86_64

Reference

Table of Contents

Classes

Public Classes

• openondemand: Manage Open OnDemand

Private Classes

• openondemand::apache: Manage Open OnDemand Apache
• openondemand::config: Manage Open OnDemand configs
• openondemand::install: Manage Open OnDemand install
• openondemand::repo: Manage Open OnDemand repos
• openondemand::service: Manage Open OnDemand service

Defined types

• openondemand::app::dev: Manage Open OnDemand dev app
• openondemand::app::usr: Manage Open OnDemand user app
• openondemand::cluster: Manage Open OnDemand cluster definition
• openondemand::install::app: Manage Open OnDemand app

Data types

• Openondemand::Acl: OnDemand cluster ACL
• Openondemand::Batch_connect: Defines cluster config batch_connect values
• Openondemand::Nginx_stage_namespace_config: nginx_stage.yml namespace_config

Tasks

• maintenance: Put OnDemand into maintenance mode

Classes

openondemand

Manage Open OnDemand

Parameters

The following parameters are available in the openondemand class.

repo_release

Data type: String

The release of OnDemand repo

Default value: 'latest'

repo_baseurl_prefix

Data type: Variant[Stdlib::HTTPSUrl, Stdlib::HTTPUrl]

The baseurl prefix for OnDemand repo

Default value: 'https://yum.osc.edu/ondemand'

repo_gpgkey

Data type: Variant[Stdlib::HTTPSUrl, Stdlib::HTTPUrl, Stdlib::Absolutepath]

The URL for OnDemand repo GPG key

Default value: 'https://yum.osc.edu/ondemand/RPM-GPG-KEY-ondemand'

manage_scl

Data type: Boolean

Boolean that determines if managing SCL

Default value: true

selinux

Data type: Boolean

Boolean that determines if adding SELinux support

Default value: false

ondemand_package_ensure

Data type: String

ondemand package ensure

Default value: 'present'

mod_auth_openidc_ensure

Data type: String

mod_auth_openidc package ensure

Default value: 'present'

install_apps

Data type: Hash

Hash of apps to install, passed to ondemand::install::app

Default value: {}

declare_apache

Data type: Boolean

Boolean that determines if apache is declared or included

Default value: true

apache_scls

Data type: String

SCLs to load when starting Apache service

Default value: 'httpd24 rh-ruby25'

cilogon_client_id

Data type: String

CILogon client_id

Default value: ''

cilogon_client_secret

Data type: String

CILogon client_secret

Default value: ''

oidc_crypto_passphrase

Data type: String

OIDC crypto passphrase

Default value: 'CHANGEME'

listen_addr_port

Data type: Variant[Array, String, Undef]

ood_portal.yml listen_addr_port

Default value: undef

servername

Data type: Optional[String]

ood_portal.yml servername

Default value: undef

ssl

Data type: Optional[Array]

ood_portal.yml ssl

Default value: undef

logroot

Data type: String

ood_portal.yml logroot

Default value: 'logs'

use_rewrites

Data type: Boolean

ood_portal.yml use_rewrites

Default value: true

use_maintenance

Data type: Boolean

ood_portal.yml use_maintenance

Default value: true

maintenance_ip_whitelist

Data type: Array

ood_portal.yml maintenance_ip_whitelist

Default value: []

maintenance_source

Data type: Optional[String]

Source for maintenance index.html

Default value: undef

maintenance_content

Data type: Optional[String]

Content for maintenance index.html

Default value: undef

lua_root

Data type: String

ood_portal.yml lua_root

Default value: '/opt/ood/mod_ood_proxy/lib'

lua_log_level

Data type: Optional[String]

ood_portal.yml lua_log_level

Default value: undef

user_map_cmd

Data type: String

ood_portal.yml user_map_cmd

Default value: '/opt/ood/ood_auth_map/bin/ood_auth_map.regex'

user_env

Data type: Optional[String]

ood_portal.yml user_env

Default value: undef

map_fail_uri

Data type: Optional[String]

ood_portal.yml map_fail_uri

Default value: undef

auth_type

Data type: Enum['CAS', 'openid-connect', 'shibboleth', 'ldap', 'basic']

ood_portal.yml auth_type

Default value: 'basic'

auth_configs

Data type: Optional[Array]

ood_portal.yml auth_configs

Default value: undef

root_uri

Data type: String

ood_portal.yml root_uri

Default value: '/pun/sys/dashboard'

analytics

Data type: Optional[Struct[{url => String, id => String}]]

ood_portal.yml analytics

Default value: undef

public_uri

Data type: String

ood_portal.yml public_uri

Default value: '/public'

public_root

Data type: String

ood_portal.yml public_root

Default value: '/var/www/ood/public'

logout_uri

Data type: String

ood_portal.yml logout_uri

Default value: '/logout'

logout_redirect

Data type: String

ood_portal.yml logout_redirect

Default value: '/pun/sys/dashboard/logout'

host_regex

Data type: String

ood_portal.yml host_regex

Default value: '[^/]+'

node_uri

Data type: Optional[String]

ood_portal.yml node_uri

Default value: undef

rnode_uri

Data type: Optional[String]

ood_portal.yml rnode_uri

Default value: undef

nginx_uri

Data type: String

ood_portal.yml nginx_uri

Default value: '/nginx'

pun_uri

Data type: String

ood_portal.yml pun_uri

Default value: '/pun'

pun_socket_root

Data type: String

ood_portal.yml pun_socket_root

Default value: '/var/run/ondemand-nginx'

pun_max_retries

Data type: Integer

ood_portal.yml pun_max_retries

Default value: 5

oidc_uri

Data type: Optional[String]

ood_portal.yml oidc_uri

Default value: undef

oidc_discover_uri

Data type: Optional[String]

ood_portal.yml oidc_discover_uri

Default value: undef

oidc_discover_root

Data type: Optional[String]

ood_portal.yml oidc_discover_root

Default value: undef

register_uri

Data type: Optional[String]

ood_portal.yml register_uri

Default value: undef

register_root

Data type: Optional[String]

ood_portal.yml register_root

Default value: undef

oidc_provider

Data type: Optional[String]

OIDC provider

Default value: undef

oidc_provider_token_endpoint_auth

Data type: Optional[String]

OIDC provider token_endpoint_auth

Default value: undef

oidc_provider_scope

Data type: String

OIDC provider scope

Default value: 'openid email'

oidc_provider_client_id

Data type: String

OIDC provider client_id

Default value: ''

oidc_provider_client_secret

Data type: String

OIDC provider client_secret

Default value: ''

oidc_session_inactivity_timeout

Data type: Integer

mod_auth_openidc OIDCSessionInactivityTimeout

Default value: 28800

oidc_session_max_duration

Data type: Integer

mod_auth_openidc OIDCSessionMaxDuration

Default value: 28800

oidc_remote_user_claim

Data type: Optional[String]

OIDC provider remote_user claim

Default value: undef

oidc_pass_claims_as

Data type: String

mod_auth_openidc OIDCPassClaimsAs

Default value: 'environment'

oidc_extra_configs

Data type: Hash

OIDC extra settings for mod_auth_openidc

Default value: {}

web_directory

Data type: Stdlib::Absolutepath

Path to main web directory for OnDemand

Default value: '/var/www/ood'

basic_auth_users

Data type: Hash

Hash of resources to pass to httpauth for defining basic auth users Only used with basic auth

Default value: {}

nginx_log_group

Data type: String

Group to set for /var/log/ondemand-nginx

Default value: 'ondemand-nginx'

nginx_stage_ondemand_portal

Data type: String

nginx_stage.yml ondemand_portal

Default value: 'ondemand'

nginx_stage_ondemand_title

Data type: String

nginx_stage.yml ondemand_title

Default value: 'Open OnDemand'

nginx_stage_pun_custom_env

Data type: Hash

nginx_stage.yml pun_custom_env

Default value: {}

nginx_stage_app_root

Data type: Openondemand::Nginx_stage_namespace_config

nginx_stage.yml app_root

Default value: {}

nginx_stage_scl_env

Data type: String

nginx_stage.yml scl_env

Default value: 'ondemand'

nginx_stage_app_request_regex

Data type: Optional[Openondemand::Nginx_stage_namespace_config]

nginx_stage.yml app_request_regex

Default value: undef

clusters

Data type: Hash

Hash of resources to apss to openondemand::cluster

Default value: {}

clusters_hiera_merge

Data type: Boolean

Boolean that determines if clusters should be merged via lookup function

Default value: true

usr_apps

Data type: Variant[Array, Hash]

Resources passed to openondemand::app::usr

Default value: {}

usr_app_defaults

Data type: Hash

Defaults for usr_apps resources

Default value: {}

dev_apps

Data type: Hash

Resources passed to openondemand::app::dev

Default value: {}

dev_app_users

Data type: Array

Users to define as having dev apps, passed to openondemand::app::dev

Default value: []

dev_app_defaults

Data type: Hash

Defaults for dev_apps and dev_app_users

Default value: {}

apps_config_repo

Data type: Optional[String]

Git repo URL for apps config

Default value: undef

apps_config_revision

Data type: Optional[String]

Revision for apps config Git repo

Default value: undef

apps_config_repo_path

Data type: String

Path in apps config Git repo for app configs

Default value: ''

locales_config_repo_path

Data type: Optional[String]

Path in apps config Git repo for locales configs

Default value: undef

apps_config_source

Data type: Optional[String]

Source for apps config, not used if apps_config_repo is defined

Default value: undef

locales_config_source

Data type: Optional[String]

Source for locales config, not used if apps_config_repo is defined

Default value: undef

public_files_repo_paths

Data type: Array

Path to public files in apps config Git repo

Default value: []

manage_logrotate

Data type: Boolean

Boolean that allows disabling management of logrotate

Default value: true

Defined types

openondemand::app::dev

Manage Open OnDemand dev app

Examples

openondemand::app::dev { 'user1': }

Parameters

The following parameters are available in the openondemand::app::dev defined type.

ensure

Data type: Enum['present','absent']

Default value: 'present'

mode

Data type: Stdlib::Filemode

File mode of dev app

Default value: '0755'

owner

Data type: String

Owner of dev app

Default value: 'root'

group

Data type: String

Group owning dev app

Default value: 'root'

home_subdir

Data type: String

The subdirectory under user's home for dev app Not used if gateway_src is defined

Default value: 'ondemand/dev'

gateway_src

Data type: Optional[Stdlib::Absolutepath]

The path to dev app, overrides home_subdir

Default value: undef

openondemand::app::usr

Manage Open OnDemand user app

Examples

openondemand::app::usr { 'user1':
  gateway_src => '/home/user1/ondemand/usr',
}

Parameters

The following parameters are available in the openondemand::app::usr defined type.

gateway_src

Data type: Stdlib::Absolutepath

Path to source of user's apps

ensure

Data type: Enum['present','absent']

Default value: 'present'

mode

Data type: Stdlib::Filemode

The file mode for shared apps

Default value: '0750'

owner

Data type: String

The file owner of shared apps

Default value: 'root'

group

Data type: String

The file group owner of shared apps

Default value: 'root'

openondemand::cluster

Manage Open OnDemand cluster definition

Parameters

The following parameters are available in the openondemand::cluster defined type.

cluster_title

Data type: String

Default value: $name

url

Data type: Optional[Variant[Stdlib::HTTPSUrl, Stdlib::HTTPUrl] ]

Default value: undef

hidden

Data type: Boolean

Default value: false

acls

Data type: Array[Openondemand::Acl]

Default value: []

login_host

Data type: Optional[Stdlib::Host]

Default value: undef

job_adapter

Data type: Optional[Enum['torque','slurm','lsf','pbspro','sge']]

Default value: undef

job_cluster

Data type: Optional[String]

Default value: undef

job_host

Data type: Optional[Stdlib::Host]

Default value: undef

job_lib

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_libdir

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_bin

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_bindir

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_conf

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_envdir

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_serverdir

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_exec

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

sge_root

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

libdrmaa_path

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

job_version

Data type: Optional[String]

Default value: undef

job_bin_overrides

Data type: Hash[String, Stdlib::Absolutepath]

Default value: {}

scheduler_type

Data type: Optional[Enum['moab']]

Default value: undef

scheduler_host

Data type: Optional[Stdlib::Host]

Default value: undef

scheduler_bin

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

scheduler_version

Data type: Optional[String]

Default value: undef

scheduler_params

Data type: Hash

Default value: {}

rsv_query_acls

Data type: Array[Openondemand::Acl]

Default value: []

ganglia_host

Data type: Optional[Stdlib::Host]

Default value: undef

ganglia_scheme

Data type: String

Default value: 'https://'

ganglia_segments

Data type: Array

Default value: ['gweb', 'graph.php']

ganglia_req_query

Data type: Hash

Default value: {'c' => $name}

ganglia_opt_query

Data type: Hash

Default value: {'h' => "%{h}.${::domain}"}

ganglia_version

Data type: String

Default value: '3'

grafana_host

Data type: Optional[Variant[Stdlib::HTTPSUrl,Stdlib::HTTPUrl]]

Default value: undef

grafana_org_id

Data type: Integer

Default value: 1

grafana_theme

Data type: Optional[String]

Default value: undef

grafana_dashboard_name

Data type: Optional[String]

Default value: undef

grafana_dashboard_uid

Data type: Optional[String]

Default value: undef

grafana_dashboard_panels

Data type: Optional[Struct[{ 'cpu' => Integer, 'memory' => Integer, }]]

Default value: undef

grafana_labels

Data type: Optional[Struct[{ 'cluster' => String, 'host' => String, 'jobid' => Optional[String], }]]

Default value: undef

batch_connect

Data type: Hash[String, Openondemand::Batch_connect]

Default value: {}

openondemand::install::app

Manage Open OnDemand app

Examples

openondemand::install::app { 'bc_osc_foo':
  ensure => '0.1.0-1.el7',
}

Parameters

The following parameters are available in the openondemand::install::app defined type.

ensure

Data type: String

Package ensure property if installing from a package

Default value: 'present'

package

Data type: String

Package name for the app

Default value: "ondemand-${name}"

manage_package

Data type: Boolean

Should package be managed

Default value: true

path

Data type: Optional[Stdlib::Absolutepath]

Path to app, defaults to /var/www/ood/apps/sys/$name

Default value: undef

owner

Data type: String

File owner of app

Default value: 'root'

group

Data type: String

File group owner of app

Default value: 'root'

mode

Data type: String

File mode for app

Default value: '0755'

Data types

Openondemand::Acl

OnDemand cluster ACL

Alias of Struct[{ 'adapter' => Enum['group'], 'groups' => Optional[Array], 'type' => Enum['whitelist', 'blacklist'] }]

Openondemand::Batch_connect

Defines cluster config batch_connect values

Alias of Struct[{ 'script_wrapper' => String, }]

Openondemand::Nginx_stage_namespace_config

nginx_stage.yml namespace_config

Alias of Struct[{ 'dev' => Optional[String], 'usr' => Optional[String], 'sys' => Optional[String] }]

Tasks

maintenance

Put OnDemand into maintenance mode

Supports noop? false

Parameters

ensure

Data type: Enum['present','absent']

Set state of maintenance mode

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.

v0.11.0 (2020-06-03)

Full Changelog

Added

• Add manage_logrotate parameter #32 (treydock)

v0.10.0 (2020-06-02)

Full Changelog

Added

• Add support for mod_auth_cas #31 (ghjs)

v0.9.3 (2020-05-18)

Full Changelog

Fixed

• Fix OIDC URLs when SSL not configured #29 (danifr)

v0.9.2 (2020-05-12)

Full Changelog

Fixed

• Make sure osmajor does not contain minor release version #27 (danifr)

v0.9.1 (2020-04-17)

Full Changelog

Fixed

• Fix typo when generating grafana configs #25 (treydock)

v0.9.0 (2020-03-04)

Full Changelog

Added

• Support changing maintenance mode HTML #24 (treydock)

v0.8.0 (2020-03-03)

Full Changelog

Added

• Remove ood-portal.conf unit dropin file #23 (treydock)

v0.7.0 (2020-03-03)

Full Changelog

Added

• Add maintenance task #22 (treydock)

v0.6.0 (2020-03-02)

Full Changelog

Added

• Support grafana in cluster configs #21 (treydock)
• Add use_rewrites, use_maintenance and maintenance_ip_whitelist parameters #20 (treydock)

v0.5.0 (2020-02-11)

Full Changelog

Added

• Better configuration of mod_auth_openidc #18 (treydock)

v0.4.0 (2020-01-20)

Full Changelog

Added

• Add oidc_extra_configs parameter #17 (treydock)

v0.3.0 (2019-11-14)

Full Changelog

Added

• Add nginx_stage_pun_custom_env parameter #15 (treydock)

Fixed

• Fix EL8 support #16 (treydock)

v0.2.0 (2019-10-17)

Full Changelog

Added

• Changes to support 1.7 #14 (treydock)

v0.1.1 (2019-09-19)

Full Changelog

Fixed

• Fix README links #13 (treydock)

v0.1.0 (2019-09-19)

Full Changelog

Changed

• Make cluster url optional and remove default #7 (treydock)
• Remove use of mod_php #4 (treydock)
• Refactor ondemand::cluster to better match v2 configs #3 (treydock)
• Major overhaul #2 (treydock)

Added

• Misc improvements #12 (treydock)
• Add CentOS 7 SCL repo to fix issues with EOL SCLs being removed from CentOS 7.7 #11 (treydock)
• Add README contents #10 (treydock)
• Improvements to simplify module #6 (treydock)
• Improve docs and improve app configs parameters #5 (treydock)
• Convert to PDK module and improvements to pass tests #1 (treydock)

Fixed

• Only add LDAP Apache modules if auth_type is 'ldap' #9 (treydock)
• Fix extra newline issue in cluster config #8 (treydock)

* This Changelog was automatically generated by github_changelog_generator