REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• orcus: Installs and configures orcus.

Private Classes

• orcus::config: Private class for managing orcus config.
• orcus::install: Private class for installing orcus.
• orcus::params: Private class for setting default orcus parameters.
• orcus::service: Private class for managing orcus service.

Functions

• orcus_config: Convert hash to Orcus TOML config.

Classes

orcus

Installs and configures orcus.

Examples

Install orcus.

class { 'orcus':
  override_config  => {
    general => {
      listen_address => '127.0.0.1:3008',
    }
  }
}

Parameters

The following parameters are available in the orcus class.

package_name

Data type: String

Package containing orcus. Defaults to 'orcus'.

Default value: $orcus::params::package_name

version

Data type: String

Version of orcus. Defaults to 'latest'.

Default value: $orcus::params::version

manage_service

Data type: Boolean

Specifies whether orcus service should be managed. Defaults to 'true'.

Default value: $orcus::params::manage_service

user

Data type: String

User for orcus. Defaults to 'orcus'.

Default value: $orcus::params::user

group

Data type: String

User for orcus. Defaults to 'orcus'.

Default value: $orcus::params::group

package_install_options

Data type: Array[String]

Array of install options for managed package resources. Appropriate options are passed to package manager.

Default value: $orcus::params::package_install_options

override_config

Data type: Hash

Hash of override configuration options for orcus

Default value: {}

Functions

orcus_config

Type: Ruby 3.x API

Convert hash to Orcus TOML config.