devcamcar / cf-mysql-release

Cloud Foundry MySQL Release

Cloud Foundry MySQL Service

A BOSH release of a MySQL database-as-a-service for Cloud Foundry using MariaDB Galera Cluster and a v2 Service Broker.

Component	Description	Build Status
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	MariaDB 10.0.13; database instances are hosted on the servers.	n/a
Proxy	HA Proxy; proxies to MySQL nodes for failover only	n/a

Getting the code

Final releases are designed for public use, and are tagged with a version number of the form "v".

The develop branch is where we do active development. Although we endeavor to keep the develop branch stable, we do not guarantee that any given commit will deploy cleanly.

The release-candidate branch has passed all of our unit, integration, smoke, & acceptance tests, but has not been used in a final release yet. This branch should be fairly stable.

The master branch points to the most recent stable final release.

At semi-regular intervals a final release is created from the release-candidate branch. This final release is tagged and pushed to the master branch.

Pushing to any branch other than develop will create problems for the CI pipeline, which relies on fast forward merges. To recover from this condition follow the instructions here.

Release Notes & Known Issues

For release notes and known issues, see the release wiki.

Deployment

Prerequisites

• A deployment of BOSH
• A deployment of Cloud Foundry, final release 169 or greater
• Instructions for installing BOSH and Cloud Foundry can be found at http://docs.cloudfoundry.org/.

Overview

1. Upload Stemcell
2. Upload Release
3. Create Manifest and Deploy
4. Register the Service Broker

After installation, the MySQL service will be visible in the Services Marketplace; using the CLI, run cf marketplace.

Upload Stemcell

The latest final release expects the Ubuntu Trusty (14.04) go_agent stemcell version 2719.3 by default. Note: there are important security fixes in this version of the stemcell; we recommend updating if your are using an older stemcell. This release may not work with newer stemcells as it may have dependencies on libraries which have been removed from newer stemcells. Stemcells can be downloaded from http://boshartifacts.cfapps.io/file_collections?type=stemcells; choose the ubuntu trusty go_agent stemcell 2719.3 for your infrastructure (vsphere esxi or aws xen).

Upload Release

You can use a pre-built final release or build a dev release from any of the branches described in Getting the Code.

Final releases are stable releases created periodically for completed features. They also contain pre-compiled packages, which makes deployment much faster. To deploy the latest final release, simply check out the master branch. This will contain the latest final release and accompanying materials to generate a manifest. If you would like to deploy an earlier final release, use git checkout <tag> to obtain both the release and corresponding manifest generation materials. It's important that the manifest generation materials are consistent with the release.

If you'd like to deploy the latest code, build a release yourself from the develop branch.

Upload a pre-built final BOSH release

Run the upload command, referencing the latest config file in the releases directory.

$ cd ~/workspace/cf-mysql-release
$ git checkout master
$ ./update
$ bosh upload release releases/cf-mysql-<N>.yml

If deploying an older final release than the latest, check out the tag for the desired version; this is necessary for generating a manifest that matches the code you're deploying.

$ cd ~/workspace/cf-mysql-release
$ git checkout v<N>
$ ./update
$ bosh upload release releases/cf-mysql-<N>.yml

Create and upload a BOSH Release:

1. Checkout one of the branches described in Getting the Code. Build a BOSH development release.

$ cd ~/workspace/cf-mysql-release
$ git checkout release-candidate
$ ./update
$ bosh create release

When prompted to name the release, call it cf-mysql.

1. Upload the release to your bosh environment:

$ bosh upload release

Create Manifest and Deploy

BOSH-lite

1. Generate the manifest using a bosh-lite specific script and a stub provided for you, bosh-lite/cf-mysql-stub-spiff.yml.

   $ ./bosh-lite/make_manifest_spiff_mysql
   

   The resulting file, bosh-lite/manifests/cf-mysql-manifest.yml is your deployment manifest. To modify the deployment configuration, you can edit the stub and regenerate the manifest or edit the manifest directly.

2. The make_manifest_spiff_mysql script will set the deployment to bosh-lite/manifests/cf-mysql-manifest.yml for you, so to deploy you only need to run:

$ bosh deploy

vSphere

1. Create a stub file called cf-mysql-vsphere-stub.yml by copying and modifying the sample_vsphere_stub.yml in templates/sample_stubs.

2. Generate the manifest:

$ ./generate_deployment_manifest vsphere cf-mysql-vsphere-stub.yml > cf-mysql-vsphere.yml

The resulting file, cf-mysql-vsphere.yml is your deployment manifest. To modify the deployment configuration, you can edit the stub and regenerate the manifest or edit the manifest directly.

3. To deploy:

$ bosh deployment cf-mysql-vsphere.yml && bosh deploy

AWS

1. Create a stub file called cf-mysql-aws-stub.yml by copying and modifying the sample_aws_stub.yml in templates/sample_stubs.

2. Generate the manifest:

$ ./generate_deployment_manifest aws cf-mysql-aws-stub.yml > cf-mysql-aws.yml

The resulting file, cf-mysql-aws.yml is your deployment manifest. To modify the deployment configuration, you can edit the stub and regenerate the manifest or edit the manifest directly.

1. To deploy:

$ bosh deployment cf-mysql-aws.yml && bosh deploy

Deployment Manifest Properties

Manifest properties are described in the spec file for each job; see jobs.

You can find your director_uuid by running bosh status.

The MariaDB cluster nodes are configured by default with 100GB of persistent disk. This can be configured in your stub or manifest using jobs.mysql.persistent_disk, however your deployment will fail if this is less than 3GB; we recommend allocating 10GB at a minimum.

Register the Service Broker

BOSH errand

BOSH errands were introduced in version 2366 of the BOSH CLI, BOSH Director, and stemcells.

$ bosh run errand broker-registrar

Note: the broker-registrar errand will fail if the broker has already been registered, and the broker name does not match the manifest property jobs.broker-registrar.properties.broker.name. Use the cf rename-service-broker CLI command to change the broker name to match the manifest property then this errand will succeed.

Manually

1. First register the broker using the cf CLI. You must be logged in as an admin.

   $ cf create-service-broker p-mysql BROKER_USERNAME BROKER_PASSWORD URL
   

   BROKER_USERNAME and BROKER_PASSWORD are the credentials Cloud Foundry will use to authenticate when making API calls to the service broker. Use the values for manifest properties jobs.cf-mysql-broker.properties.auth_username and jobs.cf-mysql-broker.properties.auth_password.

   URL specifies where the Cloud Controller will access the MySQL broker. Use the value of the manifest property jobs.cf-mysql-broker.properties.external_host.

   For more information, see Managing Service Brokers.

2. Then make the service plan public.

Acceptance Tests

To run the MySQL Release Acceptance tests, you will need:

• a running CF instance
• credentials for a CF Admin user
• a deployed MySQL Release with the broker registered and the plan made public
• an environment variable $CONFIG which points to a .json file that contains the application domain

BOSH errand

BOSH errands were introduced in version 2366 of the BOSH CLI, BOSH Director, and stemcells.

The following properties must be included in the manifest (most will be there by default):

• cf.api_url:
• cf.admin_username:
• cf.admin_password:
• cf.apps_domain:
• cf.skip_ssl_validation:
• broker.host:
• service.name:
• service.plans:

The service.plans array must include the following properties for each plan:

• plan_name:
• max_storage_mb:

To customize the following values add them to the manifest:

• mysql.max_user_connections: (default: 40)

To run the errand:

$ bosh run errand acceptance-tests

Manually

1. Install Go by following the directions found here

2. cd into cf-mysql-release/src/acceptance-tests/

3. Update cf-mysql-release/src/acceptance-tests/integration_config.json

   The following commands provide a shortcut to configuring integration_config.json with values for a bosh-lite deployment. Copy and paste this into your terminal, then open the resulting integration_config.json in an editor to replace values as appropriate for your environment.

cat > integration_config.json <<EOF
{
  "api": "http://api.10.244.0.34.xip.io",
  "apps_domain": "10.244.0.34.xip.io",
  "admin_user": "admin",
  "admin_password": "admin",
  "broker_host": "p-mysql.10.244.0.34.xip.io",
  "service_name": "p-mysql",
  "plans" : [
    {
      "plan_name": "100mb-dev",
      "max_user_connections": 20,
      "max_storage_mb": 10
    },
    {
      "plan_name": "1gb-dev",
      "max_user_connections": 40,
      "max_storage_mb": 20
    }
  ],
  "skip_ssl_validation": true,
  "timeout_scale": 1.0,
  "include_dashboard_tests": false,
  "include_failover_tests": false
}
EOF
export CONFIG=$PWD/integration_config.json

When skip_ssl_validation: true, commands run by the tests will accept self-signed certificates from Cloud Foundry. This option requires v6.0.2 or newer of the CLI.

All timeouts in the test suite can be scaled proportionally by changing the timeout_scale factor.

4. Run the tests

$ ./bin/test

Security Groups

Since cf-release v175, applications by default cannot to connect to IP addresses on the private network. This prevents applications from connecting to the MySQL service. To enable access to the service, create a new security group for the IP configured in your manifest for the property jobs.mysql_broker.mysql_node.host.

1. Add the rule to a file in the following json format; multiple rules are supported.

[
    {
      "destination": "10.244.1.18",
      "protocol": "all"
    }
]

• Create a security group from the rule file.

  $ cf create-security-group p-mysql rule.json
  

• Enable the rule for all apps

  $ cf bind-running-security-group p-mysql
  

Changes are only applied to new application containers; in order for an existing app to receive security group changes it must be restarted.

De-register the Service Broker

The following commands are destructive and are intended to be run in conjuction with deleting your BOSH deployment.

BOSH errand

BOSH errands were introduced in version 2366 of the BOSH CLI, BOSH Director, and stemcells.

This errand runs the two commands listed in the manual section below from a BOSH-deployed VM. This errand should be run before deleting your BOSH deployment. If you have already deleted your deployment follow the manual instructions below.

$ bosh run errand broker-deregistrar

Manually

Run the following:

$ cf purge-service-offering p-mysql
$ cf delete-service-broker p-mysql

Dashboard

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.

Service authors interested in implementing a service dashboard accessible via SSO can follow documentation for Dashboard SSO.

Prerequisites

1. SSO is initiated when a user navigates to the URL found in the dashboard_url field. 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.

2. 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
   

3. 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 upgradiing 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

SSL

The dashboard URL defaults to using the https scheme. To override this, you can change properties.ssl_enabled to false in the cf-mysql-broker job.

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 ssl_enabled setting.

Implementation Notes

The following links show how this release implements Dashboard SSO integration.

1. Update the broker catalog with the dashboard client properties
2. Implement oauth workflow with the omniauth-uaa-oauth2 gem
3. Use the cf-uaa-lib gem to get a valid access token and request permissions on the instance
4. 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.

HAProxy

Traffic to the MySQL cluster is routed through one or more HAProxy nodes. The intention is to use these proxies for fail-over and load balancing traffic. The number of nodes is configured by the job instance count in the deployment manifest.

Each HAProxy node runs a thin web server to display traffic stats. These dashboards can be reached at haproxy-<job index>.p-mysql.<system domain>. Log in as user admin with the password configured by the haproxy_stats_password property in the deployment manifest.