10.7.2 Elasticsearch
- About an Elasticsearch Connection
- Before You Begin
- Create and Validate an Elasticsearch Connection
- Use an Elasticsearch Connection in Replicat
Parent topic: Cache and Search
10.7.2.1 About an Elasticsearch Connection
An Elasticsearch connection stores the information that Oracle GoldenGate uses to connect to an Elasticsearch cluster. After the connection is created and validated, you can reuse it when configuring Replicat processes that deliver transactional data to Elasticsearch.
The connection stores the cluster endpoint, authentication, security, and optional runtime settings independently of the Replicat configuration. This enables multiple Replicat processes to reuse the same validated connection.
Parent topic: Elasticsearch
10.7.2.2 Before You Begin
Before creating an Elasticsearch connection, ensure that you have the following:
- An Oracle GoldenGate deployment.
- Network connectivity between the Oracle GoldenGate deployment and the Elasticsearch cluster.
- One or more Elasticsearch server addresses.
- Authentication credentials if the cluster requires Basic authentication.
- The TLS certificate fingerprint if the deployment uses TLS.
- Common runtime settings, such as the runtime classpath, if additional client libraries are required.
- Proxy information if the Oracle GoldenGate deployment accesses Elasticsearch through an HTTP proxy.
Parent topic: Elasticsearch
10.7.2.3 Create and Validate an Elasticsearch Connection
Use the Add Connection page to create an Elasticsearch connection.
Procedure
- In the navigation menu, select DB Connections.
- Click Add Connection.
- In Connection Alias, enter a unique name for the connection.
- From Technology Type, select Elasticsearch.
- In the Technology Settings section, provide the Elasticsearch connection
information.
Configure the following technology settings:
- Servers – Specifies a comma-separated list of
Elasticsearch server addresses. Each entry can be specified as
host:port. If the port is omitted, Oracle GoldenGate for Distributed Applications and Analytics uses the default port9200. This property is used to establish the initial connection to the Elasticsearch cluster. - Authentication Type – Specifies the authentication mechanism. Supported values are NONE and BASIC.
- Servers – Specifies a comma-separated list of
Elasticsearch server addresses. Each entry can be specified as
- Configure the Authentication Settings section when
Authentication Type is BASIC.
Configure the following authentication settings:
- Security Protocol – Specifies the communication protocol. Supported values are PLAIN and TLS.
- Username – Specifies the Elasticsearch user name. This field is required when Security Protocol is PLAIN or TLS.
- Password – Specifies the password associated with the Elasticsearch user name. This field is required when Security Protocol is PLAIN or TLS. This field is treated as sensitive information and is displayed as a password field.
- TLS Fingerprint – Specifies the SHA-256 certificate fingerprint used to validate the Elasticsearch server certificate. This field is required when Security Protocol is TLS.
Note:
Authentication settings are available only when Authentication Type is BASIC. Configure the TLS Fingerprint only when Security Protocol is TLS. - Configure Common Settings, if additional runtime configuration
is required.
Configure the following common settings:
Classpath – Specifies the runtime classpath used to load the required Elasticsearch client libraries. You can use Dependency Downloader to download client libraries.Note:
- Download the supported Elasticsearch client libraries by using the Dependency Downloader for Elasticsearch.
- Configure the runtime classpath to reference the downloaded client libraries before starting the Replicat process.
- (Optional) Configure Proxy Settings if the Oracle GoldenGate for
Distributed Applications and Analytics deployment accesses the Elasticsearch cluster
through an HTTP proxy.
Configure the following proxy settings:
- Proxy URL – Specifies the URL or host name of the proxy server used to access the Elasticsearch cluster.
- Proxy Port – Specifies the port number of the proxy server.
- Proxy Username – Specifies the user name for proxy authentication, if required.
- Proxy Password – Specifies the password for proxy authentication. This field is treated as sensitive information.
- Truststore – Specifies the Java truststore file that contains the certificate authority (CA) certificates used to validate the proxy server certificate, when required.
- Truststore Password – Specifies the password associated with the truststore.
- Keystore – Specifies the Java keystore file containing the client certificate and private key used for client authentication, when required.
- Keystore Password – Specifies the password associated with the keystore.
- SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password.
Note:
Configure the proxy and SSL settings only if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Elasticsearch cluster through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to the Elasticsearch cluster, leave the Proxy Settings blank. - Click Submit.
- On the DB Connections page, click DBLOGIN to validate the
connection.
Note:
A successful DBLOGIN validates only the saved connection information. It does not validate the Replicat configuration or Elasticsearch Handler configuration. After successful validation, the connection is available for selection during Replicat creation.
Parent topic: Elasticsearch
10.7.2.4 Use an Elasticsearch Connection in Replicat
After the Elasticsearch connection has been successfully validated:
- Create or edit a Replicat.
- Select Elasticsearch as the target technology.
- Select the validated Elasticsearch connection.
- Complete the remaining Replicat configuration.
- Create and start the Replicat.
Related Topics
Parent topic: Elasticsearch