Set Up Helyx Replication Services
Setting up Helyx replication services is a simple and efficient process. To initiate replication services, execute the configuration service executables as described below :
Helyx Vault
Introduction to Helyx Vault
Helyx Vault is a secure tool used to store and protect sensitive information such as passwords, API keys, database tokens, and digital certificates. It prevents sensitive data from being exposed in source code, configuration files, or other unsecured locations by storing it in a centralized and encrypted vault.
Helyx Vault is specifically used to securely manage the passwords associated with Helyx data pipelines for the replication user. During replication, Helyx retrieves the required credentials directly from the Vault, ensuring that sensitive password information remains protected and is not exposed in the application configuration.
Users can change or reset the replication passwords whenever required. Passwords are not stored directly in the Helyx configuration. Instead, the Helyx replication processes retrieve the required encrypted credentials securely from the Vault when needed.
Vault Commands
Use the following commands to start, check the status of, unlock, or reset Helyx Vault.
Start the Vault
<Path-to-configservice.exe> -start vault -source <source_db_helyx_password> -destination <destination_db_helyx_password>Check Vault Status
<Path-to-configservice.exe> -status vaultUnlock the Vault
When the Docker container for Helyx Vault is restarted, the vault is automatically locked for security reasons. This helps protect sensitive information and prevents unauthorized access after a restart. To continue using Helyx Vault, users must unlock the vault manually by running the command provided below:
<Path-to-configservice.exe> -unlock vaultReset Vault Passwords
As part of the database password rotation policy, users and administrators are required to periodically update the Helyx database password in both the source Oracle database and the destination Oracle database.
To reset or update the vault database password, use the command provided below:
<Path-to-configservice.exe> -reset vault -source <source_db_helyx_password> -destination <destination_db_helyx_password>1. Starting helyx-sync-manager
Execute the following command to start the sync manager :
<Path-to-configservice.exe> -start helyx-sync-manager -datapath <path-to-sync-manager-data-dir>The datapath specifies the directory location on your virtual machine (VM) or physical server.
Ensure this directory is created prior to running the above command :
mkdir -p <your datapath location>Create directory named config at /var/lib/helyx location. This path is related to configpath parameter.
mkdir -p /var/lib/helyx/config2. Starting helyx-broker-manager
To launch the broker manager, use the command :
<Path-to-configservice.exe> -start helyx-broker-manager -datapath <path-to-broker-manager-data-dir> -host-ip <your host ip>Ensure the datapath directory exists on your VM or physical server before executing the above command. helyx-broker-manager datapath must be different from helyx-sync-manager.
It is crucial to assign a unique datapath directory for each service to prevent conflicts and ensure data integrity. Sharing the same storage location between these two managers is not recommended, as it increases the risk of data loss or system errors due to overlapping operations.
3. Starting helyx-schema-registry-manager
Start the schema registry manager with the command :
<Path-to-configservice.exe> -start helyx-schema-registry-manager4. Starting helyx-connect-service-manager
Start the connect service manager with the command :
<Path-to-configservice.exe> -start helyx-connect-service-manager5. To get all commands type HELP
<Path-to-configservice.exe> -help6. To get status of services
<Path-to-configservice.exe> -status <service-name><Path-to-configservice.exe> -status helyx-connect-service-manager7. To restart service
<Path-to-configservice.exe> -restart <service-name>8. To stop service
<Path-to-configservice.exe> -stop <service-name>