https://github.com/corneliusweig/konfig
konfig helps to merge, split or import kubeconfig files
https://github.com/corneliusweig/konfig
config kubeconfig kubectl kubectl-plugin kubectl-plugins kubernetes merge
Last synced: 11 months ago
JSON representation
konfig helps to merge, split or import kubeconfig files
- Host: GitHub
- URL: https://github.com/corneliusweig/konfig
- Owner: corneliusweig
- License: apache-2.0
- Created: 2019-03-30T21:38:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-30T06:25:55.000Z (over 3 years ago)
- Last Synced: 2025-03-30T08:12:29.231Z (11 months ago)
- Topics: config, kubeconfig, kubectl, kubectl-plugin, kubectl-plugins, kubernetes, merge
- Language: Shell
- Homepage:
- Size: 62.5 KB
- Stars: 365
- Watchers: 5
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kubectl-plugins - konfig
- awesome-starred - corneliusweig/konfig - konfig helps to merge, split or import kubeconfig files (config)
- awesomeness - kconfig - konfig helps to merge, split or import kubeconfig files (Containers / Kubernetes)
README
# konfig
konfig helps to merge, split or import kubeconfig files
## Usage
### Import a kubeconfig
```bash
konfig import --save new-cfg
```
Imports the config file `new-cfg` into the default kubeconfig at `~/.kube/config`.
To show the result without changing your kubeconfig, do
```bash
konfig import new-cfg
```
CAVEAT: due to how shells work, the following will lose your current `~/.kube/config`
```bash
# WRONG, don't do this!
konfig import new-cfg > ~/.kube/config
```
### Merge several kubeconfig files
```bash
konfig merge config1 config2 > merged-config
```
This variant creates a self-contained kubeconfig where all credentials are stored inline in the kubeconfig.
If you want to preserve the structure and keep credentials separate, use `--preserve-structure`.
### Extract a minimal kubeconfig for one or several contexts
This will extract a minimal kubeconfig with a single context `minikube`:
```bash
# extract context minikube from the default kubeconfig
konfig export minikube > minikube.config
# extract context minikube and docker-for-desktop from two input configs
konfig export minikube docker-for-desktop -k ~/.kube/other,~/dockercfg > local
```
## Installation
There are several ways to install `konfig`.
The recommended installation method is via `krew`.
### Via krew
Krew is the `kubectl` plugin manager. If you have not yet installed `krew`, get it at
[https://github.com/kubernetes-sigs/krew](https://github.com/kubernetes-sigs/krew).
Then installation is as simple as
```bash
kubectl krew install konfig
```
The plugin will be available as `kubectl konfig`, see [doc/USAGE](doc/USAGE.md) for further details. You could also define an alias as well: `alias konfig = 'kubectl konfig'`
### Manual
When using the binaries for installation, also have a look at [USAGE](#Usage).
#### OSX & Linux
```bash
curl -Lo konfig https://github.com/corneliusweig/konfig/raw/v0.2.6/konfig \
&& chmod +x konfig \
&& sudo mv -i konfig /usr/local/bin
```
Feel free to change the `sudo mv` to put `konfig` in some other location from your `$PATH` variable.
#### Windows
> If you figure out how to run `konfig` on Windows, please send a PR with instructions.