Cloud Foundry MySQL Service
Table of contents
|CF MySQL Broker||Advertises the MySQL service and plans. Creates and deletes MySQL databases and credentials (bindings) at the request of Cloud Foundry's Cloud Controller.|
|MySQL Server||The MySQL instances, either single or 3-node cluster. Currently using MariaDB 10 (versions vary by release).|
|Proxy||Switchboard; proxies to MySQL, severing connections on MySQL node failure.|
Traffic to the MySQL cluster is routed through one or more proxy nodes. The current proxy implementation is Switchboard. This proxy acts as an intermediary between the client and the MySQL server, providing failover between MySQL nodes. The number of nodes is configured by the proxy job instance count in the deployment manifest.
NOTE: If the number of proxy nodes is set to zero, apps will be bound to the IP address of the first MySQL node in the cluster. If that IP address should change for any reason (e.g. loss of a VM) or a proxy was subsequently added, one would need to re-bind all apps to the IP address of the new node.
For more details see the proxy documentation.
A user-facing service dashboard is provided by the service broker that displays storage utilization information for each service instance.
The dashboard is accessible by users via Single Sign-On (SSO) once authenticated with Cloud Foundry.
The dashboard URL can be found by running
cf service MY_SERVICE_INSTANCE.
Service authors interested in implementing a service dashboard accessible via SSO can follow documentation for Dashboard SSO.
SSO is initiated when a user navigates to the URL found in the
dashboard_urlfield. This value is returned to cloud controller by the broker in response to a provision request, and is exposed in the cloud controller API for the service instance. A users client must expose this field as a link, or it can be obtained via curl (
cf curl /v2/service_instances/:guid) and copied into a browser.
SSO requires the following OAuth client to be configured in cf-release. This client is responsible for creating the OAuth client for the MySQL dashboard. Without this client configured in cf-release, the MySQL dashboard will not be accessible but the service will be otherwise functional. Registering the broker will display a warning to this effect.
properties: uaa: clients: cc-service-dashboards: secret: cc-broker-secret scope: cloud_controller.write,openid,cloud_controller.read,cloud_controller_service_permissions.read authorities: clients.read,clients.write,clients.admin authorized-grant-types: client_credentials
SSO was implemented in v169 of cf-release; if you are on an older version of cf-release you'll encounter an error when you register the service broker. If upgrading cf-release is not an option, try removing the following lines from the cf-mysql-release manifest and redeploy.
dashboard_client: id: p-mysql secret: yoursecret
The following links show how this release implements Dashboard SSO integration.
- Update the broker catalog with the dashboard client properties
- Implement oauth workflow with the omniauth-uaa-oauth2 gem
- Use the cf-uaa-lib gem to get a valid access token and request permissions on the instance
- Before showing the user the dashboard, the broker checks to see if the user is logged-in and has permissions to view the usage details of the instance.
Require HTTPS when visiting Dashboard
The dashboard URL defaults to using the
https scheme. This means any requests using
http will automatically be redirected to
To override this, you can change
Keep in mind that changing the
ssl_enabled setting for an existing broker will not update previously advertised dashboard URLs.
Visiting the old URL may fail if you are using the SSO integration,
because the OAuth2 client registered with UAA will expect users to both come from and return to a URI using the scheme
implied by the
https, the broker must be reached through an SSL termination proxy.
Connecting to the broker directly on
https will result in a
port 443: Connection refused error.
Trust Self-Signed SSL Certificates
By default, the broker will not trust a self-signed SSL certificate when communicating with cf-release.
To trust self-signed SSL certificates, you can change
Downloading a Stable Release
Stable releases, also known as final releases, are available for general use. Release notes and source code are available on github. Instructions for uploading a final release to your BOSH director can be found on bosh.io.
Note: If your BOSH director's able to access the Internet, you don't need to download and upload a release to your BOSH director. When using cf-mysql-deployment, the correct release is referenced in the manifest, and will be automatically retrieved by the BOSH director.
See our contributing docs for instructions on how to make a pull request.
This BOSH release doubles as a
$GOPATH. It will automatically be set up for
you if you have direnv installed.
# fetch release repo mkdir -p ~/workspace cd ~/workspace git clone https://github.com/cloudfoundry/cf-mysql-release.git cd cf-mysql-release/ # switch to develop branch (not master!) git checkout develop # automate $GOPATH and $PATH setup direnv allow # initialize and sync submodules ./scripts/update
If you do not wish to use direnv, you can simply
.envrc file in the root
of the release repo. You may manually need to update your
as you switch in and out of the directory.
Release Notes, Known Issues, and Documentation
For more information, check out the documentation.
See https://github.com/cloudfoundry/cf-mysql-deployment to deploy cf-mysql release.