Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/yhlooo/zsh-kubeconfig-mgr

A plugin for Zsh and oh-my-zsh, Designed to make managing and using multiple kubeconfig files easier. 一个 zsh 和 oh-my-zsh 的插件，旨在更便捷地管理和使用多个 kubeconfig 文件
https://github.com/yhlooo/zsh-kubeconfig-mgr

kubernetes oh-my-zsh oh-my-zsh-plugin zsh

Last synced: about 1 month ago
JSON representation

A plugin for Zsh and oh-my-zsh, Designed to make managing and using multiple kubeconfig files easier. 一个 zsh 和 oh-my-zsh 的插件，旨在更便捷地管理和使用多个 kubeconfig 文件

Host: GitHub
URL: https://github.com/yhlooo/zsh-kubeconfig-mgr
Owner: yhlooo
License: mit
Created: 2022-07-16T03:45:24.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2023-12-09T13:29:54.000Z (6 months ago)
Last Synced: 2024-01-23T21:43:44.748Z (4 months ago)
Topics: kubernetes, oh-my-zsh, oh-my-zsh-plugin, zsh
Language: Shell
Homepage:
Size: 1.15 MB
Stars: 6
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-zsh-plugins - kubeconfig-mgr - Makes managing multiple kubeconfig files easier. (Plugins / ZSH on Windows)
fucking-awesome-zsh-plugins - kubeconfig-mgr - Makes managing multiple kubeconfig files easier. (Plugins / ZSH on Windows)

README

        English | [简体中文](README_CN.md)

# zsh-kubeconfig-mgr

[![License](https://img.shields.io/github/license/yhlooo/zsh-kubeconfig-mgr)](LICENSE)

> This project is a plugin for [Zsh](https://www.zsh.org/) and [oh-my-zsh](https://ohmyz.sh/), Designed to make managing and using multiple kubeconfig files easier.

In some cases, it may be necessary to operate multiple different [Kubernetes](https://kubernetes.io/) clusters, each with different credentials. And it might not be convenient to combine them into one kubeconfig file for various reasons. Therefore, when operating different clusters, you must frequently set the environment variable `$KUBECONFIG` to different values, or use the parameter `--kubeconfig /path/to/config ...` to specify different kubeconfig files when executing `kubectl`, these operations are very tedious and error-prone.

This project will provide an idea to solve these problems.

## Installation

### 1 Install Plugin

**Oh-my-zsh:**

If you have installed [oh-my-zsh](https://ohmyz.sh/), then:

1. Clone this repository in oh-my-zsh's plugins directory:

   ```sh

   git clone https://github.com/yhlooo/zsh-kubeconfig-mgr.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-kubeconfig-mgr

   ```

2. Activate the plugin in `~/.zshrc` :

   ```zsh

   plugins=( [plugins...] zsh-kubeconfig-mgr)

   ```

3. Restart zsh (such as by opening a new instance of your terminal emulator).

**Zsh:**

If you don't have oh-my-zsh installed, you can simply clone this repository and source the script:

```sh

git clone https://github.com/keybrl/zsh-kubeconfig-mgr.git

source ./zsh-kubeconfig-mgr/zsh-kubeconfig-mgr.zsh

echo "source ${(q-)PWD}/zsh-kubeconfig-mgr/zsh-kubeconfig-mgr.zsh" >> ${ZDOTDIR:-$HOME}/.zshrc

```

### 2 Set command line prompt

The plugin provides a command line prompt which can be added to the variable `PROMPT` or `RPROMPT` as you need

Simply add something like the following to the end of `~/.zshrc` :

```zsh

PROMPT='$(kubeconfig_prompt_info) '$PROMPT

```

## Usage

### Command line prompt

The function `kubeconfig_prompt_info` will print the kubeconfig specified by the current environment variable `$KUBECONFIG` . Its value has the following situations:

- `` means `$KUBECONFIG` is empty, the active kubeconfig is  `~/.kube/config`

- `config` means `~/.kube/configs/config`

- `./path/to/config` indicates the relative path to kubeconfig

- `~/path/to/config` indicates the path of the kubeconfig relative to `$HOME`

- `/path/to/config` indicates the absolute path of kubeconfig

The printed color indicates whether the corresponding kubeconfig exists or not:

- Green: Exist

- Red: Not exist or not a file

Example:

Add the following to the end of `~/.zshrc` :

```zsh

PROMPT='$(kubeconfig_prompt_info) '$PROMPT

```

Effect:

![prompt_info](docs/images/prompt_info.png)

### List kubeconfig

`kcmgr ls` , `kcmgr list` or `lkc` (**l**ist **k**ube**c**onfig)

list all filenames in the directory `~/.kube/configs/`

![kcmgr_ls](docs/images/kcmgr_ls.png)

### Show the content of kubeconfig

`kcmgr show [config]` or `rkc [config]` (**r**ead **k**ube**c**onfig)

- `kcmgr show` Show the content of the currently effective kubeconfig

- `kcmgr show ` Show the content of the specified kubeconfig

![kcmgr_show](docs/images/kcmgr_show.png)

### Set kubeconfig

`kcmgr set [config]` or `skc [config]` (**s**et **k**ube**c**onfig)

- `kcmgr set` equivalent to `unset KUBECONFIG`

- `kcmgr set ` set `$KUBECONFIG` to the specified kubeconfig

![kcmgr_set](docs/images/kcmgr_set.png)

### Delete kubeconfig

`kcmgr delete [config]` , `kcmgr del [config]` or `dkc [config]` (**d**elete **k**ube**c**onfig)

- `kcmgr delete` Delete the currently effective kubeconfig

- `kcmgr delete ` Delete the specified kubeconfig

![kcmgr_del](docs/images/kcmgr_del.png)

### Edit / Add kubeconfig

`kcmgr edit [config]` or `ekc [config]` (**e**dit **k**ube**c**onfig)

- `kcmgr edit` Edit the currently effective kubeconfig

- `kcmgr edit ` Edit the specified kubeconfig

Prefer `vim` , or `vi` if `vim` not found. If kubeconfig does not exist it will be created.

![kcmgr_edit](docs/images/kcmgr_edit.gif)