{"id":31904160,"url":"https://github.com/cloudfoundry-community/pe-rds-broker","last_synced_at":"2025-10-13T13:47:48.387Z","repository":{"id":57599198,"uuid":"43937078","full_name":"cloudfoundry-community/pe-rds-broker","owner":"cloudfoundry-community","description":"AWS RDS Service Broker","archived":false,"fork":false,"pushed_at":"2017-03-08T13:42:18.000Z","size":4086,"stargazers_count":10,"open_issues_count":4,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-06-20T10:30:02.095Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudfoundry-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-09T06:29:06.000Z","updated_at":"2024-02-09T14:27:19.000Z","dependencies_parsed_at":"2022-08-28T18:33:06.652Z","dependency_job_id":null,"html_url":"https://github.com/cloudfoundry-community/pe-rds-broker","commit_stats":null,"previous_names":["cf-platform-eng/rds-broker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cloudfoundry-community/pe-rds-broker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Fpe-rds-broker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Fpe-rds-broker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Fpe-rds-broker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Fpe-rds-broker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry-community","download_url":"https://codeload.github.com/cloudfoundry-community/pe-rds-broker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Fpe-rds-broker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015339,"owners_count":26085685,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-13T13:47:41.136Z","updated_at":"2025-10-13T13:47:48.381Z","avatar_url":"https://github.com/cloudfoundry-community.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS RDS Service Broker [![Build Status](https://travis-ci.org/cloudfoundry-community/pe-rds-broker.png)](https://travis-ci.org/cloudfoundry-community/pe-rds-broker)\n\nThis is an **experimental** [Cloud Foundry Service Broker](https://docs.cloudfoundry.org/services/overview.html) for [Amazon Relational Database Service (RDS)](https://aws.amazon.com/rds/) supporting [Aurora](https://aws.amazon.com/rds/aurora/), [MariaDB](https://aws.amazon.com/rds/mariadb/), [MySQL](https://aws.amazon.com/rds/mysql/) and [PostgreSQL](https://aws.amazon.com/rds/postgresql/) RDS Databases.\n\nMore details can be found at this [Pivotal P.O.V Blog post](http://blog.pivotal.io/pivotal-cloud-foundry/products/a-look-at-cloud-foundrys-service-broker-updates).\n\n## Disclaimer\n\nThis is **NOT** presently a production ready Service Broker. This is a work in progress. It is suitable for experimentation and may not become supported in the future.\n\n## Installation\n\n### Locally\n\nUsing the standard `go install` (you must have [Go](https://golang.org/) already installed in your local machine):\n\n```\n$ go install github.com/cloudfoundry-community/pe-rds-broker\n$ rds-broker -port=3000 -config=\u003cpath-to-your-config-file\u003e\n```\n\n### Cloud Foundry\n\nThe broker can be deployed to an already existing [Cloud Foundry](https://www.cloudfoundry.org/) installation:\n\n```\n$ git clone https://github.com/cloudfoundry-community/pe-rds-broker.git\n$ cd rds-broker\n```\n\nModify the [included manifest file](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/manifest.yml) to include your AWS credentials and optionally the [sample configuration file](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/config-sample.json). Then you can push the broker to your [Cloud Foundry](https://www.cloudfoundry.org/) environment:\n\n```\n$ cp config-sample.json config.json\n$ cf push rds-broker\n```\n\n### Docker\n\nIf you want to run the AWS RDS Service Broker on a Docker container, you can use the [cfplatformeng/rds-broker](https://registry.hub.docker.com/u/cfplatformeng/rds-broker/) Docker image.\n\n```\n$ docker run -d --name rds-broker -p 3000:3000 \\\n  -e AWS_ACCESS_KEY_ID=\u003cyour-aws-access-key-id\u003e \\\n  -e AWS_SECRET_ACCESS_KEY=\u003cyour-aws-secret-access-key\u003e \\\n  cfplatformeng/rds-broker\n```\n\nThe Docker image cames with an [embedded sample configuration file](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/config-sample.json). If you want to override it, you can create the Docker image with you custom configuration file by running:\n\n```\n$ git clone https://github.com/cloudfoundry-community/pe-rds-broker.git\n$ cd rds-broker\n$ bin/build-docker-image\n```\n\n### BOSH\n\nThis broker can be deployed using the [AWS Service Broker BOSH Release](https://github.com/cf-platform-eng/aws-broker-boshrelease).\n\n## Configuration\n\nRefer to the [Configuration](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/CONFIGURATION.md) instructions for details about configuring this broker.\n\nThis broker gets the AWS credentials from the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. It requires a user with some [IAM](https://aws.amazon.com/iam/) \u0026 [RDS](https://aws.amazon.com/rds/) permissions. Refer to the [iam_policy.json](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/iam_policy.json) file to check what actions the user must be allowed to perform.\n\n## Usage\n\n### Managing Service Broker\n\nConfigure and deploy the broker using one of the above methods. Then:\n\n1. Check that your Cloud Foundry installation supports [Service Broker API Version v2.6 or greater](https://docs.cloudfoundry.org/services/api.html#changelog)\n2. [Register the broker](https://docs.cloudfoundry.org/services/managing-service-brokers.html#register-broker) within your Cloud Foundry installation;\n3. [Make Services and Plans public](https://docs.cloudfoundry.org/services/access-control.html#enable-access);\n4. Depending on your Cloud Foundry settings, you migh also need to create/bind an [Application Security Group](https://docs.cloudfoundry.org/adminguide/app-sec-groups.html) to allow access to the RDS DB Instances.\n\n### Integrating Service Instances with Applications\n\nApplication Developers can start to consume the services using the standard [CF CLI commands](https://docs.cloudfoundry.org/devguide/services/managing-services.html).\n\nDepending on the [broker configuration](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/CONFIGURATION.md#rds-broker-configuration), Application Depevelopers can send arbitrary parameters on certain broker calls:\n\n#### Provision\n\nProvision calls support the following optional [arbitrary parameters](https://docs.cloudfoundry.org/devguide/services/managing-services.html#arbitrary-params-create):\n\n| Option                       | Type    | Description\n|:-----------------------------|:------- |:-----------\n| backup_retention_period      | Integer | The number of days that Amazon RDS should retain automatic backups of the DB instance (between `0` and `35`) (*)\n| character_set_name           | String  | For supported engines, indicates that the DB instance should be associated with the specified CharacterSet (*)\n| dbname                       | String  | The name of the Database to be provisioned. If it does not exists, the broker will create it, otherwise, it will reuse the existing one. If this parameter is not set, the broker will use a random Database name\n| preferred_backup_window      | String  | The daily time range during which automated backups are created if automated backups are enabled (*)\n| preferred_maintenance_window | String  | The weekly time range during which system maintenance can occur (*)\n\n(*) Refer to the [Amazon Relational Database Service Documentation](https://aws.amazon.com/documentation/rds/) for more details about how to set these properties\n\n#### Update\n\nUpdate calls support the following optional [arbitrary parameters](https://docs.cloudfoundry.org/devguide/services/managing-services.html#arbitrary-params-update):\n\n| Option                       | Type    | Description\n|:-----------------------------|:------- |:-----------\n| apply_immediately            | Boolean | Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the Preferred Maintenance Window setting for the DB instance (*)\n| backup_retention_period      | Integer | The number of days that Amazon RDS should retain automatic backups of the DB instance (between `0` and `35`) (*)\n| preferred_backup_window      | String  | The daily time range during which automated backups are created if automated backups are enabled (*)\n| preferred_maintenance_window | String  | The weekly time range during which system maintenance can occur (*)\n\n(*) Refer to the [Amazon Relational Database Service Documentation](https://aws.amazon.com/documentation/rds/) for more details about how to set these properties\n\n#### Bind\n\nBind calls support the following optional [arbitrary parameters](https://docs.cloudfoundry.org/devguide/services/application-binding.html#arbitrary-params-binding):\n\n| Option | Type   | Description\n|:-------|:------ |:-----------\n| dbname | String | The name of the Database to bind the application to (it must be provisioned previously)\n\n## Contributing\n\nIn the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.\n\nHere are some ways *you* can contribute:\n\n* by using alpha, beta, and prerelease versions\n* by reporting bugs\n* by suggesting new features\n* by writing or editing documentation\n* by writing specifications\n* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)\n* by refactoring code\n* by closing [issues](https://github.com/cloudfoundry-community/pe-rds-broker/issues)\n* by reviewing patches\n\n### Submitting an Issue\n\nWe use the [GitHub issue tracker](https://github.com/cloudfoundry-community/pe-rds-broker/issues) to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any details that may be necessary to reproduce the bug, including your Golang version and operating system. Ideally, a bug report should include a pull request with failing specs.\n\n### Submitting a Pull Request\n\n1. Fork the project.\n2. Create a topic branch.\n3. Implement your feature or bug fix.\n4. Commit and push your changes.\n5. Submit a pull request.\n\n## Copyright\n\nCopyright (c) 2015 Pivotal Software Inc. See [LICENSE](https://github.com/cloudfoundry-community/pe-rds-broker/blob/master/LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry-community%2Fpe-rds-broker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry-community%2Fpe-rds-broker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry-community%2Fpe-rds-broker/lists"}