REFERENCE.md

Reference

Table of Contents

Classes

• anysync: configures the anysync module
• anysync::consensusnode::config
• anysync::consensusnode::install
• anysync::consensusnode::monitoring
• anysync::consensusnode::service
• anysync::coordinator::config
• anysync::coordinator::install
• anysync::coordinator::monitoring
• anysync::coordinator::service
• anysync::filenode::config
• anysync::filenode::install
• anysync::filenode::monitoring
• anysync::filenode::service
• anysync::node::config
• anysync::node::install
• anysync::node::monitoring
• anysync::node::service

Classes

anysync

configures the anysync module

Parameters

The following parameters are available in the anysync class:

• node
• filenode
• coordinator
• consensusnode
• syslog_ng
• monitoring

node

Data type: Boolean

enable or disable "tree node" daemon

filenode

Data type: Boolean

enable or disable "filenode" daemon

coordinator

Data type: Boolean

enable or disable "coordinator" daemon

consensusnode

Data type: Boolean

enable or disable "consensusnode" daemon

syslog_ng

Data type: Boolean

enable or disable syslog-ng configuration for logging

monitoring

Data type: Boolean

enable or disable monitoring manifests

anysync::consensusnode::config

The anysync::consensusnode::config class.

Parameters

The following parameters are available in the anysync::consensusnode::config class:

• cfg
• accounts
• user
• group
• daemon_name
• syslog_ng

cfg

Data type: Hash

Defines config for daemon

accounts

Data type: Hash

Defines "account" settings for all nodes (see "any_sync_accounts" in README.md)

user

Data type: String

Defines user for daemon files and process

group

Data type: String

Defines group for daemon files and process

daemon_name

Data type: String

Defines daemon name

syslog_ng

Data type: Boolean

enable or disable syslog-ng configuration for logging

Default value: $::anysync::syslog_ng

anysync::consensusnode::install

The anysync::consensusnode::install class.

Parameters

The following parameters are available in the anysync::consensusnode::install class:

• githubartifact

githubartifact

Data type: Hash

Defines config for githubartifact

anysync::consensusnode::monitoring

The anysync::consensusnode::monitoring class.

anysync::consensusnode::service

The anysync::consensusnode::service class.

anysync::coordinator::config

The anysync::coordinator::config class.

Parameters

The following parameters are available in the anysync::coordinator::config class:

• cfg
• accounts
• user
• group
• daemon_name
• syslog_ng

cfg

Data type: Hash

Defines config for daemon

accounts

Data type: Hash

Defines "account" settings for all nodes (see "any_sync_accounts" in README.md)

user

Data type: String

Defines user for daemon files and process

group

Data type: String

Defines group for daemon files and process

daemon_name

Data type: String

Defines daemon name

syslog_ng

Data type: Boolean

enable or disable syslog-ng configuration for logging

Default value: $::anysync::syslog_ng

anysync::coordinator::install

The anysync::coordinator::install class.

Parameters

The following parameters are available in the anysync::coordinator::install class:

• githubartifact

githubartifact

Data type: Hash

Defines config for githubartifact

anysync::coordinator::monitoring

The anysync::coordinator::monitoring class.

anysync::coordinator::service

The anysync::coordinator::service class.

anysync::filenode::config

The anysync::filenode::config class.

Parameters

The following parameters are available in the anysync::filenode::config class:

• cfg
• accounts
• user
• group
• daemon_name
• aws_credentials
• syslog_ng

cfg

Data type: Hash

Defines config for daemon

accounts

Data type: Hash

Defines "account" settings for all nodes (see "any_sync_accounts" in README.md)

user

Data type: String

Defines user for daemon files and process

group

Data type: String

Defines group for daemon files and process

daemon_name

Data type: String

Defines daemon name

aws_credentials

Data type: Hash

Defines credentials for access to s3

syslog_ng

Data type: Boolean

enable or disable syslog-ng configuration for logging

Default value: $::anysync::syslog_ng

anysync::filenode::install

The anysync::filenode::install class.

Parameters

The following parameters are available in the anysync::filenode::install class:

• githubartifact

githubartifact

Data type: Hash

Defines config for githubartifact

anysync::filenode::monitoring

The anysync::filenode::monitoring class.

anysync::filenode::service

The anysync::filenode::service class.

anysync::node::config

The anysync::node::config class.

Parameters

The following parameters are available in the anysync::node::config class:

• cfg
• accounts
• user
• group
• daemon_name
• syslog_ng

cfg

Data type: Hash

Defines config for daemon

accounts

Data type: Hash

Defines "account" settings for all nodes (see "any_sync_accounts" in README.md)

user

Data type: String

Defines user for daemon files and process

group

Data type: String

Defines group for daemon files and process

daemon_name

Data type: String

Defines daemon name

syslog_ng

Data type: Boolean

enable or disable syslog-ng configuration for logging

Default value: $::anysync::syslog_ng

anysync::node::install

The anysync::node::install class.

Parameters

The following parameters are available in the anysync::node::install class:

• githubartifact

githubartifact

Data type: Hash

Defines config for githubartifact

anysync::node::monitoring

The anysync::node::monitoring class.

anysync::node::service

The anysync::node::service class.