kubert

command module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2024 License: MIT Imports: 1 Imported by: 0

README

kubert

A kubectx/kubens alternative inspired by kubie. kubert is a tool that allows you to switch between Kubernetes contexts and namespaces within an isolated shell. That way, you can have multiple shells open, each with a different context and namespace.

kubert also has a wrapper for kubectl (kubert kubectl) to enable you to protect contexts to prevent accidentally running certain kubectl commands in the wrong context. Checkout the Protecting contexts section for more information.

Installation

Homebrew
brew install idebeijer/tap/kubert

Usage

Switching contexts

To switch to a different context, run:

kubert ctx <context-name>

You can also print out a list of available contexts by running, or if fzf is installed, you can select a context from a list:

kubert ctx
Switching namespaces

To switch to a different namespace, run:

kubert ns <namespace-name>

You can also print out a list of available namespaces by running, or if fzf is installed, you can select a namespace from a list:

kubert ns
Protecting contexts

Kubert can be configured to protect certain contexts, to prevent you from accidentally running certain kubectl commands in the wrong context. This will only work when using kubectl through the kubert kubectl command, it will not work when using kubectl directly.

To protect a context, you can either set a regex pattern in the Kubert config file, or you can explicitly protect a context. When a context is protected, you will be prompted to confirm that you want to run a protected kubectl command in that context.

Context protection using a regex pattern

To protect a context using a regex pattern, you need to set the protectedByDefaultRegexp in the Kubert config file. The following example will protect all contexts that contain prd or prod in their name:

contexts:
    protectedByDefaultRegexp: "(prd|prod)"

By default, kubert has set this setting to null, which means that no contexts are protected by default. If you provide an empty string as pattern "", all contexts will be protected by default.

The default regex pattern will be ignored for contexts that have an explicit protection set.

Setting an explicit protect/unprotect

Instead of using a regex pattern, you can also explicitly protect the current context. When using an explicit protect or unprotect, Kubert will save this in a state file, and the default regex pattern will be ignored for this context.

To tell Kubert to protect the current context, run:

kubert context-protection protect

To tell Kubert to explicitly unprotect the current context, run:

kubert context-protection unprotect

The above commands will set an explicit protection for the current context. This means that the context will be (un)protected even if it matches the regex pattern or not. To delete the explicit protection, run:

kubert context-protection delete

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
fzf

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL