xStore Clusters

xStore Clusters

Overview

What is an xStore Cluster?

An xStore Cluster is the unified data catalog for your xDP platform. It provides a single place to register, browse, and govern all your data sources

xStore runs entirely inside your own Kubernetes infrastructure. Acceldata manages the cluster's lifecycle and configuration through the xDP platform, but your catalog metadata never leaves your network.

Accessing xStore Clusters

Navigate to xStore Clusters from the left sidebar by expanding xDP → Infrastructure → xStore Clusters.

The Clusters page lists all deployed xStore clusters and shows their health status. When no clusters exist yet, a prompt guides you to create your first one.

Key Concepts

• xCentral Prerequisite: xCentral must be deployed and running before you create an xStore cluster.
• PostgreSQL (Internal or External): xStore requires a PostgreSQL database to persist all catalog, schema, and table metadata. You choose between an internal (auto-deployed) or external (existing) PostgreSQL instance during setup. For production, external PostgreSQL with regular backups is strongly recommended.
• Object Storage: xStore requires an S3-compatible object store (or AWS S3).
• Network Configuration: An optional step that lets you define proxy settings and custom host aliases for xStore. Bulk-edit support lets you paste multiple entries at once.
• Form and YAML Editing: Before installing, review and tune the cluster configuration in either a structured form editor or a raw YAML editor for full control.

Get Started

This tutorial walks you through deploying your first xStore cluster.

Prerequisites

Before you begin, ensure you have:

• A running XCentral instance. XCentral must exist before you create an xStore cluster.
• Running Kubernetes cluster.
• Administrative permissions on the xDP platform.

Creating Your First xStore Cluster

Step 1 — Prerequisites

1. Navigate to xDP → Infrastructure → xStore Clusters in the left sidebar.
2. Click Add New Cluster (or Create Cluster if no clusters exist yet).
3. The 8-step creation wizard opens on the Prerequisites screen. Review the checklist: Kubernetes v1.19+, cluster-admin access, kubectl configured.

1. Click Next.

Step 2 — Configure PostgreSQL

1. Choose your PostgreSQL deployment option:

• Internal PostgreSQL (Recommended for quick setup): Deploys PostgreSQL automatically as part of the installation. A dedicated PostgreSQL instance will be created for xStore with persistent storage. No additional configuration is required.

• External PostgreSQL (Recommended for production): Connects to your existing PostgreSQL instance. Provide the JDBC Database URL (jdbc:postgresql://<host>:5432/xstore), Username, and Password.

2. Click Continue, then Next.

Step 3 — Configure s3 Compatible Object Store

1. Choose your S3 deployment option:

• Internal s3 compatible object store: Deployed automatically alongside xStore. Suitable for development and testing.

• External compatible object store: Connect to S3-compatible object store. Provide the Endpoint URL, Access Key, Secret Key, and optionally Bucket Name and Region.

2. Click Next.

Step 4 — xStore Cluster Details

1. Fill in the basic cluster identity and connectivity settings:

• xStore Name: A unique name for this cluster (e.g., demo-xstore). This becomes the Kubernetes namespace prefix.

• Namespace: The Kubernetes namespace where services will be deployed (auto-populated; can be customized).

• Version: The xStore release version to deploy. Select from the available versions in the dropdown.

• Description (Optional): A description to help identify this cluster's purpose.

• XCentral Connection: Configures how this xStore cluster connects to XCentral for governance:

  • Internal — XCentral is on the same Kubernetes cluster; uses internal service DNS.
  • External — XCentral is on a different cluster; uses external URL endpoint.

• Registry Settings / Endpoint Configuration (optional): Expand to configure a private container registry or custom endpoint.

2. Click Create XStore Cluster.

Step 5 — Network Settings (Optional)

1. Configure proxy or host alias settings if your Kubernetes cluster requires them:

• Enable HTTP Proxy: Toggle on to configure an outbound proxy for xStore pods.

• Host Aliases: Add custom /etc/hosts entries for pods (useful for on-premise services not in DNS). Each entry maps an IP address to one or more hostnames.

  • Click + Add Host Alias to add entries individually.
  • Click Bulk Edit to paste multiple host aliases at once in IP HOSTNAME format.

The Bulk Edit dialog accepts entries in IP_ADDRESS HOSTNAME(S) format (one per line):

2. Click Import Aliases to apply bulk entries, then Next.

Step 6 — YAML Configuration

1. The configuration editor loads with all available settings for the xStore cluster. Two editing modes are available:

• YAML mode: A full-control raw editor. A banner reminds you that YAML mode requires familiarity with YAML syntax.

• Form mode: A structured form editor — boolean values display as toggles, arrays can be added or removed. Use the search bar to find specific configuration keys.

2. Toggle between YAML and Form using the buttons in the top-right. Review PostgreSQL and object storage settings, xCentral connection URL, and resource limits. Click Validate Configuration to check for errors, then Save Configuration.

Step 7 — Install xStore Cluster

1. The Install xStore Cluster screen displays the commands to deploy xStore on your Kubernetes cluster. Copy and run both commands shown on screen — the first downloads the install manifest from xDP, and the second applies it to your cluster.

Step 7: Install XStore Cluster

2. Once both commands complete, click Next.

Step 8 — Setup Complete

1. The x Store Registration screen polls for cluster health. The Installation Status shows Waiting to register xStore while it checks — this typically takes a few minutes. A Registration in Progress banner confirms the process is running.
2. Once the xStore cluster is healthy and registered, click Finish Setup. You are returned to the xStore Clusters list where the new cluster appears with a RUNNING status.

How-to Guides

How to Edit an xStore Cluster's Configuration

Use this guide to update settings such as PostgreSQL credentials, s3 compatible object store endpoints, resource limits, or network configuration.

1. Navigate to xStore Clusters.
2. Find the cluster and click the Edit (pencil) icon.
3. In the wizard, navigate to the YAML Configuration step.
4. Make your changes using Form or YAML mode.
5. Click Save Configuration.
6. Navigate to the Install step.
7. Copy and run the updated install commands shown on screen. The cluster updates automatically.
8. Monitor progress in the xDP UI — the cluster status returns to RUNNING once the update is complete.

How to View xStore Cluster Details

1. Navigate to xStore Clusters.
2. Click the cluster name or click the View icon.
3. The detail view shows:

• Status (RUNNING, UNHEALTHY, PENDING, STOPPED)
• Version deployed
• Linked xCentral instance
• Linked Compute Clusters that use this xStore for catalog sync
• Configuration summary (PostgreSQL host, s3 compatible object store endpoint)

How to Delete an xStore Cluster

1. Navigate to xStore Clusters.
2. Click the Delete (trash) icon on the cluster card.
3. A confirmation dialog appears. Confirm deletion.

Warning: Deleting an xStore cluster removes it from the xDP platform. The underlying cluster resources are not automatically removed — contact your cluster administrator to clean up the cluster namespace after deletion.

How to Link a Compute Cluster to this xStore

1. Navigate to xStore Clusters and open the cluster detail view.
2. Click Linked Compute Clusters.
3. Click Add Link, select a Compute Cluster from the list, and confirm.
4. The compute cluster will be able to receive catalog syncs from this xStore.

Reference

xStore Cluster Statuses

Status	Meaning
RUNNING	All services healthy and registered with Control Plane
PENDING	Services starting up or awaiting registration
UNHEALTHY	One or more services reporting errors
STOPPED	xStore has been paused or unregistered
UNKNOWN	Health check data not yet received

Best Practices

• Dedicated PostgreSQL Instance: Use a dedicated PostgreSQL instance (not shared with other services) for xStore metadata. This simplifies backup, sizing, and recovery.
• Use Bulk Edit for Host Aliases: If you have many on-premise hosts to resolve, use the Bulk Edit dialog in Network Settings to paste all IP HOSTNAME pairs at once rather than adding them one by one.
• Verify External Services Are Reachable: Before starting the wizard, confirm that your PostgreSQL database and object storage endpoint are accessible from the environment where xStore will be deployed.