MySQL for Pivotal Platform

Note: Pivotal has renamed MySQL for Pivotal Cloud Foundry to MySQL for Pivotal Platform.

Note: Pivotal has renamed Pivotal Cloud Foundry to Pivotal Platform.

Page last updated:

This guide describes setting up and using MySQL for Pivotal Platform as an on-demand service.

About MySQL for Pivotal Platform

MySQL for Pivotal Platform enables Pivotal Platform app developers to provision and use a MySQL database with a single command.

The MySQL for Pivotal Platform product delivers dedicated instances on demand, “Database as a Service”, to Pivotal Platform users. When installed, the tile deploys and maintains a single Service Broker that is responsible for Pivotal Platform integration. The service is configured with sane defaults, following the principle of least surprise for a general-use relational database service.

MySQL for Pivotal Platform supports the following VM topologies:

  • Single node.
  • Leader-follower. For more information, see About Leader-Follower.
  • Highly available (HA) cluster. For highly available clusters, MySQL for Pivotal Platform uses a patched Galera Cluster, Percona XtraDB Cluster (PXC). For more information about PXC, see Percona XtraDB Cluster.

    Warning: Highly available plans are in general availability (GA). However, they are for advanced use cases only.

Product Snapshot

The following table provides version and version-support information about MySQL for Pivotal Platform.

Element Details
Version 2.7.0
Release date August 7, 2019
Software component version Percona Server v5.7.20-21
Compatible Pivotal Ops Manager version(s) 2.7, 2.6, 2.5, and 2.4
Compatible Pivotal Application Service version(s) 2.7, 2.6, 2.5, and 2.4
IaaS support AWS, Azure, GCP, OpenStack, and vSphere
IPsec support Yes

On-Demand Service

MySQL for Pivotal Platform uses on-demand service, which provides dedicated instances of MySQL that app developers can provision on-demand from the command line or Apps Manager. The MySQL for Pivotal Platform on-demand service gives flexibility in how and when instances are provisioned and allows for efficient and seamless resource use for both the operator and app developer. Additionally, both the operator and app developer can configure essential MySQL settings.

The MySQL for Pivotal Platform on-demand service leverages the on-demand service broker. For general information about the on-demand service broker, see On-Demand Services SDK.

On-Demand Service Plan

MySQL for Pivotal Platform offers on-demand plans as the p.mysql service in the MySQL for Pivotal Platform tile. The plans can be configured in any way that you see fit.

Operators can update certain plan settings after the plans have been created. If the operator updates the VM size or disk size these settings will be implemented in all instances already created. Operators should not decrease the disk size because this can cause data loss in existing instances.

Enterprise-Ready Checklist

Review the following table to determine if MySQL for Pivotal Platform has the features needed to support your enterprise.

Plans and InstancesMore Information
On-Demand, Dedicated-VM plansMySQL for Pivotal Platform provides On-Demand VM plans.Architecture
Customizable plansFor the On-Demand Plan, the operator can customize the VM, disk size, and availability zone.Configuring
Custom schemasMySQL for Pivotal Platform supports custom schemas. Using custom schemas allows for apps that share a MySQL service instance to isolate app data by schema.Use Custom Schemas
Share Service InstancesMySQL for Pivotal Platform supports sharing service instances between different orgs and spaces.Share Service Instances
Installation and UpgradesMore Information
Product upgradesMySQL for Pivotal Platform can be upgraded within the v2.x tile series. Upgrading MySQL for Pivotal Platform
Deployment Smoke TestsMySQL for Pivotal Platform installation and upgrade runs a post deployment BOSH errand that validates basic MySQL operations.
Maintenance and BackupsMore Information
Operational Monitoring and LoggingMySQL for Pivotal Platform provides metrics for monitoring On-Demand plan usage and quotas, as well as MySQL component metrics. Additionally, MySQL for Pivotal Platform provides syslog redirection to external log ingestors. Monitoring MySQL for Pivotal Platform
Backup and RestoreMySQL for Pivotal Platform includes automatic backups on a configurable schedule to a variety of destinations, as well as a simple restore process. Manual Backup and Restore of MySQL for Pivotal Platform
Scale and AvailabilityMore Information
On-Demand PlanMySQL for Pivotal Platform provides up to 200 on-demand instances across all plans
Ability to Scale Up / DownOperators can scale VMs up, but not downConfiguring
Rolling DeploymentsMySQL for Pivotal Platform supports rolling deployments when using HA clusters; the service is unavailable during upgrades. Upgrades
AZ SupportMySQL for Pivotal Platform can be deployed to multiple zones to increase availability during unplanned outages of a zone. About Multiple AZs in MySQL for Pivotal Platform
EncryptionMore Information
Transport Layer Security (TLS) MySQL for Pivotal Platform supports TLS. Enabling TLS provisions a MySQL server with a certificate so that apps and clients can establish an encrypted connection with the data service. Preparing for TLS
Encrypted Communication in Transit MySQL for Pivotal Platform has been tested successfully with the BOSH IPsec Add-on. Securing Data in Transit with the IPsec Add-on
Encrypted Data at RestMySQL for Pivotal Platform enables integration with commercial vendors for full-disk encryption at rest.Thales Vormetric plugin

About Multiple AZs in MySQL for Pivotal Platform

MySQL for Pivotal Platform supports configuring multiple AZs. However, assigning multiple AZs to MySQL jobs does not guarantee high availability.

  • You can assign on-demand plans to any of the configured availability zones.
  • You can select two AZs for the multi-node plans to increase the availability. Choosing three AZs for multi-node plans does not increase the number of AZs assigned to three.
  • You can select one AZ for the single-node plan. Choosing two AZs for the single-node plan does not increase the number of AZs assigned to two.


Please provide any bugs, feature requests, or questions to the Pivotal Platform Feedback list.