Skip to content
A web-based, highly extensible platform for developers to better understand the complexity of Kubernetes clusters.
Go TypeScript HTML CSS JavaScript Shell Other
Branch: master
Clone or download
wwitzel3 Merge pull request #208 from wwitzel3/master
Fix LICENSE so tools parse it correctly
Latest commit 717dcad Aug 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add e2e setup steps Aug 16, 2019
changelogs 0.0.0.0 allowed host should allow ALL hosts Aug 21, 2019
choco Add choco nuspec and powershell install script Aug 7, 2019
ci Readme feedback; updated plugin paths Jul 19, 2019
cmd Simplify plugin API Aug 8, 2019
docs Set accepted hosts as an optional env variable Aug 20, 2019
examples add copyright to examples Jun 19, 2019
hacks rename clustereye => octant Jun 19, 2019
internal helpful debug log message when a host is denied Aug 21, 2019
pkg Added missing node navigation icon Aug 20, 2019
thirdparty/unstructured vendor a unstructured converter than can handle int64 => float64 Aug 9, 2019
tools Added go tools and build env vars; remove unused choco files Jul 11, 2019
vendor addinging github.com/gobwas/glob dep Aug 8, 2019
web Fix scroll issue in Logs Container & added unit test for it Aug 20, 2019
.dockerignore Fix broken Dockerfile path and ignored files Aug 5, 2019
.drone.yml Update drone signature Jul 23, 2019
.editorconfig draw graph using dagre Dec 10, 2018
.gitattributes CI build using choco on Windows Dec 5, 2018
.gitignore Add e2e setup steps Aug 16, 2019
.gitmodules Plugin docs served using Hugo Jun 13, 2019
.golangci.yml Create plugin helper service Jul 12, 2019
.goreleaser.yml Change email from octant-dashboard to project-octant Aug 6, 2019
.nvmrc set node version for ci Jan 30, 2019
CHANGELOG.md Bump makefile version and added changelogs Aug 21, 2019
CONTRIBUTING.md developer-dash => octant Jun 19, 2019
Dockerfile Initial e2e testing with cypress Aug 16, 2019
LICENSE Fix LICENSE so tools parse it correctly Aug 23, 2019
Makefile Bump makefile version and added changelogs Aug 21, 2019
NOTICE rename clustereye => octant Jun 19, 2019
README.md Bump makefile version and added changelogs Aug 21, 2019
ROADMAP.md add roadmap Jul 19, 2019
doc.go dev dash => octant Jun 19, 2019
go.mod addinging github.com/gobwas/glob dep Aug 8, 2019
go.sum addinging github.com/gobwas/glob dep Aug 8, 2019

README.md

Logo

Build Status GitHub release License

A web-based, highly extensible platform for developers to better understand the complexity of Kubernetes clusters.

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.

Features

  • Resource Viewer

    Graphically visualizate relationships between objects in a Kubernetes cluster. The status of individual objects are represented by color to show workload performance.

  • Summary View

    Consolidated status and configuration information in a single page aggregated from output typically found using multiple kubectl commands.

  • Port Forward

    Forward a local port to a running pod with a single button for debugging applications and even port forward multiple pods across namespaces.

  • Log Stream

    View log streams of pod and container activity for troubleshooting or monitoring without holding multiple terminals open.

  • Label Filter

    Organize workloads with label filtering for inspecting clusters with a high volume of objects in a namespace.

  • Cluster Navigation

    Easily change between namespaces or contexts across different clusters. Multiple kubeconfig files are also supported.

  • Plugin System

    Highly extensible plugin system for users to provide additional functionality through gRPC. Plugin authors can add components on top of existing views.

Usage

Octant demo

Installation

Package (Linux only)

  1. Download the .deb or .rpm from the releases page.

  2. Install with either dpkg -i or rpm -i respectively.

Windows

Chocolatey

  1. Install using chocolatey with the following one-liner:

    choco install octant --confirm

Scoop

  1. Add the extras bucket.

    scoop bucket add extras
  2. Install using scoop.

scoop install octant

Download a Pre-built Binary (Linux, macOS, Windows)

  1. Open the releases page from a browser and download the latest tarball or zip file.

  2. Extract the tarball or zip where X.Y is the release version:

    $ tar -xzvf ~/Downloads/octant_0.X.Y_Linux-64bit.tar.gz
    octant_0.X.Y_Linux-64bit/README.md
    octant_0.X.Y_Linux-64bit/octant
  3. Verify it runs:

    $ ./octant_0.X.Y_Linux-64bit/octant version

Getting Started

Before starting Octant, make sure you have access to a healthy cluster. If kubectl is installed, test using kubectl cluster-info.

Start running Octant:

$ octant

Octant should immediately launch your default web browser on 127.0.0.1:7777.

Or to run it on a specific host and fixed port: $ OCTANT_LISTENER_ADDR=0.0.0.0:8900 octant

For configuring Octant, setting up a development environment, or running tests, refer to the documentation here.

Plugins

Plugins are a core part of Octant in the Kubernetes ecosystem. A plugin can read objects and allows users to add components to Octant's views.

An example plugin can be found in cmd/octant-sample-plugin and installed to the default plugin path with make install-test-plugin.

Documentation for plugin components can be found in docs/plugins.

Discussion

Feature requests, bug reports, and enhancements are welcome. Contributors, maintainers, and users are encouraged to collaborate through these communication channels:

Contributing

New contributors will need to sign a contributor license agreement before code changes can be merged. Follow the instructions given by vmwclabot after opening a pull request.

Pull requests should also include a changelog with the naming convention described here.

See our roadmap for tentative features in a 1.0 release.

License

Octant is available under the Apache License, Version 2.0

You can’t perform that action at this time.