Octant is a tool for developers to understand how applications run on a Kubernetes cluster. It aims to be part of the developer's toolkit for gaining insight and approaching complexity found in Kubernetes. Octant offers a combination of introspective tooling, cluster navigation, and object management along with a plugin system to further extend its capabilities.
Starboard Octant Plugin provides visibility into vulnerability assessment reports for Kubernetes workloads stored as custom resources.
- Octant >= 0.13 should first be installed. On macOS this is as simple as
brew install octant. For installation instructions on other operating systems and package managers, see Octant Installation.
- Environment authenticated against your Kubernetes cluster
In the following instructions we assume that the
$HOME/.config/octant/plugins directory is the default plugins
location respected by Octant. Note that the default location might be changed by setting the
environment variable when running Octant.
From the Binary Releases¶
Every release of Starboard Octant Plugin provides binary releases for a variety of operating systems. These binary versions can be manually downloaded and installed.
- Download your desired version
- Unpack it (
tar -zxvf starboard-octant-plugin_darwin_x86_64.tar)
- Find the
starboard-octant-pluginbinary in the unpacked directory, and move it to the default Octant's configuration directory (
mv starboard-octant-plugin_darwin_x86_64/starboard-octant-plugin $HOME/.config/octant/plugins). You might need to create the directory if it doesn't exist already.
From Source (Linux, macOS)¶
Building from source is slightly more work, but is the best way to go if you want to test the latest (pre-release) version of the plugin.
You must have a working Go environment.
git clone email@example.com:aquasecurity/starboard-octant-plugin.git cd starboard-octant-plugin make install
make install goal copies the plugin binary to the
Run the following command to remove the plugin:
rm -f $OCTANT_PLUGIN_PATH/starboard-octant-plugin
$OCTANT_PLUGIN_PATH is the default plugins location respected by Octant. If not set, it defaults to the