1. Introduction
2. Dependencies
3. Developing
4. Preparing for Deployment
5. To push the applications
6. Using the applications
7. Creating some test applications
8. Future
9. Licensing
10. Contribution
11. Support
12. Unit Tests
Shows application lifecycle metadata for all applications in a foundation, along with some basic information. The application is a wrapper around the Cloud Controller's /v2/organizations, /v2/spaces, /v2/apps, /v2/buildpacks and /v2/events end points.
Rather than asking each application to expose an end point, we adopt a convention, that every application's build pipeline must set metadata that the organisation cares about via environment variables. In this example, a string called ALM_VERSION.
The benefits of this approach is that it is very quick to retrieve information for all applications, and there is no onus on publishing applications to expose an additional end point.
The drawback is that it is purely a convention, so there is nothing to stop someone changing the environment variables after the application is deployed.
Python 2.7.10
Virtualenv
cd appstatus
virtualenv venv
source venv/bin/activate
pip install requests
pip install Flask
cd appstatus
source venv/bin/activate
mkdir -p vendor
pip freeze > requirements.txt
pip install --download vendor -r requirements.txt
#Create a user provided service holding your Cloud Foundry system domain and admin credentials
cf cups cclink -p '{"CFALM_SYSTEM_DOMAIN":"local.pcfdev.io","CFALM_CC_UID":"admin","CFALM_CC_PWD":"admin"}'
Edit appstatusview/config.js to use the host and domain for the REST API.
cd appstatus
cf push
cd appstatusview
cf push
REST API is visible at https://appstatus-host.DOMAIN/api/v1.0/apps
Application view is visible at: http://appstatusview.DOMAIN/
cd appstatus
./CreateTestApps.sh
a. appstatus: Remove hard-coded password (and externalise Cloud Controller domain)
b. appstatusview: Externalise appstatus URL in Javascript fragment which is then easier to write to as part of deployment
c. appstatusview: Add sorting to table
d. appstatusview: Add different colour for 'CRASHED' status
e. Both apps: Add support for pagination
f. Add services
g. Add buildpack file names
h. Add unit tests
CFALM is freely distributed under the MIT License. See LICENSE for details.
Create a fork of the project into your own reposity. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If approved, project owners will merge it.
Please file bugs and issues on the Github issues page for this project. This is to help keep track and document everything related to this repo. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.
To run unit tests, you must make sure the following dependencies are available in your environment:
sudo pip install pytest
sudo pip install flask
sudo pip install requests
sudo pip install pytest_mock
Tests can then be run from the root directory of this repository with:
python -m pytest