# csb-brokerpak-aws

**Repository Path**: mirrors_cloudfoundry/csb-brokerpak-aws

## Basic Information

- **Project Name**: csb-brokerpak-aws
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-09
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AWS Brokerpak

A brokerpak for the [Cloud Service Broker](https://github.com/pivotal/cloud-service-broker) that provides support for AWS services.

## Development Requirements

* Either an up-to-date version of Go or [Docker](https://docs.docker.com/get-docker/)
* make - covers development lifecycle steps

## AWS account information

To provision services, the brokerpak currently requires access to the AWS account.
You can provide access by using any of the methods defined by the default AWS credential provider chain ([Credential Chain](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html#credentialProviderChain)).


## Development Tools

A Makefile supports the full local development lifecycle for the brokerpak.

The make targets can be run either with Docker or installing the required libraries in the local OS.

Available make targets can be listed by running `make`.

### Running with docker

1. Install [Docker](https://docs.docker.com/get-docker/)
2. Launch an interactive shell into some supported image containing all necessary tools. For example:
   ```
   # From the root of this repo run:
   docker run -it --rm -v "${PWD}:/repo" --workdir "/repo" --entrypoint "/bin/bash" golang:latest
   make
   ```

### Running with Go

1. Make sure you have the right Go version installed (see `go.mod` file).

The make targets will build the source using the local go installation.

### Other targets

There is a make target to push the broker and brokerpak into a CloudFoundry foundation. It will be necessary to manually configure a few items for the broker to work.

- `make push-broker` will `cf push` the broker into CloudFoundry. Requires the `cf` cli to be installed.

The broker gets pushed into CloudFoundry as *cloud-service-broker-aws*.
It will be necessary to bind a MySQL database to the broker to provide broker state storage.
See [AWS Installation](./docs/installation.md) docs for more info.

## Broker
The version of Cloud Service Broker to use with this brokerpak is encoded in the `go.mod` file.
The make targets will use this version by default.

## Tests

### Example tests

Services definitions declare examples for each plan they provide. Those examples are then run through the whole cycle of `provision`, `bind`, `unbind`, and `delete` when running

```
$ make examples       # Lists example tests
$ make run-examples   # Runs example tests
```

## Acceptance tests

See [acceptance tests](acceptance-tests/README.md)

## Integration tests

Integration tests can be run with the following command:

```bash
make run-integration-tests
```