https://github.com/cloudfoundry-community/container-info-buildpack
A buildpack that allows exploring around the Cloud Foundry runtime container. Useful when creating other buildpacks to discover the staging and runtime environment setup / restrictions
https://github.com/cloudfoundry-community/container-info-buildpack
Last synced: 9 months ago
JSON representation
A buildpack that allows exploring around the Cloud Foundry runtime container. Useful when creating other buildpacks to discover the staging and runtime environment setup / restrictions
- Host: GitHub
- URL: https://github.com/cloudfoundry-community/container-info-buildpack
- Owner: cloudfoundry-community
- License: apache-2.0
- Created: 2013-09-16T11:02:02.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2014-08-04T11:47:38.000Z (almost 12 years ago)
- Last Synced: 2024-04-14T22:47:39.590Z (about 2 years ago)
- Language: JavaScript
- Size: 1.48 MB
- Stars: 14
- Watchers: 20
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
container-info-buildpack
========================
A buildpack that allows exploring around the Cloud Foundry runtime container. Useful when creating other buildpacks to discover the staging and runtime environment setup / restrictions
It use:
- for web-ui part:
- [AngularJS](https://angularjs.org/) (for [MVVM](http://khanlou.com/2014/03/model-view-whatever/))
- [Bower](http://bower.io/) (a package manager for the web)
- [Grunt](http://gruntjs.com/) (a javascript task runner)
- [Openresty](http://openresty.org/) (Nginx server with lua scripting)
- for buildpack himself
- [Forego](https://github.com/ddollar/forego) (a [foreman](https://github.com/ddollar/foreman) port in go, foreman is use to run `Procfile`)
_NB!_ By default login for the web-ui is `admin/admin` feel free to change it by placing a `.htpasswd` at your root app folder. (Prefer use the command `htpasswd` to create this file)
### Using
#### For a simple test:
Push a new "empty" app
```bash
$ mkdir container_info && cd container_info
$ touch container-info
$ cf push container-info-test -m 64M -b https://github.com/cloudfoundry-community/container-info-buildpack.git
```
On the webpage default logins are: `admin/admin`
#### To test your custom buildpack compile phase:
1. Create a folder with source test
2. Create a file or other things which will needs your detect script
3. Push the app in your cloudfoundry with this buildpack `https://github.com/cloudfoundry-community/container-info-buildpack.git`
4. Go to the root with your favorite browser and login with `admin/admin`
5. Go to buildpack page
6. Put your buildpack url (could be a `.git` url ending or `.tgz` or `.zip`)
7. See if everythings are ok or not
## Cloud Foundry Extensions - Offline Mode
The primary purpose of extending the heroku buildpack is to cache system dependencies for firewalled or other non-internet accessible environments. This is called 'offline' mode.
'offline' buildpacks can be used in any environment where you would prefer the dependencies to be cached instead of fetched from the internet.
The list of what is cached is maintained in [bin/package](bin/package).
Using cached system dependencies is accomplished by overriding curl during staging. See [bin/compile](bin/compile#L44-48)
## Building
1. Make sure you have fetched submodules
```bash
git submodule update --init
```
1. Build the buildpack
```bash
bin/package [ online | offline ]
```
1. Use in Cloud Foundry
Upload the buildpack to your Cloud Foundry and optionally specify it by name
```bash
cf create-buildpack container-info-offline container-info_buildpack-offline-v.zip 1
cf push my_app -b container-info-offline
```
## UI
Giving you a web app through which you can "explore" the container environment
## Rebuild web-ui in the buildpack
If you are contributing on the buildpack and particulary in the web-ui part you will have some trouble.
You should know that you must work on `web-ui/app` not the `dist` one.
When you finished to work on the web-ui you need to package it to make it go in `dist` folder to do this you need 3 things:
- First install [node.js](http://nodejs.org/)
- Install `bower` with npm with this command `npm install -g bower`
- Install `grunt` with npm with this command `npm install -g grunt`
Ok now you have your tools, next step is to go in command line to the folder `web-ui`.
And now do these commands:
```bash
$ npm install
$ bower install
$ grunt --force
```
Your dist folder is ready to be use, you've done.
## Contributing
Feel free to fork this project and post issues or/and pull request on the side of this page.