Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

Latest commit

 

History

History
73 lines (47 loc) · 3.14 KB

getting-started.md

File metadata and controls

73 lines (47 loc) · 3.14 KB
Raw

Getting Started

Environment Variables

Octant is configurable through environment variables defined at runtime.

  • KUBECONFIG - set to non-empty location if you want to set KUBECONFIG with an environment variable.
  • OCTANT_DISABLE_OPEN_BROWSER - set to a non-empty value if you don't the browser launched when the dashboard start up.
  • OCTANT_LISTENER_ADDR - set to address you want dashboard service to start on. (e.g. localhost:8080)
  • OCTANT_ACCEPTED_HOSTS - set to comma-separated string of hosts to be accepted. (e.g. demo.octant.example.com,awesome.octant.zr)
  • OCTANT_VERBOSE_CACHE - set to a non-empty value to view cache actions
  • OCTANT_LOCAL_CONTENT - set to a directory and dash will serve content responses from here. An example directory lives in examples/content
  • OCTANT_PLUGIN_PATH - add a plugin directory or multiple directories separated by :. Plugins will load by default from $HOME/.config/octant/plugins

Note: If using fish shell, tilde expansion may not occur when using env to set environment variables.

Command Line Flags

Octant is configurable through command line flags set at runtime. You can see all of the available options by running octant --help.

    --client-burst int     maximum burst for client throttle (default 400)
    --client-qps float32   maximum QPS for client (default 200)
    --context string       initial context
-c, --enable-opencensus    enable open census
-h, --help                 help for octant
    --klog-verbosity int   klog verbosity level
    --kubeconfig string    absolute path to kubeConfig file (default "~/.kube/config")
-n, --namespace string     initial namespace
    --ui-url string        dashboard url

The verbosity has a special type that is used to parse the flag, which means it can be provided shorthand by just adding more v to equal the level count or with an explicit equal sign.

-v[vv], --verbosity=count      verbosity level

For example

$ octant -vvv

Is equal to

$ octant --verbosity=3

Setting Up a Development Environment

These build tools can be installed via Makefile with make go-install.

A development binary can be built by make octant-dev.

For UI changes, see the README located in web/.

If Docker and Drone are installed, tests and build steps can run in a containerized environment.

e2e Testing

Cypress will load the dashboard from port 7777. Navigate to web/ then install the Cypress binary npm install cypress --save-dev.

Run the test from the command line with the option of specifying a browser or electron:

$(npm bin)/cypress run -b chrome

Starts the interactive launcher to load tests in /cypress.

$(npm bin)/cypress open