README
¶
Jenkins X Octant Plugins
This repository contains plugins for Octant for working with Jenkins X
Install
Octant should first be installed and added to your $PATH
To build the plugins use:
make octant
which will build the plugins, install then into ~/.config/octant/plugins and then startup octant against the current k8s cluster.
You can run make tail in another terminal to watch the console log of octant-jx if you are developing a plugin.
Using the Developer + Operator plugins
You should see on the left nav bar the Jenkins X Developer + Operator plugins appear near the bottom (2nd to last icons).
Running multiple Octants
You may connect to different clusters in different shells and open an octant for each cluster via:
octant --listener-addr=localhost:0
If you want to open a specific view try:
octant --listener-addr=localhost:0 --browser-path="/#/jx/pipelines-recent"
An octant will start along with a new browser window.
Adding a new view
Its super easy to add new views of any kubernetes or custom resource you like.
A good example to copy/paste if you want to add a new view is the Repositories view:
- pkg/plugin/views/repositories_view.go is the view itself then you need to:
- add a handler in pkg/plugin/router/handlers.go to use your new view file
- add a link to your new view in pkg/plugin/settings/options.go
Resources for plugin developers
- Check out the Plugin Documentation
- Views can use any of the widgets in the
/pkg/view/componentspackage of octant - check the reference docs. - Here's another example plugin which enriches existing views
Directories