Replication.xml
This file specifies the schema for the replication properties.
replication
Properties defining replication.
The following table lists the attributes that an element of type replication can have:
| Name | Type | Description | Required |
|---|---|---|---|
| kubernetes-enabled | push:boolean | DEPRECATED SINCE 6.11. Use the official Hazelcast feature instead. Specifies whether Kubernetes replication configuration is enabled for this server. Defaults to 'false'. | false |
The following table lists the elements that an element of type replication can contain:
| Name | Type | Description | Min occurs | Max occurs |
|---|---|---|---|---|
| provider | push:string | The type of replication provider to use to replicate the data. Currently only Hazelcast is supported. | 1 | 1 |
| connector | push:string | The name of the connector used to configure connections to other servers in the cluster. A connector with the corresponding name should be configured in Connectors.xml. The connector determines the listen host and port, buffer sizes, and the outbound queue size. If this element is not set, the first configured connector will be used instead and a warning will be issued. The connector must be configured as required to start the server (the default behavior) and not have any start conditions. | 0 | 1 |
| external-host | push:string | Optional override of the host name peer servers should use to connect to this server. If not specified, the host name will be derived from the configured connector. The external-host and external-port attributes allow for deployments to environments that use network address translation. | 0 | 1 |
| external-port | push:port | Optional override of the port peer servers should use to connect to this server. If not specified, the port will be derived from the configured connector. The external-host and external-port attributes allow for deployments to environments that use network address translation. | 0 | 1 |
| quorum | push:int | Optional quorum size. Diffusion will only start once the size of the cluster satisfies the quorum. Diffusion will shutdown if the size of the cluster falls below the quorum. The quorum size must be at least two. | 0 | 1 |
| sessionReplication | The definition for session replication | 1 | 1 | |
| topicReplication | The definition for topic replication | 1 | 1 | |
| configurationReplication | The definition for configuration replication. If configuration replication is enabled, configuration items (including topic views, metric collectors, security stores, remote servers) are replicated, even if session and topic replication are disabled. If either session or topic replication is enabled, configuration items are replicated, regardless of this setting. | 0 | 1 |
sessionReplication
Properties defining session replication.
The following table lists the attributes that an element of type sessionReplication can have:
| Name | Type | Description | Required |
|---|---|---|---|
| enabled | push:boolean | Specifies whether session replication is enabled for this server. | true |
topicReplication
Properties defining topic replication.
The following table lists the attributes that an element of type topicReplication can have:
| Name | Type | Description | Required |
|---|---|---|---|
| enabled | push:boolean | Specifies whether topic replication is enabled for this server. | true |
The following table lists the elements that an element of type topicReplication can contain:
| Name | Type | Description | Min occurs | Max occurs |
|---|---|---|---|---|
| topics | DEPRECATED SINCE 6.11. This element is now optional and if omitted, all topics will be replicated. The ability to specify topics to be replicated, or excluded from replication will be removed in a future release. The topics that are configured to use replication. | 0 | 1 |
configurationReplication
Properties defining configuration replication.
The following table lists the attributes that an element of type configurationReplication can have:
| Name | Type | Description | Required |
|---|---|---|---|
| enabled | push:boolean | Specifies whether configuration replication is enabled for this server. Setting this to true enables configuration items to be replicated regardless of whether session and/or topic replication is enabled. If session or topic replication is enabled then configuration items will be replicated anyway, so this setting would be ignored. | true |
topics
DEPRECATED SINCE 6.11. The ability to specify included or excluded topics will be removed in a future release. Properties defining the topics to replicate. Paths must all be either inclusive or exclusive. It is not possible to include some paths and exclude others.
The following table lists the elements that an element of type topics can contain:
| Name | Type | Description | Min occurs | Max occurs |
|---|---|---|---|---|
| includes | push:string | A path that identifies the root of a tree that will be replicated by this server. The path can be of any depth. | 0 | unbounded |
| excludes | push:string | A path that identifies the root of a tree that will not be replicated by this server. The path cannot be more than one level deep. | 0 | unbounded |