https://github.com/alphagov/paas-aiven-broker
A service broker to provide Aiven Elasticsearch and InfluxDB services to Cloud Foundry users
https://github.com/alphagov/paas-aiven-broker
aiven aws broker cloud-foundry paas reliability-engineering
Last synced: 5 months ago
JSON representation
A service broker to provide Aiven Elasticsearch and InfluxDB services to Cloud Foundry users
- Host: GitHub
- URL: https://github.com/alphagov/paas-aiven-broker
- Owner: alphagov
- License: mit
- Created: 2018-06-11T09:21:13.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-07-10T09:56:27.000Z (5 months ago)
- Last Synced: 2025-07-10T17:50:03.193Z (5 months ago)
- Topics: aiven, aws, broker, cloud-foundry, paas, reliability-engineering
- Language: Go
- Homepage:
- Size: 13.3 MB
- Stars: 16
- Watchers: 12
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aiven Service Broker
⚠️
When merging pull requests,
please use the [gds-cli](https://github.com/alphagov/gds-cli)
or [github_merge_sign](https://rubygems.org/gems/github_merge_sign)
⚠️
This is an [Open Service Broker API](https://www.openservicebrokerapi.org/) compliant service broker for services offered by [https://aiven.io/](https://aiven.io/).
## Running
Provide a configuration file, such as the example configuration, and run `main`:
```bash
go run main.go -config examples/config.json
```
## Testing
### Unit Testing
```bash
make unit
```
### Integration Testing
Integration testing requires environment variables to be set (see [`provider/config.go`](https://github.com/alphagov/paas-aiven-broker/blob/main/provider/config.go#L70-L90) for details).
There is a make target which creates a `.env` file with these credentials and runs with these:
```bash
make local_integration
```
Alternatively, export these manually and run:
```bash
make integration
```
Note: integration testing uses the real Aiven API and therefore incurs a cost.