Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.66 KB

README.md

File metadata and controls

62 lines (43 loc) · 1.66 KB
Raw

KinoK8s

A Livebook Kino for learning to use the k8s Elixir library.

Module Version Last Updated

Hex Docs Total Download License

Installation

Install the latest 1.x version:

Mix.install([{:kino_k8s, "~> 1.0"}])

To install the latest from main branch:

Mix.install([{:kino_k8s, github: "mruoss/kino_k8s"}])

Smart Cells

kino_k8s brings the following Smart Cells to your Livebook:

  • Cluster Connection - Connect to a Kubernetes Cluster
  • Get / List / Watch Resources
  • Create / Update / Apply Resource - Modify resources in your cluster
  • Connect to Pod (Exec/Logs) - Renders a terminal using xterm.js (Formerly kino_k8s_term).

The smart cells require a connection to a Kubernetes Cluster in form of a %K8s.Conn{} object. To add such a connection to your Livebook, you can add the Cluster Connection smart cell before adding any other smart cells.

Development

Build and Watch Javascript and CSS

cd assets
npm install
npm run dev

Install and run livebook

mix escript.install hex livebook
livebook server ./dev.livemd

Build Assets

cd assets
npm install
npm run build