Deployment

The components required for synchronization are: Agents, Queues, and Sync Engine/processor. These components ensure guaranteed message delivery and recoverability in case some part of the process is temporarily down/offline. The components and their functionality are introduced in Architecture. When RadiantOne is deployed in a cluster, the fault tolerance and recoverability of these components is built into the architecture. This topic is described below.

The queuing system uses RadiantOne Universal Directory stores which are automatically replicated via block replication across all cluster nodes. The Agent and Sync Engine are managed internally by the RadiantOne service. There is always one Agent running in the cluster. There is a sync engine process on each node handling the processing for a set of pipelines which are allocated by the RadiantOne service.

The agent starts automatically once a global sync pipeline is configured. This component manages the change-capture connectors, which includes, deploying, stopping/suspending and starting them as needed. The agent can run on any type of RadiantOne cluster node (follower or leaders) and there is only one agent running at any given time in a RadiantOne cluster. The agent does not consume a lot of memory, and they are not CPU-intensive, so there is no point in running multiple processes to distribute connectors on multiple nodes. One agent is enough per cluster and makes things simpler.

A sync engine/processor starts automatically on all RadiantOne cluster nodes once a global sync pipeline is configured. The distribution of pipeline processing across all sync engines is handled automatically by the RadiantOne service. The sync engines process the transformations associated with their assigned pipelines and send changes to the destination.

If a RadiantOne node fails, the following activities occur:

• The agent is automatically started on another cluster node and this agent starts the capture connectors. The configurations of the capture connectors (e.g. cursor value and properties) are stored locally in a RadiantOne Universal Directory store which is automatically replicated across all cluster nodes. This allows connectors to restart capturing changes from where they left off.
• The queues that store messages waiting to be processed by the sync engine are also automatically replicated across all cluster nodes. All unprocessed messages in the queues will get processed by the new sync engine that is assigned for the pipeline.
• RadiantOne distributes the pipeline processing that was handled by the failed node to a new sync engine running on another node.

A high-level diagram depicting the Global Sync recovery in case a node fails is shown below.

The Agent and Sync Engine process read and/or write into the queues using the credentials configured in the RadiantOne data source named: vdsha

You can view this data source configuration from Main Control Panel > Settings > Server Backend > LDAP Data Sources.

For security reasons, the user account (Bind DN) you have configured in the vdsha data source should be the only one allowed to access the cn=queue and cn=dlqueue naming contexts.

Configure access controls for these root naming contexts from Main Control Panel > Settings > Security > Access Control. Access should only be allowed for the account configured in the vdsha data source. For details on configuring access controls, see the RadiantOne System Administration Guide.

Viewing logs

Transformation and apply components log to {RLI_HOME}\vds_server\logs\sync_engine\sync_engine.log on the RadiantOne node where the sync engine processor that is assigned for the pipeline is running. If RadiantOne is deployed in a cluster, a sync engine processor can be running on one or more nodes and the pipeline processing is distributed across them. Use the Global Sync tab to download the corresponding sync_engine.log file by selecting the topology and selecting Configure next to the pipeline. Select the Apply component and in the Log Viewer section, select Download. You can also view and download the sync_engine.log from the Environment Operations Center.

The upload process logs to the \vds_server\logs\sync_engine\sync_engine.log on the RadiantOne node from where the upload was run. If there is an error during upload when using the Global Sync tab, the error is shown in the Log Viewer. You can search, download and expand the log file from here.

Capture connectors log activity to: \logs\sync_agents\{PIPELINE_ID}\connector.log on the RadiantOne node where the sync agent is running. The connector.log can be viewed and downloaded from the Environment Operations Center.

The HDAP Trigger capture process logs to sync_engine.log on the RadiantOne node where the sync engine processor that is assigned for the pipeline is running. If RadiantOne is deployed in a cluster, a sync engine processor can be running on one or more nodes and the pipeline processing is distributed across them. Use the Global Sync tab to download the corresponding sync_engine.log file by selecting the topology and selecting Configure next to the pipeline. Select the Apply component and in the Log Viewer section, select the Download button. HDAP trigger events are logged with the keyword "pipe-sync" followed by the pipeline id. Make sure the
VDS – Sync Engine log file level is set to DEBUG. You can check the log level from the Main Control Panel > Settings tab > Logs > Log Settings. Select VDS - Sync Engine from the drop-down list and make sure Log Level is set to DEBUG.

Suspend synchronization components

Once a pipeline is configured, all synchronization components start automatically. For complete details on starting the synchronization components, please see the RadiantOne Deployment and Tuning Guide.

Monitor the synchronization process

The number of entries processed and the number of entries queued by the Transformation component can be viewed from the Main Control Panel > Global Sync tab. Select the topology on the left. The pipelines displayed on the right indicate the number of entries processed by the transformation and apply connectors.

For complete details on monitoring Global Sync components, please see the RadiantOne Monitoring and Reporting Guide.

Alerts

Default alerts are configured for all pipelines. The alerts are related to:

• The capture connector state.

• The pipeline state.

• The processor queue size.

Default alerts can be enabled on the Global Sync tab > selected topology. Select Configure next to the pipeline. In the options on the left, select Alerts.

Capture connector

When this alert is enabled, every time the capture connector state changes (e.g. a connector state changes from RUNNING to STOPPED or vice versa), a file alert is triggered in: alerts.log. You can view and download alerts.log from Main Control Panel > Settings > Configuration > File Manager.

Pipeline state

When this alert is enabled, every time the pipeline state changes (e.g. a pipeline state changes to/from RUNNING, SUSPENDED, UPLOADING, ERROR, DEPLOYING, WAITING_FOR_AGENT), a file alert is triggered in: alerts.log. You can view and download alerts.log from Main Control Panel > Settings > Configuration > File Manager.

Processor queue

When this alert is enabled, indicate a queue size threshold. The threshold size is the maximum number of entries in the queue awaiting processing. Once this number is reached, a file alert is triggered in alerts.log. This indicates that messages are accumulating in the queue, and an administrator should check the apply process to see if there are issues causing the changes to not get processed and applied fast enough. You can view and download alerts.log from Main Control Panel > Settings > Configuration > File Manager.

Replay failed messages

Messages that fail to get successfully applied to a destination, are categorized due to either a connection error to the destination, or any other non-communication related error (e.g. object class violation).

Failure due to communication error

When a change cannot be applied to a destination, and the error is due to a communication failure, the message is put back in the pipeline queue and replayed indefinitely.

Failure due to non-communication error

When a change cannot be applied to a destination, and the error is not due to a communication failure, the message is replayed for a configurable number of attempts. This is 5 attempts by default and is configurable in ZooKeeper at: /radiantone/{VERSION}/<clustername>/config/vds_server.conf, the refreshEngineEventErrorRetriesMax property.

After the number of retries is exhausted, the message is written into the queue associated with the pipeline below cn=dlqueue.

Replay messages in the dead letter queue

To replay failed messages from the dead letter queue, use the Main Control Panel > Global Sync tab. Select the topology and select Configure next to the pipeline. Select the Queue section on the left and locate the Failed Messages section. Select the Resend button next to the failed message that you want to be resent.

This section describes the process of migrating a global sync topology from a source environment to a target environment using the resource-traverse, resource-export and resource-import commands.

Exporting the Topology

This section describes exporting a topology from the source environment.

1. Run the resource-traverse command as shown in the following example. The value for the -name command argument is the topology's destination naming context.

   https://<<rli_server_name>>:8090/adap/util?action=vdsconfig&commandname=resource-traverse&name=<>

   i.e.

   https://localhost:8090/adap/util?action=vdsconfig&commandname=resource-traverse&name=dc=adtohdap

2. Run the resource-export command as shown in the following example. The value for the -name command argument is the topology's destination naming context. The value for the -path command argument is the file path where the zip file is created.

   https://<<rli_server_name>>:8090/adap/util?action=vdsconfig&commandname=resource-export&name=&path=<>

   i.e.

   https://localhost:8090/adap/util?action=vdsconfig&commandname=resource-export&name=dc=adtohdap&path=c:/temp

3. In the Main Control Panel, navigate to the Global Sync tab.

4. Select the topology from the list of topologies on the left.

5. Click Configure next to the pipleline on the right.

6. Click the Transformation component.

7. Note the value in the Transformation Type drop-down menu.

   

Importing the Topology

This section describes how to import a global sync topology in the target environment.

To import the topology:

1. Run resource-import as shown in the following example. The value for the -path command argument is the full file path.

   https://localhost:8090/adap/util?action=vdsconfig&commandname=resource-import&path=<<path>>&apply

   i.e.

   https://localhost:8090/adap/util?action=vdsconfig&commandname=resource-import&path=c:/temp/dc_adtohdap.zip&apply

2. Restart RadiantOne.

   Warning

   For rules-based transformation types, import rules to the new environment at <RLI_HOME>\vds_server\conf\sync\rules.

3. Log into the Main Control Panel, and navigate to the Global Sync tab.

4. Select the topology from the list of topologies on the left.

5. Click Configure next to the pipleline on the right.

6. Reconfigure the transformation and click Save.

   Warning

   For script and script-and-mapping transformation types, click the Transformation component. From the Transformation Type drop-down menu and select Script or Script and Mapping. In the Transformation Script section, click Edit, and modify the script as required. For mappings transformation types, continue to the next step in the instructions.

7. Select the Apply component.

8. Click the Upload tab.

9. Click Start.