h1. Introduction
{section}
{column}
The Petals ESB Hazelcast Registry node configuration is divided into several parts:
* an [environment configuration|#EnvironmentConfig] to set the right options of the JVM running the Petals ESB Hazelcast Registry node,
* a [node configuration|#NodeConfig] to set all parameters that are internal to the Petals ESB Hazelcast Registry node (ie. that are not used by other nodes),
* a [logging configuration|Logging in Petals ESB Hazelcast Registry] to configure the logging systems of the Petals ESB Hazelcast Registry node,
* the [cluster configuration|Petals ESB Hazelcast Registry Configuration] in which the Petals ESB Hazelcast Registry node is running, to define other nodes of the Petals ESB Hazelcast Registry cluster.
{column}
{column:width=35%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}
{anchor:EnvironmentConfig}
h1. Node environment configuration
The environment configuration aims to set the right options of the JVM. For example, it is in this configuration that you set the memory size of the JVM running your Petals ESB Hazelcast Registry node.
Each installation archive comes with a default environment configuration:
|| Installation archive || Default environment configuration file ||
| ZIP archive | {{$PETALS_REGISTRY_HOME/conf/env.sh}} |
| Debian package | {{/etc/petals-registry/default-env.sh}} |
For all installation, the default environment configuration file can be updated to adjust parameters to your environment. But for a Debian-based installation, it is recommended to create your own environment configuration and define it in the configuration of your Petals ESB Hazelcast Registry node through the property {{petals.environment.config.file}}.
{anchor:NodeConfig}
h1. Node configuration reference
The node configuration is located into the file {{member.properties}} and expressed as property (key/value).
A property value can be set using the value of another property as a variable using a placeholder mechanism, and you can add your own properties:
{code}
my-identifier = sample-member-0
petals.registry.overlay.member.logging-cfg-file=/etc/petals-registry/member-available/${my-identifier}/logging.properties
{code}
{note}
The property {{petals.environment.config.file}} does not accept placeholder.
{note}
{anchor:NodeConfigRef}
h2. Node configuration reference
|| Parameter/Property name || Default value || Description ||
| {{petals.registry.overlay.member.local-identifier}} | \- | Name of the Petals ESB Hazelcast Registry node. *MUST* match a member identifier in the [cluster|Petals ESB Hazelcast Registry Configuration] |
| {{petals.registry.overlay.member.listening.interface}} | {{localhost}} | The network interface Petals will listen to communicate with other members of the cluster |
|| Paths || || ||
| {{petals.registry.overlay.member.logging-cfg-file}} | The file '{{logging.properties}}' located in the same path than the local node configuration, ie. {{member.properties}}. | Configuration file of the logging system. See [Logging in Petals ESB Hazelcast Registry|Logging in Petals ESB Hazelcast Registry] |
|| Cluster || || ||
| {{petals.registry.overlay.cluster-definition}} | {{cluster.xml}}^[1|#default_value_cluster_xml]^ | URL of the [cluster definition|Petals ESB Hazelcast Registry Configuration]. |
|| JMX || || ||
| {{petals.registry.overlay.member.jmx.server.connector.disable}} | {{false}} | If {{false}}, the JMX API will be disabled. *Recommended value: {{true}}*.|
| {{petals.registry.overlay.member.jmx.port}} | {{7750}} | The listening port of the JMX API. |
| {{petals.registry.overlay.member.jmx.username}} | {{petals}} | Username part of the JMX API credentials |
| {{petals.registry.overlay.member.jmx.password}} | {{petals}} | Password part of the JMX API credentials |
{anchor:default_value_cluster_xml}+Note 1:+ If the node configuration, ie. {{member.properties}}, is defined by a file-based URL, the default value is {{cluster.xml}} in the same directory than the node configuration. Otherwise, no default value is defined and a value *MUST* be provided.
{section}
{column}
The Petals ESB Hazelcast Registry node configuration is divided into several parts:
* an [environment configuration|#EnvironmentConfig] to set the right options of the JVM running the Petals ESB Hazelcast Registry node,
* a [node configuration|#NodeConfig] to set all parameters that are internal to the Petals ESB Hazelcast Registry node (ie. that are not used by other nodes),
* a [logging configuration|Logging in Petals ESB Hazelcast Registry] to configure the logging systems of the Petals ESB Hazelcast Registry node,
* the [cluster configuration|Petals ESB Hazelcast Registry Configuration] in which the Petals ESB Hazelcast Registry node is running, to define other nodes of the Petals ESB Hazelcast Registry cluster.
{column}
{column:width=35%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}
{anchor:EnvironmentConfig}
h1. Node environment configuration
The environment configuration aims to set the right options of the JVM. For example, it is in this configuration that you set the memory size of the JVM running your Petals ESB Hazelcast Registry node.
Each installation archive comes with a default environment configuration:
|| Installation archive || Default environment configuration file ||
| ZIP archive | {{$PETALS_REGISTRY_HOME/conf/env.sh}} |
| Debian package | {{/etc/petals-registry/default-env.sh}} |
For all installation, the default environment configuration file can be updated to adjust parameters to your environment. But for a Debian-based installation, it is recommended to create your own environment configuration and define it in the configuration of your Petals ESB Hazelcast Registry node through the property {{petals.environment.config.file}}.
{anchor:NodeConfig}
h1. Node configuration reference
The node configuration is located into the file {{member.properties}} and expressed as property (key/value).
A property value can be set using the value of another property as a variable using a placeholder mechanism, and you can add your own properties:
{code}
my-identifier = sample-member-0
petals.registry.overlay.member.logging-cfg-file=/etc/petals-registry/member-available/${my-identifier}/logging.properties
{code}
{note}
The property {{petals.environment.config.file}} does not accept placeholder.
{note}
{anchor:NodeConfigRef}
h2. Node configuration reference
|| Parameter/Property name || Default value || Description ||
| {{petals.registry.overlay.member.local-identifier}} | \- | Name of the Petals ESB Hazelcast Registry node. *MUST* match a member identifier in the [cluster|Petals ESB Hazelcast Registry Configuration] |
| {{petals.registry.overlay.member.listening.interface}} | {{localhost}} | The network interface Petals will listen to communicate with other members of the cluster |
|| Paths || || ||
| {{petals.registry.overlay.member.logging-cfg-file}} | The file '{{logging.properties}}' located in the same path than the local node configuration, ie. {{member.properties}}. | Configuration file of the logging system. See [Logging in Petals ESB Hazelcast Registry|Logging in Petals ESB Hazelcast Registry] |
|| Cluster || || ||
| {{petals.registry.overlay.cluster-definition}} | {{cluster.xml}}^[1|#default_value_cluster_xml]^ | URL of the [cluster definition|Petals ESB Hazelcast Registry Configuration]. |
|| JMX || || ||
| {{petals.registry.overlay.member.jmx.server.connector.disable}} | {{false}} | If {{false}}, the JMX API will be disabled. *Recommended value: {{true}}*.|
| {{petals.registry.overlay.member.jmx.port}} | {{7750}} | The listening port of the JMX API. |
| {{petals.registry.overlay.member.jmx.username}} | {{petals}} | Username part of the JMX API credentials |
| {{petals.registry.overlay.member.jmx.password}} | {{petals}} | Password part of the JMX API credentials |
{anchor:default_value_cluster_xml}+Note 1:+ If the node configuration, ie. {{member.properties}}, is defined by a file-based URL, the default value is {{cluster.xml}} in the same directory than the node configuration. Otherwise, no default value is defined and a value *MUST* be provided.