Getting Started

Getting started with Percona XtraDB Cluster

Getting started with a test instance of the DC/OS Percona XtraDB Cluster service is straightforward.


  • Depending on your security mode in Enterprise DC/OS, you may need to provision a service account before installing. Only someone with superuser permission can create the service account.
    • strict security mode requires a service account
    • permissive security mode does not require a service account (optional)
    • disabled security mode does not require a service account
  • Your cluster must have at least 3 private nodes.

Install a basic cluster

From the CLI

To start a basic test cluster , run the following command on the DC/OS CLI.

dcos package install percona-pxc-mysql

This command creates a new instance with the default name percona-pxc-mysql. Two instances cannot share the same name, so installing additional instances beyond the default instance requires customizing the name at install time for each additional instance.

All dcos percona-pxc-mysql CLI commands have a --name argument allowing you to specify which instance to query. If you do not specify a service name, the CLI assumes a default value matching the package name, percona-pxc-mysql. The default value for --name can be customized via the DC/OS CLI configuration:

dcos percona-pxc-mysql --name=percona-pxc-mysql <cmd>

From the web interface

Alternatively, you can install from the DC/OS web interface. If you install Percona XtraDB Cluster from the DC/OS web interface, the dcos percona-pxc-mysql CLI commands are not automatically installed to your workstation. They may be manually installed using the DC/OS CLI:

dcos package install percona-pxc-mysql --cli

After running the package install command, the service will begin installing.

Enterprise DC/OS installation

Depending on the security mode of the Enterprise DC/OS cluster, Enterprise DC/OS users may need to create a custom .json file and use it to install Percona XtraDB Cluster.

Create a Configuration File

Create a custom configuration file that will be used to install Percona XtraDB Cluster, and save it as config.json. Specify the service account (<service_account_id>) and a secret path (percona-pxc-mysql/<secret-name>) .

  "service": {
    "service_account": "<service_account_id>",
    "service_account_secret": "percona-pxc-mysql/<secret-name>"

Installing with a custom config file

Use the custom configuration file you just created to install Percona XtraDB Cluster with this command:

dcos package install --options=config.json percona-pxc-mysql

Service Deployment

To monitor the deployment of your test instance, install the package cli (see command above) and run the command:

dcos percona-pxc-mysql plan show deploy

Once the deploy plan has a status of Complete, the service is fully deployed.

Service Discovery

To connect a client, query the service for its endpoints.

dcos percona-pxc-mysql endpoints

Select an endpoint from the list to see the available connections.

dcos percona-pxc-mysql endpoints <endpoint>

Working with the Service

Using the endpoint information, you can connect a client to the service from within the DC/OS cluster (for example, a Marathon app running a client application). See the other sections of the documentation for more details on configuration, operation, and service capabilities.