REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• wforce: Install and configure weakforced

Private Classes

• wforce::config: Setup configuration files
• wforce::package: Install packages
• wforce::repo: Setup software repositories
• wforce::service: Manage the system service

Classes

wforce

Install and configure weakforced

Parameters

The following parameters are available in the wforce class:

• acls
• address
• config_file
• config_manage
• config_mode
• config_template
• database_defaults
• databases
• fieldmaps
• functions
• function_args
• group
• package_ensure
• package_manage
• package_name
• password
• port
• repo_manage
• service_ensure
• service_name
• service_manage
• siblings
• siblings_address
• siblings_key
• siblings_port
• socket_address
• socket_port
• sync_enable
• sync_host
• sync_myip
• sync_password
• sync_port
• sync_uptime
• use_functions
• user
• whitelist

acls

Data type: Array

A list of ACLs for the weakforced service.

address

Data type: String

The listen address for the weakforced webserver.

config_file

Data type: String

Path to the configuration file.

config_manage

Data type: Boolean

Whether configuration files should be managed.

config_mode

Data type: String

File mode to be used for config files.

config_template

Data type: String

Specifies the EPP template to use.

database_defaults

Data type: Hash

Default values for database configuration.

databases

Data type: Hash

A list of databases.

fieldmaps

Data type: Hash

A list of fieldmaps.

functions

Data type: Hash

A list of Lua functions (Lua source code).

function_args

Data type: Hash

A list of arguments that are passed to functions.

group

Data type: String

The group under which the service will run.

package_ensure

Data type: String

The desired state of the package resource.

package_manage

Data type: Boolean

Whether package installation/removal should be managed.

package_name

Data type: String

The name of the package.

password

Data type: String

The weakforced API password.

port

Data type: Integer

The weakforced port number.

repo_manage

Data type: Boolean

Whether package repositories should be managed.

service_ensure

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

The desired state of the service resource.

service_name

Data type: String

The name of the service.

service_manage

Data type: Boolean

Whether the service should be managed.

siblings

Data type: Array

A list of replication targets.

siblings_address

Data type: String

The replication address of the local service.

siblings_key

Data type: Optional[String]

The credential key used for replication.

Default value: undef

siblings_port

Data type: Integer

The replication port of the local service.

socket_address

Data type: String

The listen address of the control socket.

socket_port

Data type: Integer

The port number of the control socket.

sync_enable

Data type: Boolean

Whether to enable replication of databases from remote servers.

sync_host

Data type: Optional[String]

The source host for database replication.

Default value: undef

sync_myip

Data type: Optional[String]

The IP address of the local instance.

Default value: undef

sync_password

Data type: Optional[String]

The password used for replication.

Default value: undef

sync_port

Data type: Optional[Integer]

The port used for database replication.

Default value: undef

sync_uptime

Data type: Integer

The minimum uptime (in seconds) of a host before replication is considered.

use_functions

Data type: Hash

A list of Lua functions that will be used to handle weakforced commands.

user

Data type: String

The user under which the service will run.

whitelist

Data type: Array

A list of subnets that are allowed to communicate with the weakforce service.