Skip to main content
ServiceDatastore
Availability2024.1

Before You Begin

Version and plugin checks

Upload the Plugin to Elasticsearch Cloud

Add plugin as extension

Enable the Extension

Activate in deployment settings

Production Checklist

Final checks before launch

​
Overview

A managed Elasticsearch service can be used as the datastore for GermainUX. This option provides Elasticsearch’s scalability and analytics capabilities without requiring your organization to install and operate the underlying cluster infrastructure. The managed-service provider typically handles:
  • Elasticsearch infrastructure
  • Node provisioning
  • Platform maintenance
  • Cluster upgrades
  • Hardware replacement
  • Availability options
  • Integrated monitoring
  • Snapshot capabilities
Your organization remains responsible for sizing, access control, network connectivity, retention, GermainUX configuration, and validation.

​
Before You Begin

Confirm the following with Germain Software:
  • The Elasticsearch version supported by your GermainUX release
  • The compatible GermainUX Elasticsearch plugin
  • Required index templates and lifecycle policies
  • Expected ingestion and storage volume
  • Raw and aggregated data-retention periods
  • Session Replay volume
  • Required node size and topology
  • Network and security requirements
  • Whether existing data must be migrated
The GermainUX plugin version must be compatible with the Elasticsearch version used by the managed deployment. Do not install a plugin from another release without confirming compatibility.

​
Requirements

You need:
  • An Elasticsearch Cloud account
  • Permission to create or manage a deployment
  • Permission to upload and enable custom extensions
  • A supported Elasticsearch deployment
  • The compatible GermainUX Elasticsearch plugin
  • Network connectivity from GermainUX Enterprise
  • Elasticsearch credentials or an approved authentication method
  • Sufficient capacity for ingestion, queries, retention, replicas, and snapshots

​
Obtain the GermainUX Plugin

Contact Germain Software to obtain the latest plugin compatible with both:
  • Your GermainUX release
  • Your Elasticsearch deployment version
The package is provided as a ZIP file similar to:
Do not extract or modify the archive before uploading it unless instructed by Germain Software.

​
Upload the Plugin to Elasticsearch Cloud

  1. Sign in to the Elasticsearch Service Console.
    Elasticsearch On Cloud: Upload the Plugin to Elasticsearch Cloud
  2. Open the required hosted deployment.
  3. Go to the deployment-management area.
  4. Open Extensions.
  5. Select Add extension.
    Elasticsearch On Cloud: Upload the Plugin to Elasticsearch Cloud, image 2
  6. Enter a descriptive name for the GermainUX extension.
  7. Select the Elasticsearch version that exactly matches the plugin.
  8. For the extension type, select:
  1. Upload the GermainUX plugin ZIP file.
  2. Create the extension.
    Elasticsearch On Cloud: Upload the Plugin to Elasticsearch Cloud, image 3
The exact interface labels may vary as Elasticsearch Cloud evolves.

​
Enable the Extension

After creating the extension:
  1. Open the target Elasticsearch deployment.
    Elasticsearch On Cloud: Enable the Extension
  2. Select Edit deployment from the deployment actions.
    Elasticsearch On Cloud: Enable the Extension, image 2
  3. Open Manage user settings and extensions.
    Elasticsearch On Cloud: Enable the Extension, image 3
  4. Select the Extensions tab.
    Elasticsearch On Cloud: Enable the Extension, image 4
  5. Select the GermainUX Elasticsearch extension.
  6. Return to the deployment editor.
  7. Review the proposed changes.
  8. Save the deployment.
Elasticsearch Cloud updates the deployment and replaces or restarts nodes as necessary so the plugin is installed across the cluster. Do not interrupt the update. Monitor deployment health until the operation completes.

​
Configure Security

Before connecting GermainUX Enterprise:
  • Enable TLS.
  • Create a dedicated GermainUX service account.
  • Apply least-privilege permissions.
  • Restrict network access.
  • Store credentials securely.
  • Enable audit logging when required.
  • Protect Elasticsearch and Kibana from public access.
  • Define credential-rotation procedures.
Do not use a personal administrator account as the permanent GermainUX connection account.

​
Configure Network Connectivity

GermainUX Enterprise must be able to reach the Elasticsearch Cloud endpoint over HTTPS. Confirm:
  • Outbound HTTPS access
  • DNS resolution
  • Proxy configuration when required
  • TLS certificate validation
  • IP allowlists or traffic filters
  • Private connectivity when required
  • Firewall and security-group rules
Restrict access to approved GermainUX Enterprise hosts and administrator networks.

​
Configure GermainUX Enterprise

Update the GermainUX datastore configuration with:
  • Elasticsearch Cloud endpoint
  • Authentication credentials
  • TLS settings
  • Environment-specific index prefix
  • Connection and request timeouts
  • Retention settings
  • Any plugin-specific properties supplied by Germain Software
Use a distinct index prefix for each GermainUX environment sharing the deployment, such as development, QA, staging, and production.

​
Initialize GermainUX Data Structures

Use the templates, scripts, or REST endpoint supplied with the matching GermainUX release to create:
  • Index templates
  • Mappings
  • Data streams
  • Aliases
  • Lifecycle policies
  • Aggregated-data structures
  • Required GermainUX metadata
Do not reuse initialization files from another GermainUX version unless compatibility has been confirmed.

​
Validate the Deployment

After configuration:
1

Confirm that the Elasticsearch deployment is healthy

2

Verify that the GermainUX extension is enabled

3

Restart GermainUX Enterprise if required

4

Confirm successful authentication

5

Confirm that GermainUX can create or access the required indexes

6

Start a limited monitoring workload

7

Verify that raw facts are indexed

8

Confirm that dashboards and searches return data

9

Confirm that aggregated data is generated

10

Test representative analytical queries

11

Verify retention and lifecycle transitions

12

Review logs for indexing failures or rejected requests

​
Capacity and Performance

Size the managed deployment based on:
  • Average and peak daily AA Unit volume
  • Session Replay
  • Technical traces
  • Retention
  • Query concurrency
  • Dashboard complexity
  • Replication
  • Snapshots
  • Expected growth
Monitor:
  • JVM heap
  • CPU
  • Disk utilization
  • Disk latency
  • Ingestion rate
  • Indexing latency
  • Search latency
  • Rejected requests
  • Cluster health
  • Node availability
Increase capacity before resource saturation affects ingestion or analysis.

​
Upgrades

Before upgrading Elasticsearch Cloud:
1

Confirm that the target Elasticsearch version is supported by GermainUX

2

Obtain the matching GermainUX plugin

3

Review compatibility and migration requirements

4

Take or verify a current snapshot

5

Test the upgrade in a non-production environment

6

Upload the new plugin extension

7

Update the deployment

8

Validate ingestion, queries, dashboards, retention, and aggregation

9

Upgrade production only after successful testing

Do not upgrade Elasticsearch independently when the required compatible GermainUX plugin is unavailable.

​
Production Checklist

  • The Elasticsearch version is supported by GermainUX.
  • The matching GermainUX plugin has been installed.
  • The cluster is healthy.
  • TLS and authentication are enabled.
  • A dedicated GermainUX service account is configured.
  • Network access is restricted.
  • Index templates and mappings are installed.
  • The correct environment prefix is configured.
  • Raw and aggregated data are being stored.
  • Retention policies are operating correctly.
  • Snapshots are configured.
  • A restore has been tested.
  • Capacity monitoring and alerts are configured.
  • Upgrade procedures have been documented.
For the current plugin, supported Elasticsearch version, or deployment assistance, contact Germain Software

​
Get Help

Contact GermainUX Support

The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

Can't find what you need?

Search all GermainUX docs with Ctrl + K, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.