The IBM Administration Web UI provides metrics and operations data for CloudFoundry V1. It gathers data from the varz providers for the various CloudFoundry components.
Questions about the Admin UI v1 Project can be directed to the CF Google Group:
- Cloud Foundry Developers: https://groups.google.com/a/cloudfoundry.org/forum/#!forum/vcap-dev
We use github issues to report and handle bug reports.
We accept contributions via pull requests.
Please see the appropriate CLA agreements (in the CLAs folder) needed for us to accept pull requests.
In order to execute, the administration ui needs to be able to access the following resources:
- NATS
Installation of the administration ui and its prerequisites require access to the internet to access github.com, rubygems.org, ubuntu software repositories, etc.
This has been tested on Ubuntu 10.04.4 64 bit, Ubuntu 12.04.3 64 bit and Ubuntu 13.04 64 bit.
sudo apt-get install -f -y --no-install-recommends git-core build-essential libssl-dev
Ruby is required to run the administration ui. This has been tested with Ruby 1.9.3-p448. Here is a sample installation of ruby using rbenv:
git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile
echo 'eval "$(rbenv init -)"' >> ~/.profile
. ~/.profile
rbenv install 1.9.3-p448
rbenv global 1.9.3-p448
The bundler gem is required to install prerequisite gems for the administration ui.
gem install bundler --no-rdoc --no-ri
If you are using rbenv you need to refresh the rbenv shims:
rbenv rehash
git clone https://github.com/cloudfoundry-community/admin-ui-v1.git
cd admin-ui-v1
bundle install
Default configuration found in config/default.yml
Values that must be changed for your environment are marked in bold.
-
cloud_controller_uri - Title used for web ui header as well as email notification.
-
mbus -
URL to the NATS.
Example:nats://nats:c1oudc0w@10.10.10.10:4222 -
port -
Port for the administration ui web server.
Example:8070 -
data_file -
Relative path location to store the administration ui data file.
Example:data/data.json -
stats_file -
Relative path location to store the administration ui statistics.
Example:data/stats.json -
log_file -
Relative path locaton to the administration ui log file
Example:admin_ui.log -
ui_credentials -
Credentials to access the administration ui as a standard user.
-
username -
User for standard login.
Example:user -
password -
Password for standard login.
Example:passw0rd
-
-
ui_admin_credentials -
Credentials to access the administration ui as an admin user
-
username -
User for admin login.
Example:admin -
password -
Password for admin login.
Example:passw0rd
-
-
dea_retries -
Number of attempts to talk to the DEA's varz endpoint. In v1, the DEA would often responde with varz content which did not include app information.
Example:10 -
nats_discovery_timeout -
The amount of seconds to wait for the NATS to respond to
vcap.component.discover.
Example:10 -
component_connection_retries -
The number of times to try to talk to a varz component before considered failing.
Example:2 -
sender_email -
Email server and account used when sending an email notifying receivers of down components.
-
server -
The email server.
Example:10.10.10.10 -
account -
The email account.
Example:system@10.10.10.10
-
-
receiver_emails -
The receiving email(s) in a comma-delimited array.
Example:[ ]
Example:[bar@10.10.10.10, baz@10.10.10.10] -
monitored_components -
Array of components which when down will result in notification.
Example:- NATS
Example:- CloudController
Example:- DEA
Example:- HealthManager
Example:- Router
Example of a wildcard:- -Provisioner
Example for all components:- ALL -
cache_refresh_interval -
Seconds between NATS discoveries
Example:30 -
stats_refresh_time -
Daily minute for automatic stats collection
Example:300. This results in stats collection at 5 AM. -
stats_retry_interval -
Seconds between stats collection saving.
Example:300 -
stats_retries -
Number of stats retries.
Example:5 -
log_file_page_size -
Size of each log file page in bytes.
Example:51200 -
log_files -
Array of log files being exposed through the administration ui. Note that these files must be accessible by the user that started the administration ui.
Example- /home/cloudfoundry/cloudfoundry/.deployments/devbox/log/*.log
You can provide an option to reference the configuration file when you execute the administration ui or you
can let it default to config/default.yml
ruby bin/admin [-c <configuration file>]
http://<admin ui host>:8070