Skip to content

Commit

Permalink
Update REFERENCE.md, remove docs dir from master
Browse files Browse the repository at this point in the history
Update REFERENCE.md, as docs haven't been regenerated for a while.
We should either not push the HTML docs, or put them in gh-pages. This is still
under discussion.
  • Loading branch information
wyardley committed Dec 6, 2018
1 parent 24abdd6 commit 150b974
Show file tree
Hide file tree
Showing 49 changed files with 48 additions and 11,939 deletions.
72 changes: 35 additions & 37 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

rabbitmq

 @param $loopback_users. default defined in param.pp. This option configures a list of users to allow access via the loopback interfaces
 @param loopback_users This option configures a list of users to allow access via the loopback interfaces

#### Examples

Expand Down Expand Up @@ -165,7 +165,9 @@ Default value: $rabbitmq::params::admin_enable

Data type: `Optional[Array]`

An array specifying authorization/authentication backend to use. Single quotes should be placed around array entries, ex. ['{foo, baz}', 'baz'] Defaults to [rabbit_auth_backend_internal], and if using LDAP defaults to [rabbit_auth_backend_internal, rabbit_auth_backend_ldap].
An array specifying authorization/authentication backend to use. Single quotes should be placed around array entries,
ex. `['{foo, baz}', 'baz']` Defaults to [rabbit_auth_backend_internal], and if using LDAP defaults to [rabbit_auth_backend_internal,
rabbit_auth_backend_ldap].

Default value: `undef`

Expand Down Expand Up @@ -241,6 +243,14 @@ The path to write the RabbitMQ configuration file to.

Default value: $rabbitmq::params::config_path

##### `config_ranch`

Data type: `Boolean`

When true, suppress config directives needed for older (<3.6) RabbitMQ versions.

Default value: $rabbitmq::params::config_ranch

##### `config_management_variables`

Data type: `Hash`
Expand Down Expand Up @@ -535,8 +545,8 @@ Data type: `Optional[String]`

RPM package GPG key to import. Uses source method. Should be a URL for Debian/RedHat OS family, or a file name for
RedHat OS family. Set to https://www.rabbitmq.com/rabbitmq-release-signing-key.asc for RedHat OS Family and
https://packagecloud.io/rabbitmq/rabbitmq-server/gpgkey for Debian OS Family by default. Note, that `key_content`, if
specified, would override this parameter for Debian OS family.
https://packagecloud.io/rabbitmq/rabbitmq-server/gpgkey for Debian OS Family by default. Note, that `key_content`, if specified, would
override this parameter for Debian OS family.

Default value: $rabbitmq::params::package_gpg_key

Expand Down Expand Up @@ -589,12 +599,19 @@ The name of the service to manage.

Default value: $rabbitmq::params::service_name

##### `service_restart`

Data type: `Boolean`

Default defined in param.pp. Whether to restart the service on config change.

Default value: $rabbitmq::params::service_restart

##### `ssl`

Data type: `Boolean`

Configures the service for using SSL.
port => UNSET

Default value: $rabbitmq::params::ssl

Expand Down Expand Up @@ -674,7 +691,8 @@ Default value: `undef`

Data type: `Boolean`

Configures the service to only use SSL. No cleartext TCP listeners will be created. Requires that ssl => true and
Configures the service to only use SSL. No cleartext TCP listeners will be created. Requires that ssl => true and
port => undef

Default value: $rabbitmq::params::ssl_only

Expand Down Expand Up @@ -742,10 +760,6 @@ rabbitmq.config SSL verify setting for rabbitmq_management.

Default value: $rabbitmq::params::ssl_management_verify

##### `ssl_manaagement_fail_if_no_peer_cert`

rabbitmq.config `fail_if_no_peer_cert` setting for rabbitmq_management.

##### `ssl_versions`

Data type: `Optional[Array]`
Expand Down Expand Up @@ -835,41 +849,41 @@ Default value: $rabbitmq::params::wipe_db_on_cookie_change

Data type: `String`

OS dependent, default defined in param.pp. The system user the rabbitmq daemon runs as.
OS dependent The system user the rabbitmq daemon runs as.

Default value: $rabbitmq::params::rabbitmq_user

##### `rabbitmq_group`

Data type: `String`

OS dependent, default defined in param.pp. The system group the rabbitmq daemon runs as.
OS dependent The system group the rabbitmq daemon runs as.

Default value: $rabbitmq::params::rabbitmq_group

##### `rabbitmq_home`

Data type: `Stdlib::Absolutepath`

OS dependent. default defined in param.pp. The home directory of the rabbitmq deamon.
OS dependent The home directory of the rabbitmq deamon.

Default value: $rabbitmq::params::rabbitmq_home

##### `$rabbitmqadmin_package`

OS dependent. default defined in param.pp. If undef: install rabbitmqadmin via archive, otherwise via package
##### `rabbitmqadmin_package`

##### `$archive_options.`
Data type: `Optional[String]`

default defined in param.pp. Extra options to Archive resource to download rabbitmqadmin file
OS dependent If undef: install rabbitmqadmin via archive, otherwise via package

##### `config_ranch`
Default value: $rabbitmq::params::rabbitmqadmin_package

Data type: `Boolean`
##### `archive_options`

Data type: `Array`

Extra options to Archive resource to download rabbitmqadmin file

Default value: $rabbitmq::params::config_ranch
Default value: $rabbitmq::params::archive_options

##### `package_source`

Expand All @@ -895,22 +909,6 @@ Data type: `Boolean`

Default value: $rabbitmq::params::ssl_management_fail_if_no_peer_cert

##### `rabbitmqadmin_package`

Data type: `Optional[String]`



Default value: $rabbitmq::params::rabbitmqadmin_package

##### `archive_options`

Data type: `Array`



Default value: $rabbitmq::params::archive_options

##### `loopback_users`

Data type: `Array`
Expand Down
Loading

0 comments on commit 150b974

Please sign in to comment.