MySQL for Pivotal Cloud Foundry

Page last updated:

This guide describes setting up and using MySQL for Pivotal Cloud Foundry (PCF) as an on-demand service.

About MySQL for PCF

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

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

MySQL for PCF 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 PCF uses a patched Galera Cluster, Percona XtraDB Cluster (PXC). For more information about PXC, see Percona XtraDB Cluster.

    Warning: Highly available plans are currently in beta. HA clusters are for advanced use cases only.

Product Snapshot

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

Element Details
Version 2.5.8
Release date October 10, 2019
Software component version Percona Server v5.7.26-29
Compatible Ops Manager version(s) 2.3, 2.4, and 2.5
Compatible Pivotal Application Service (PAS) version(s) 2.3, 2.4, and 2.5
IaaS support AWS, Azure, GCP, OpenStack, and vSphere
IPsec support Yes

On-Demand Service

MySQL for PCF 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 PCF 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 PCF 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 PCF offers on-demand plans as the p.mysql service in the MySQL for PCF 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 PCF has the features needed to support your enterprise.

Plans and InstancesMore Information
On-Demand, Dedicated-VM plansMySQL for PCF 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 PCF supports custom schemas. Using custom schemas allows for apps that share a MySQL service instance to isolate app data by schema.Create and Use Custom Schemas
Share Service InstancesMySQL for PCF supports sharing service instances between different orgs and spaces.Share Service Instances
Installation and UpgradesMore Information
Product upgradesMySQL for PCF can be upgraded within the v2.x tile series. Upgrading MySQL for PCF
Deployment Smoke TestsMySQL for PCF installation and upgrade runs a post deployment BOSH errand that validates basic MySQL operations.
Maintenance and BackupsMore Information
Operational Monitoring and LoggingMySQL for PCF provides metrics for monitoring On-Demand plan usage and quotas, as well as MySQL component metrics. Additionally, MySQL for PCF provides syslog redirection to external log ingestors. Monitoring MySQL for PCF
Backup and RestoreMySQL for PCF 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 PCF
Scale and AvailabilityMore Information
On-Demand PlanMySQL for PCF 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 PCF supports rolling deployments when using HA clusters; the service is unavailable during upgrades. Upgrades
AZ SupportMySQL for PCF can be deployed to multiple zones to increase availability during unplanned outages of a zone. About Availability Zones
EncryptionMore Information
Transport Layer Security (TLS) MySQL for PCF 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 PCF has been tested successfully with the BOSH IPsec Add-on. Securing Data in Transit with the IPsec Add-on
Encrypted Data at RestMySQL for PCF enables integration with commercial vendors for full-disk encryption at rest.Thales Vormetric plugin

About Availability Zones

MySQL for PCF supports configuring multiple availability zones (AZs). However, assigning multiple AZs to MySQL jobs does not guarantee high availability.

  • You can assign on-demand plans to any of the configured AZs.
  • BOSH randomly deploys service instances across configured AZs. This minimizes the impact of an AZ outage and removes single points of failure,
  • For all MySQL for PCF plans, select three AZs. Choosing three AZs does not increase the number of AZs assigned to service instances to three.


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