https://github.com/grimmpp/cloudfoundryservicebroker
Service Broker for Cloud Foundry e.g. to provision organizations or admin accounts. Written in Python
https://github.com/grimmpp/cloudfoundryservicebroker
Last synced: 10 months ago
JSON representation
Service Broker for Cloud Foundry e.g. to provision organizations or admin accounts. Written in Python
- Host: GitHub
- URL: https://github.com/grimmpp/cloudfoundryservicebroker
- Owner: grimmpp
- License: apache-2.0
- Created: 2020-12-18T21:17:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-04T06:33:20.000Z (over 5 years ago)
- Last Synced: 2025-02-16T23:12:27.225Z (over 1 year ago)
- Language: Python
- Size: 121 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloud Foundry Service Broker
This service brokers makes it possible to book Cloud Foundry Organizations or Admin Access to Cloud Foundry in the Cloud Foundry Marketplace.
The intention of this functionality is to offer Share Cloud Foundry Cluster for developers and for service providers. Developers can order Cloud Foundry Organizations and service providers can order admin access, so that they can register their service brokers or so that they can e.g. manage Application Security Groups for their service instances.
## How to use Service Plans
### Cloud Foundry Organization as a Service
Create new organization: `cf create-service "Cloud Foundry" "CF Org" test_org -c '{\"name\":\"test_org\"}'`
Change organization name: `cf update-service test_org -c '{\"name\":\"test_org2\"}'`
Change quota of organization: `cf update-service test_org -c '{\"quota\":\"runaway\"}'`
Delete organization: `cf delete-service test_org`
### Cloud Foundry Admin Access as a Service
Create new service instance (only service/no account): `cf create-service "Cloud Foundry" "CF Admin Access" myAdminAccess`
Create service key/admin account: `cf create-service-key myAdminAccess myAdminServiceKey`
Delete service key: `cf delete-service-key myAdminAccess myAdminServiceKey`
Delete service instance: `cf service-key myAdminAccess myAdminServiceKey`
## How to configure
In `cfBroker/settings.yml` you can enter and overwrite the predefined settings which are used for development.
In addition to that you can also overwrite single values by using environment variables. The mapping between the values in `cfBroker/settings.yml` and the environment variables can be found in `cfBroker/applicationSettings.py`.
## How to install
### Install package for development
python setup.py develop
## How to start
### Start Broker Locally
You can either start the broker in the project directory with `python main.py` or in the `cfBroker` folder by using `python app.py`.
## How to test
### Run Unit Tests
In order to run the unit tests just execute `python -m unittest discover -v` in the project directory.
### Run Manual Command Line Tests
In the test folder `test` you can find `cfRealAdminPlanTest.ps1` and `cfRealOrgPlanTest.ps1` which contain manual sample calls in order to test the broker functionality.
## Development
This service broker was developed and tested against [cfdev](https://github.com/cloudfoundry-incubator/cfdev).