Builpack dashboard for Cloudfoundry
Project description
# CF Buildpack Dashboard
## Dependencies
In order to run this application you need the [cf-light-api](https://github.com/SpringerPE/cf-light-api) running at
a known endpoint.
Each `cf-light-api` endpoint needs to be provided as a value by populating the `CF_BUILDPACK_DASHBOARD_ENVIRONMENT` env
variable.
## Configuration
The `cf_buildpack_dashboard` application accepts the following configuration parameters passed
by env variables:
- `CF_BUILDPACK_DASHBOARD_ENVIRONMENT`: a json dictionary mapping different environments to their api endpoints. For example ```{"test": "http://cf-light-api-test.example.com", "prod": "https:cf-light-api-prod.example.com"}```
- `PORT`: the port to which the application binds. If running in Cloudfoundry it will be provided by the platform.
## Building for pip
To build the `tar.gz` pip package simply run: ```python setup.py sdist```
from the project root directory.
## Installing and Running
### Pip install
You can install the application from `pypi.org` by running `pip install cf_buildpack_dashboard`. This will install an
executable script that you can call directly `cf_buildpack_dashboard`
### Cloudfoundry manifest
You can target as well a Cloudfoundry installation by providing a manifest as in the following example:
```
applications:
- name: cf-buildpack-dashboard
instances: 1
memory: 256MB
command: ./run_app.py
env:
CF_BUILDPACK_DASHBOARD_ENVIRONMENTS: '{
"test": "https://cf-api.test.example.com",
"dev": "https://cf-api.dev.example.com",
"live": "https://cf-api.live.example.com"
}'
```
and push with `cf push`
### Provided script
The application can also be run as a simple python application by installing the
requirements and using the provided `run_app.py` script.
## Running the tests
```
nosetests -s
```
## Dependencies
In order to run this application you need the [cf-light-api](https://github.com/SpringerPE/cf-light-api) running at
a known endpoint.
Each `cf-light-api` endpoint needs to be provided as a value by populating the `CF_BUILDPACK_DASHBOARD_ENVIRONMENT` env
variable.
## Configuration
The `cf_buildpack_dashboard` application accepts the following configuration parameters passed
by env variables:
- `CF_BUILDPACK_DASHBOARD_ENVIRONMENT`: a json dictionary mapping different environments to their api endpoints. For example ```{"test": "http://cf-light-api-test.example.com", "prod": "https:cf-light-api-prod.example.com"}```
- `PORT`: the port to which the application binds. If running in Cloudfoundry it will be provided by the platform.
## Building for pip
To build the `tar.gz` pip package simply run: ```python setup.py sdist```
from the project root directory.
## Installing and Running
### Pip install
You can install the application from `pypi.org` by running `pip install cf_buildpack_dashboard`. This will install an
executable script that you can call directly `cf_buildpack_dashboard`
### Cloudfoundry manifest
You can target as well a Cloudfoundry installation by providing a manifest as in the following example:
```
applications:
- name: cf-buildpack-dashboard
instances: 1
memory: 256MB
command: ./run_app.py
env:
CF_BUILDPACK_DASHBOARD_ENVIRONMENTS: '{
"test": "https://cf-api.test.example.com",
"dev": "https://cf-api.dev.example.com",
"live": "https://cf-api.live.example.com"
}'
```
and push with `cf push`
### Provided script
The application can also be run as a simple python application by installing the
requirements and using the provided `run_app.py` script.
## Running the tests
```
nosetests -s
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cf_buildpack_dashboard-0.0.6.tar.gz
(628.6 kB
view hashes)
Close
Hashes for cf_buildpack_dashboard-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 674bcf0f0b47fbc149eacdded39b1025335a6370d078c44e858a8b9a7e9c146f |
|
MD5 | 1891af8f33b4aa1b28bd8b1d2c188cb3 |
|
BLAKE2b-256 | 83b8a4a3e22496e02f16b4bc7e7850a920772700a32855d5079017610d93d854 |