REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• example: Class to install and configure example. Use this module to install and configure example.
• example::repo: A short summary of the purpose of this class

Private Classes

• example::config: Class to configure example.
• example::install: Class to install example.
• example::service: Class to manage the example service.

Classes

example

Class to install and configure example.

Use this module to install and configure example.

Examples

Declaring the class

include ::example

Parameters

The following parameters are available in the example class:

• archive_source
• group
• install_dir
• install_method
• manage_repo
• manage_service
• manage_user
• package_name
• package_version
• service_name
• service_provider
• service_ensure
• user

archive_source

Data type: Optional[Stdlib::HTTPUrl]

Location of example binary release.

Default value: undef

group

Data type: String[1]

Group that owns example files.

install_dir

Data type: Stdlib::Absolutepath

Location of example binary release.

install_method

Data type: Enum['archive','package']

How to install example.

manage_repo

Data type: Boolean

Manage the example repo.

manage_service

Data type: Boolean

Manage the example service.

manage_user

Data type: Boolean

Manage example user and group.

package_name

Data type: String[1]

Name of package to install.

package_version

Data type: String[1]

Version of example to install.

service_name

Data type: String[1]

Name of service to manage.

service_provider

Data type: String[1]

Init system that is used.

service_ensure

Data type: Enum['running','stopped']

The state of the service.

user

Data type: String[1]

User that owns example files.

example::repo

A description of what this class does

Examples

include example::repo