{"id":19040886,"url":"https://github.com/cloudfoundry/cloud-service-broker","last_synced_at":"2026-01-21T12:00:57.856Z","repository":{"id":37045122,"uuid":"232908362","full_name":"cloudfoundry/cloud-service-broker","owner":"cloudfoundry","description":"OSBAPI service broker that uses Terraform to provision and bind services. Derived from https://github.com/GoogleCloudPlatform/gcp-service-broker","archived":false,"fork":false,"pushed_at":"2026-01-20T22:09:54.000Z","size":976649,"stargazers_count":82,"open_issues_count":6,"forks_count":37,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-01-21T08:20:43.585Z","etag":null,"topics":["aws","azure","cff-wg-service-management","cloud-foundry","gcp","opentofu","osbapi","service-broker","terraform"],"latest_commit_sha":null,"homepage":"","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.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-01-09T21:20:25.000Z","updated_at":"2026-01-20T22:09:53.000Z","dependencies_parsed_at":"2023-02-18T14:30:53.231Z","dependency_job_id":"daea52a3-56bc-440e-9faf-7689e1be66d5","html_url":"https://github.com/cloudfoundry/cloud-service-broker","commit_stats":null,"previous_names":["pivotal/cloud-service-broker","cloudfoundry-incubator/cloud-service-broker"],"tags_count":632,"template":false,"template_full_name":null,"purl":"pkg:github/cloudfoundry/cloud-service-broker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcloud-service-broker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcloud-service-broker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcloud-service-broker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcloud-service-broker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry","download_url":"https://codeload.github.com/cloudfoundry/cloud-service-broker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcloud-service-broker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28632781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["aws","azure","cff-wg-service-management","cloud-foundry","gcp","opentofu","osbapi","service-broker","terraform"],"created_at":"2024-11-08T22:25:57.020Z","updated_at":"2026-01-21T12:00:57.810Z","avatar_url":"https://github.com/cloudfoundry.png","language":"Go","readme":"[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0/)\n[![test](https://github.com/cloudfoundry/cloud-service-broker/workflows/run-tests/badge.svg?branch=main)](https://github.com/cloudfoundry/cloud-service-broker/actions?query=workflow%3Arun-tests+branch%3Amain)\n[![Go Report Card](https://goreportcard.com/badge/github.com/cloudfoundry/cloud-service-broker)](https://goreportcard.com/report/github.com/cloudfoundry/cloud-service-broker)\n\n**Warning**: From Version 1.0.0 onwards the Cloud Service Broker only supports OpenTofu. Custom brokerpaks need to specify an OpenTofu version and the [upgrade process](https://github.com/cloudfoundry/cloud-service-broker/blob/main/docs/terraform-upgrades.md) must be followed for existing instances. Only upgrades from terraform versions 1.5.x are supported. For more information, see the [OpenTofu migration guide](./docs/opentofu_migration_guide.md)\n\n# Cloud Service Broker\nAn OSBAPI-compliant service broker that uses OpenTofu to create service instances.\n\nThis is a service broker built to be used with [Cloud Foundry](https://docs.cloudfoundry.org/services/overview.html) and Kubernetes. It adheres to the [Open Service Broker API v2.13](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md).\n\nCloud Service Broker is a fork of the [GCP Service Broker](https://github.com/GoogleCloudPlatform/gcp-service-broker)\nand uses [Brokerpaks](https://github.com/cloudfoundry/cloud-service-broker/blob/main/docs/brokerpak-intro.md) to\nexpose services. As long as your target cloud has a [OpenTofu provider](https://opentofu.org/docs/language/providers/),\nservices can be provisioned via a common interface using standard `cf` CLI commands.\n\nSome of the benefits over traditional, IaaS-provided, service brokers include: \n- **Easily extensible and maintainable** Less talking to far-flung teams, more getting work done. \n- **One common broker for all brokered services.** Cloud Service Broker decouples the service broker functionality from the catalog of services that it exposes.\n- **Credhub integration out-of-the-box** CredHub encrypts and manages all the secrets associated with your usage of cloud services.\n- **Community** When you expose a service via a [Brokerpak](https://github.com/cloudfoundry/cloud-service-broker/blob/main/docs/brokerpak-intro.md), you can make it available to everyone who uses CSB.\n- **Possible to migrate existing services using [OpenTofu Import](https://opentofu.org/docs/language/import/)**\n\n## Architecture\n![Architecture Diagram](https://lh6.googleusercontent.com/GoNJx-4dQ51pEY6mCLkus1peKhZJbDMj4JHpdu83stfQrbcsjd45ypBPzpspfWAPPYrc63BREaawwRHS4Ht4U7m2yWAHItwaIgfuwUtn_KxfF96s6Jby7BRIliZ6BZz1HL-KhaI)\n\n\n## Slack\nPlease reach out on the #cloudservicebroker channel in the [Cloud Foundry Slack](https://slack.cloudfoundry.org/)! \n\n## Installation\n\nThis service broker can be installed as a CF application. See the instructions for:\n\n* [General configuration](./docs/configuration.md)\n* [AWS](https://github.com/cloudfoundry/csb-brokerpak-aws/blob/main/docs/installation.md)\n* [Azure](https://github.com/cloudfoundry/csb-brokerpak-azure/blob/main/docs/azure-installation.md)\n  * [Azure configuration examples](https://github.com/cloudfoundry/csb-brokerpak-azure/blob/main/docs/azure-example-configs.md)\n* [GCP](https://github.com/cloudfoundry/csb-brokerpak-gcp/blob/main/docs/installation.md)\n\n\n## CSB-Provided Brokerpaks \n\nTo examine, submit issues or pull requests to the Brokerpaks which have been created for the major public clouds (AWS, Azure, GCP) see the repos below:\n\n* [AWS Brokerpak](https://github.com/cloudfoundry/csb-brokerpak-aws)\n* [Azure Brokerpak](https://github.com/cloudfoundry/csb-brokerpak-azure)\n* [GCP Brokerpak](https://github.com/cloudfoundry/csb-brokerpak-gcp)\n\n## Usage\n\n**For operators**: see [docs/configuration.md](./docs/configuration.md) for details about configuring the service broker.\n\n**For developers**: see [docs/](./docs) ReadMe for service options and details.\n\nYou can get documentation specific to your install from the `/docs` endpoint of your deployment.\n\n\n## Commands\n\nThe service broker can be run as both a server (the service broker) and as a general purpose command line utility.\nIt supports the following sub-commands:\n\n * `client` - A CLI client for the service broker.\n * `config` - Show and merge configuration options together.\n * `help` - Help about any command.\n * `serve` - Start the service broker.\n\n## Development\n\n`make` is used to orchestrate most development tasks. \n`go` is required to build the broker.\nIf you don't have `go` installed, it is possible to use `docker` to launch an interactive shell into some supported image containing all necessary tools. For example:\n```\n# From the root of this repo run:\ndocker run -it --rm -v \"${PWD}:/repo\" --workdir \"/repo\" --entrypoint \"/bin/bash\" golang:latest\nmake\n```\n\nThere are make targets for most common dev tasks. Running make without a target will list the possible targets.\n\n| command           | action                                 |\n|-------------------|----------------------------------------|\n| `make build`      | builds broker into `./build`           |\n| `make test-units` | runs unit tests                        |\n| `make clean`      | removes binaries and built broker paks |\n\n## Local mimic commands\nThe mimic commands look and feel like CloudFoundry CLI commands, but actually run CSB actions locally. They are useful when developing brokerpaks.\nBy using the make target `make install` you can install the CSB as a local command called `csb`.\nThe mimic commands are:\n- `csb create-service` - creates a service instance\n- `csb services` - lists created service instances\n- `csb service` - displays information on an existing service instance\n- `csb update-service` - updates a service instance\n- `csb upgrade-service` - upgrades a service instance\n- `csb delete-service` - deletes a service instance\n- `csb create-service-key` - creates a \"binding\" and prints credentials\n- `csb service-keys` - lists service keys\n- `csb service-key` - prints a service key\n- `csb delete-service-key` - deletes a \"binding\"\n\nThe mimic commands build a brokerpak, start an ephemeral CSB server and send OSBAPI\nrequests to it in a similar style to what CloudFoundry would do. The CSB database\nis stored as a file called `.csb.db`.\n\nAdditionally, there are commands which use the same framework to run the example tests. These are:\n- `csb examples` - list the example tests\n- `csb run-examples` - runs the specified example tests\n\n\n## Bug Reports, Feature Requests, Documentation Requests \u0026 Support\n\n[File a GitHub issue](https://github.com/cloudfoundry/cloud-service-broker/issues) for bug reports and documentation or feature requests. Please use the provided templates.  \n\n## Contributing\nWe are always looking for folks to contribute Brokerpaks! \n\nSee [Brokerpak Dissection](https://github.com/cloudfoundry/cloud-service-broker/blob/main/docs/brokerpak-dissection.md) and the [user guides](https://github.com/cloudfoundry/cloud-service-broker/blob/main/docs/user-guides) for more information on how to contribute to existing brokerpaks and how build one from scratch.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fcloud-service-broker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry%2Fcloud-service-broker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fcloud-service-broker/lists"}