Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudfoundry/csb-brokerpak-azure
https://github.com/cloudfoundry/csb-brokerpak-azure
cff-wg-service-management
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cloudfoundry/csb-brokerpak-azure
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2021-01-04T20:23:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T21:48:39.000Z (10 months ago)
- Last Synced: 2024-04-14T06:47:00.544Z (10 months ago)
- Topics: cff-wg-service-management
- Language: Go
- Homepage:
- Size: 57.3 MB
- Stars: 9
- Watchers: 11
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Azure Brokerpak
A brokerpak for the [Cloud Service Broker](https://github.com/pivotal/cloud-service-broker) that provides support for Azure services.
## Development Requirements
* Either an up-to-date version of Go or [Docker](https://docs.docker.com/get-docker/)
* make - covers development lifecycle steps
## Azure account information
To provision services, the brokerpak currently requires Azure account values. The brokerpak expects them in environment variables:
* ARM_SUBSCRIPTION_ID
* ARM_TENANT_ID
* ARM_CLIENT_ID
* ARM_CLIENT_SECRET
## 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-azure* It will be necessary to bind a MySQL database to the broker to provide broker state storage. See [Azure Installation](./docs/azure-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
```
terminal 1
>> make run
terminal 2
>> make run-examples
```
## 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
```