Skip to content

Latest commit

 

History

History
112 lines (94 loc) · 3.92 KB

README.md

File metadata and controls

112 lines (94 loc) · 3.92 KB
Raw

Kubeswap

Tool to manage multiple kubeconfig files and swap between clusters easily

Why kubeswap

If you interact with a lot of kubernetes clusters/contexts, and you dont want to manage it in a big single kubeconfig file (merging kubeconfigs is tedious...), this is the right tool for you!

Just throw your kubeconfig files inside $HOME/.kube/, and kubeswap will manage it for you.

Basic usage

Basically, you will use 2 commands:

  • kubeswap: scans your $HOME/.kube dir and shows you a pretty interactive list to choose the desired kubeconfig

  • kubeswap <name>: directly select the kubeconfig with that name from your $HOME/.kube/ dir

  • Extra: kubeswap none will remove the current kubeconfig.

Advanced usage

Besides the basic usage, kubeswap has a key-value store, so you can:

  • Add/delete kubeconfigs to/from the db
  • List the kubeconfigs stored
  • Select one to use
  • Much more... (not really)

I have implemented the store with 2 objectives:

  • Portability: you can use this db to store all your kubeconfigs and carry them with you
  • Backup/Restore: you can use the db to backup/restore the kubeconfigs

To use the store, check the help :)

Help

  ██   ██ ██    ██ ██████  ███████ ███████ ██     ██  █████  ██████  
  ██  ██  ██    ██ ██   ██ ██      ██      ██     ██ ██   ██ ██   ██ 
  █████   ██    ██ ██████  █████   ███████ ██  █  ██ ███████ ██████  
  ██  ██  ██    ██ ██   ██ ██           ██ ██ ███ ██ ██   ██ ██      
  ██   ██  ██████  ██████  ███████ ███████  ███ ███  ██   ██ ██

Manage your kubeconfig files easily

Usage:
  kubeswap [flags]
  kubeswap [command]

Available Commands:
  add         Adds a new kubeconfig to the database
  completion  Generate the autocompletion script for the specified shell
  delete      Deletes a kubeconfig from the database
  help        Help about any command
  list        Lists all the kubeconfigs in the db
  print       Prints the content of the kubeconfig referenced by <name>
  printall    Prints the content of all the kubeconfigs from the db
  sync        Removes the current db file and recreates it with all the $HOME/.kube kubeconfigs
  use         Select kubeconfig to use
  version     Print the version number

Flags:
      --db string         db path (default "$HOME/.kube/kubeswap.db")
  -h, --help              help for kubeswap
      --loglevel string   loglevel (info/debug) (default "info")

Use "kubeswap [command] --help" for more information about a command.

Tips

Use some shell/program that shows you your current k8s cluster/context.

Quickstart

Basic (without store):

  • Interactive list:
kubeswap
  • Select one kubeconfig from your $HOME/.kube/ directory:
kubeswap <filename>

Advanced (with store):

  • add:
kubeswap add --name test --kubeconfig test/kubeconfig.yml --db /tmp/kubeswap.db
  • list:
kubeswap list --db /tmp/kubeswap.db
  • print:
kubeswap print -n test --db /tmp/kubeswap.db
  • printall:
kubeswap printall --db /tmp/kubeswap.db
  • use:
kubeswap use -n test --db /tmp/kubeswap.db
  • delete:
kubeswap delete -n test --db /tmp/kubeswap.db

TODO

  • If the file to check is a folder just skip it
  • Test in windows & mac
  • status command:
    • status: checks if the clusters referenced by each kubeconfig are reachable
      • -n <name>: checks if the cluster of <name> kubeconfig is reachable
  • Compress the db into a single file, to enable
    • simplicity: the user has a single file with all the database, not a directory
    • backup/restore: easier to backup, restore or move between machines