Skip to content

Latest commit

 

History

History
220 lines (126 loc) · 5.76 KB

REFERENCE.md

File metadata and controls

220 lines (126 loc) · 5.76 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • emqx: A basic module for managing emqx

Private Classes

  • emqx::config: Manage emqx.conf configuration file
  • emqx::install: Manage install of emqx
  • emqx::service: Manage emqx service

Classes

emqx

Installs and configures the emqx package and service

Examples

include emqx

Parameters

The following parameters are available in the emqx class:

install_package_source

Data type: String

The location to source the package from.

Default value: 'https://www.emqx.com/en/downloads/broker'

install_version

Data type: String

The version of emqx. Default: '5.0.25'

Default value: '5.0.25'

install_platform

Data type: String

The os platform in order to download the required package.

Default value: 'el8'

install_package_extension

Data type: String

The file extension for the package.

Default value: 'rpm'

service_ensure

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

The state of the service.

Default value: 'running'

service_enable

Data type: Boolean

Boolean for enabling/disabling the service.

Default value: true

manage_config

Data type: Boolean

Boolean for setting whether to manage emqx.conf.

Default value: true

config_node_name

Data type: String[1]

String for setting the name field for the node config path.

Default value: '[email protected]'

config_node_cookie

Data type: Sensitive[String[1]]

Sensitive string for setting the cookie field for the node config path.

Default value: Sensitive('emqxsecretcookie')

config_node_data_dir

Data type: String

String for setting the data_dir field for the node config path.

Default value: '/var/lib/emqx'

config_node_options

Data type: Hash

Hash for setting additional fields under the node config path. Note: Do not set name, cooke and data_dir fields here.

Default value: {}

config_cluster_name

Data type: String[1]

String for setting the name field for the cluster config path.

Default value: 'emqxcl'

config_cluster_discovery_strategy

Data type: Enum['manual','static','mcast','dns','etcd','k8s']

Enum String for setting the discovery_strategy field for the cluster config path.

Default value: 'manual'

config_cluster_options

Data type: Hash

Hash for setting additional fields under the cluster config path. Note: Do not set name, cooke and data_dir fields here. Note: Do not set name and discovery_strategy fields here.

Default value: {}

config_dashboard_listeners_ssl

Data type: Boolean

Boolean for setting ssl for the dashboard listener configuration. i.e. Use config path if true dashboard.listeners.https, else dashboard.listeners.http.

Default value: false

config_dashboard_listeners_bind

Data type: Variant[Integer,String[1]]

Integer or String for setting the emqx dashboard bind address as either a port or bind ip:port respectively.

Default value: 18083

config_dashboard_listeners_options

Data type: Hash

Hash for setting additional fields under the dashboard.listeners.http or dashboard.listeners.https config path. Note: Do not set bind and option fields here.

Default value: {}

config_authorization_options

Data type: Hash

Hash for setting additional fields under the authorization config path.

Default value:

{
  deny_action => 'ignore',
  no_match => 'allow',
  cache => '{ enable = true }',
}
config_additional_configs

Data type: Hash

Hash for setting additional config paths and fields. Note: Do not set the following config_paths here: node, cluster, dashboard, authorization.

Default value: {}