OpenShift Management Console

The management console for OpenShift Origin.

Contributing

Getting started

Install Nodejs and npm
Install grunt-cli and bower by running npm install -g grunt-cli bower (may need to be run with sudo)
Install ruby
Install bundler gem install bundler
Install Go per steps 1 - 3
Install dev dependencies by running hack/install-deps.sh
Launch the console and start watching for asset changes by running grunt serve. This should open https://localhost:9000/ in your default browser.

Note: If you see an ENOSPC error, you may need to increase the number of files your user can watch by running this command:
```
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
```
Accept the self-signed certificate for the web console. (For Chrome on OS X, import server.crt into Keychain Access or accept the web console certificate in Safari.)

Enable / disable console log output

Debug logging can be enabled by opening your browser's JavaScript console, running the commands below, and then refreshing the page.

localStorage["OpenShiftLogLevel.main"] = "<log level>";
localStorage["OpenShiftLogLevel.auth"] = "<log level>";

Loggers:

OpenShiftLogLevel.main - default logger for OpenShift
OpenShiftLogLevel.auth - auth specific logger, this includes login, logout, and oauth

The supported log levels are:

OFF (default for all loggers except main)
INFO
DEBUG
WARN
ERROR (default for main)

Note: currently most of our logging either goes to INFO or ERROR

Local configuration

app/config.js is the default configuration file for web console development. If you need to change the configuration, for example, to point to a different API server, copy app/config.js to app/config.local.js and edit the copy. app/config.local.js is not tracked and will be used instead if it exists.

Before opening a pull request

Please configure your editor to use the following settings to avoid common code inconsistencies and dirty diffs:

Use soft-tabs set to two spaces.
Trim trailing white space on save.
Set encoding to UTF-8.
Add new line at end of files.

Or configure your editor to utilize .editorconfig, which will apply these settings automatically.

Then:

If needed, run grunt build to update the files under the dist directory
Run the spec tests with grunt test
Run the integrations tests (your api server must be running) grunt test-integration
Rebase and squash changes to a single commit

Note: in order to run the end to end tests you must have Chrome and chromedriver installed. The script below will set this up for you on linux systems.

# Add signing key for Chrome repo
wget https://dl.google.com/linux/linux_signing_key.pub
rpm --import linux_signing_key.pub

# Add Chrome yum repo
yum-config-manager --add-repo=http://dl.google.com/linux/chrome/rpm/stable/x86_64

# Install chrome
yum install -y google-chrome-stable

# Install chromedriver
wget https://chromedriver.storage.googleapis.com/2.16/chromedriver_linux64.zip
unzip chromedriver_linux64.zip
mv chromedriver /usr/bin/chromedriver
chown root /usr/bin/chromedriver
chmod 755 /usr/bin/chromedriver

Production builds

Make sure all dev dependencies are up to date by running hack/install-deps.sh
Run grunt build
TODO - run script to build bindata.go from the dist in this repo
In your origin repo run hack/build-go.sh

The assets served by the OpenShift all-in-one server will now be up to date. By default the assets are served from http://localhost:8091

Debugging dist diff failures

If Jenkins complains that the built dist files are different than the committed version, ensure the committed version is correct:

Run hack/clean-deps.sh
Run hack/install-deps.sh
Run grunt build
If anything under dist or dist.java has changed, add it to your commit and re-push

Architecture

The OpenShift v3 web console is based on AngularJS and Hawt.io

Navigation

The v3 console supports a custom context root. When running as part of the openshift start command the console's context root is injected into the <base> tag of the index.html file. In order to support custom context roots, all console URLs must be relative, so they should not contain a leading "/" character.

For example if you want to specify a URL directly in an HTML template to go to the project overview it would look like

<a href="project/foo/overview">

and would actually resolve to be /contextroot/project/foo/overview by the browser. Similarly, if you want to use JavaScript to change the current page location, you should use the $location service from angular like

$location.url("project/foo/overview")

Finally, if you want to reference the root of the web console use the path ./

Custom directives and filters

The v3 console relies heavily on custom directives and filters, some of which are intended to be utilties and used throughout the console source. The list below is NOT a complete list of all of our directives and filters.

Directives

For more details on the expected scope arguments, see the source under app/scripts/directives

toggle (attribute) - intended for Bootstrap's data-toggle=tooltip and data-toggle=popover, will automatically initialize any tooltips and popovers
alerts (element) - renders a set of alerts according to the patternfly style
relative-timestamp (element) - renders a relative timestamp (ex: '5 minutes ago') based on the current time, auto-updating every 30 seconds
copy-to-clipboard (element) - creates a copy to clipboard button using clipboard.js
back (attribute) - when the element is clicked a simulated browser back button event occurs (calls history.back)
select-on-focus (attribute) - when the element is focused, all text within it will be selected
tile-click (attribute or class) - for use with the .tile class, when anything on the tile is clicked, a simulated click to the a.tile-target link will be fired. Recommended use is by adding the .tile-click class to get the correct styles on hover.
click-to-reveal (attribute) - the element will be hidden and a link to show the element will appear instead, link text is customizable
osc-object (attribute or class) - When the element is clicked it will be shown in the details sidebar. Using as a class is preferred to pick up hover/active styles
truncate-long-text (element) - truncates text to a limit, optionally on word boundaries, adding a tooltip and ellipsis when the text is truncated

Filters

For more details on the expected arguments, see the source under app/scripts/filters

dateRelative - returns the relative date for a timestamp given the current time (ex: '5 minutes ago')
ageLessThan - returns whether a timestamp is within a given time amount (ex: 5) and unit (ex: 'minutes'). Refer to the Moment.js docs for the supported units.
orderObjectsByDate - given an array or hash of k8s or openshift API objects, return an array of the objects sorted by the creationTimestamp. By default orders with oldest first, optional reverse param will return ordered by newest first.
annotation - for a k8s or OpenShift api object, lets you get any annotation by key
description - shortcut for annotation | 'description'
tags - shortcut for annotation | 'tags'
label - for a k8s or OpenShift api object, lets you get any label by key
hashSize - returns the number of subobjects on a javascript hash
helpLink - returns the relevant link in the OpenShift docs for a particular help topic, new help topics should be added to the filter. DO NOT put URLs to help directly into the source in any location except for this filter

Extension points

There are two main ways to extend the v3 OpenShift console.

Add primary / secondary navigation tabs to the project nav

We rely on hawtio-core-navigation to build the primary/secondary nav that appears once you are in a project. We have customized the rendering of the tabs, so refer to app/scripts/app.js to see how we register our out of the box tabs.

Inject additional content into the page

We include the hawtio-extension-service. Currently we do not render any extension points, but if there are any locations where you would like to see customizable content, this is how we will add a hook to do that. As hooks are added we will provide a list of them here.

raghavendra-talur/origin-web-console