cockpit-project/registry-image-widgets

Name: registry-image-widgets

Owner: cockpit-project

Description: OpenShift and Kubernetes widgets for Image objects

Created: 2017-08-18 17:57:55.0

Updated: 2018-04-10 19:05:37.0

Pushed: 2018-04-10 19:06:24.0

Homepage:

Size: 215

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Registry Image Widgets

This provides rendering of Image and ImageStream objects as found in the Openshift Kubernetes distribution and related Registry. If these types of objects make their way into upstream Kubernetes, we should adapt the widgets here for rendering them.

Disclaimer

This is an early implementation and is subject to change.

Getting Started

The image widgets are provided in the registry-image-widgets bower package.

To get the registry-image-widgets bower component in another project, run:

r install registry-image-widgets --save

To see a simple running example git clone this repo and run

install
r install
on -m SimpleHTTPServer &
fox http://localhost:8000

This will install any required dependencies necessary to run the `index.html` demo.

Usage

Include the JS and CSS files, after angularjs and d3:

ipt src="bower_components/angular/angular.js"></script>
ipt src="bower_components/angular/angular-gettext.js"></script>
ipt src="bower_components/momentjs/moment.js"></script>
ipt src="bower_components/registry-image-widgets/dist/images.js"></script>
k rel="stylesheet" href="bower_components/registry-image-widgets/dist/images.css" />

Make sure your angular app / module includes `registryUI.images` as a module dependency.

lar.module('exampleApp', ['registryUI.images'])

Now include the terminal in your HTML. You must already have a pod resource, or a string URL in the current scope you pass to the terminal for its initialization.

istry-image-body image="image_resource" names="names_array" settings="settings">
gistry-image-body>
Documentation
&image

Required. A javascript object Image or ImageStreamImage resource.

&names

Optional. A list of qualified names (imagestream/image) this image goes by.

&settings

An optional javascript object with settings controlling the display. If

cker registry will be displayed. The ```host``` field is used to show
relevant host.


ing
---

```images.css``` for an example default look and feel.

ributing
--------

re committing any changes run the `webpack` task to make sure files have been
ted, and include the updated file in your commit.

ing
---

nstall test dependencies, run ```npm install```.

un tests use ```karma start```. This will run the test suite once with results displayed. Other options are available, such as ```--no-single-run``` to have tests run continuously with each file change (convenient for test development).

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.