Merge pull request #32 from shiroyasha/installation-steps-linux

Example installation steps on Linux

Formula/kubectx.rb

@@ -1,26 +0,0 @@
-class Kubectx < Formula
-  desc "Tool that can switch between kubectl contexts easily and create aliases"
-  homepage "https://github.com/ahmetb/kubectx"
-  url "https://github.com/ahmetb/kubectx/archive/v0.3.0.tar.gz"
-  sha256 "720b6d9a960a7583983ac84c90d2ff89f4494584cf82a3abb5d4e66e72444621"
-  head "https://github.com/ahmetb/kubectx.git", :branch => "short-names"
-  bottle :unneeded
-
-  option "with-short-names", "link as \"kctx\" and \"kns\" instead"
-
-  def install
-    bin.install "kubectx" => build.with?("short-names") ? "kctx" : "kubectx"
-    bin.install "kubens" => build.with?("short-names") ? "kns" : "kubens"
-    include.install "utils.bash"
-
-    bash_completion.install "completion/kubectx.bash" => "kubectx"
-    bash_completion.install "completion/kubens.bash" => "kubens"
-    zsh_completion.install "completion/kubectx.zsh" => "_kubectx"
-    zsh_completion.install "completion/kubens.zsh" => "_kubens"
-  end
-
-  test do
-    system "which", build.with?("short-names") ? "kctx" : "kubectx"
-    system "which", build.with?("short-names") ? "kns" : "kubens"
-  end
-end

README.md

@@ -1,6 +1,11 @@
-This repository provides both `kubectx` and `kubens` tools. Purpose of this
-project is to provide an utility and facilitate discussion about how `kubectl`
-can manage contexts better.
+This repository provides both `kubectx` and `kubens` tools.
+
+
+**`kubectx`** help you switch between clusters back and forth:
+![kubectx demo GIF](img/kubectx-demo.gif)
+
+**`kubens`** help you switch between Kubernetes namespaces smoothly:
+![kubens demo GIF](img/kubens-demo.gif)
 
 # kubectx(1)
 
@@ -9,15 +14,12 @@ kubectx is an utility to manage and switch between kubectl(1) contexts.
 ```
 USAGE:
   kubectx                   : list the contexts
-  kubectx <NAME>            : switch to context
+  kubectx <NAME>            : switch to context <NAME>
   kubectx -                 : switch to the previous context
-  kubectx <NEW_NAME>=<NAME> : create alias for context
+  kubectx <NEW_NAME>=<NAME> : rename context <NAME> to <NEW_NAME>
   kubectx -h,--help         : show this message
 ```
 
-Purpose of this project is to provide an utility and facilitate discussion
-about how `kubectl` can manage contexts better.
-
 ### Usage
 
 ```sh
@@ -35,7 +37,7 @@ Context "dublin" set.
 Aliased "gke_ahmetb_europe-west1-b_dublin" as "dublin".
 ```
 
-`kubectx` supports <kbd>Tab</kbd> completion on bash/zsh shells to help with 
+`kubectx` supports <kbd>Tab</kbd> completion on bash/zsh/fish shells to help with
 long context names. You don't have to remember full context names anymore.
 
 -----
@@ -65,28 +67,70 @@ Context "test" set.
 Active namespace is "default".
 ```
 
-`kubens` also supports <kbd>Tab</kbd> completion on bash/zsh shells.
+`kubens` also supports <kbd>Tab</kbd> completion on bash/zsh/fish shells.
 
 -----
 
 ## Installation
 
-**For macOS:**
+**macOS:**
 
-> Use [Homebrew](https://brew.sh/) package manager:
->
->      brew tap ahmetb/kubectx https://github.com/ahmetb/kubectx.git
->      brew install kubectx
-> this will also set up bash/zsh completion scripts automatically.
+:confetti_ball: Use the [Homebrew](https://brew.sh/) package manager:
 
-Running `brew install` with `--with-short-names` will install tools with names
+    brew install kubectx
+
+This command will set up bash/zsh/fish completion scripts automatically.
+
+
+- Running `brew install` with `--with-short-names` will install tools with names
 `kctx` and `kns` to prevent prefix collision with `kubectl` name.
 
-**Other platforms:**
+- If you like to add context/namespace info to your shell prompt (`$PS1`),
+  I recommend trying out [kube-ps1](https://github.com/jonmosco/kube-ps1).
 
-> Download the `kubectx` script, make it executable and add it to your PATH. You
-> can also install bash/zsh [completion scripts](completion/) manually.
+**Linux:**
+
+Since `kubectx`/`kubens` are written in Bash, you should be able to instal
+them to any POSIX environment that has Bash installed.
+
+- Download the `kubectx`, and `kubens` scripts.
+- Either:
+  - save them all to somewhere in your `PATH`,
+  - or save them to a directory, then create symlinks to `kubectx`/`kubens` from
+    somewhere in your `PATH`, like `/usr/local/bin`
+- Make `kubectx` and `kubens` executable (`chmod +x ...`)
+- Figure out how to install bash/zsh/fish [completion scripts](completion/).
+
+Example installation steps:
+
+``` bash
+sudo git clone https://github.com/ahmetb/kubectx /opt/kubectx
+sudo ln -s /opt/kubectx/kubectx /usr/local/bin/kubectx
+sudo ln -s /opt/kubectx/kubens /usr/local/bin/kubens
+```
+
+-----
+
+####  Users
+
+| What are others saying about kubectx? |
+| ---- |
+| _“Thank you for kubectx & kubens - I use them all the time & have them in my k8s toolset to maintain happiness :) ”_ – [@pbouwer](https://twitter.com/pbouwer/status/925896377929949184) |
+| _“I can't imagine working without kubectx and especially kubens anymore. It's pure gold.”_ – [@timoreimann](https://twitter.com/timoreimann/status/925801946757419008) |
+| _“I'm liking kubectx from @ahmetb, makes it super-easy to switch #Kubernetes contexts [...]”_ &mdash; [@lizrice](https://twitter.com/lizrice/status/928556415517589505) |
+| _“Also using it on a daily basis. This and my zsh config that shows me the current k8s context 😉”_ – [@puja108](https://twitter.com/puja108/status/928742521139810305) |
+| _“Lately I've found myself using the kubens command more than kubectx. Both very useful though :-)”_ – [@stuartleeks](https://twitter.com/stuartleeks/status/928562850464907264) |
+| _“yeah kubens rocks!”_ – [@embano1](https://twitter.com/embano1/status/928698440732815360) |
+| _“Special thanks to Ahmet Alp Balkan for creating kubectx, kubens, and kubectl aliases, as these tools made my life better.”_ – [@strebeld](https://medium.com/@strebeld/5-ways-to-enhance-kubectl-ux-97c8893227a)
+
+> If you liked `kubectx`, you may like my [`kubectl-aliases`](https://github.com/ahmetb/kubectl-aliases) project, too.
 
 -----
 
 Disclaimer: This is not an official Google product.
+
+
+#### Stargazers over time
+
+[![Stargazers over time](https://starcharts.herokuapp.com/ahmetb/kubectx.svg)](https://starcharts.herokuapp.com/ahmetb/kubectx)
+

completion/kubectx.fish

@@ -0,0 +1,3 @@
+# kubectx
+complete -f -c kubectx -a "- (kubectl config get-contexts --output='name')"
+

completion/kubectx.zsh

@@ -5,7 +5,7 @@ PREV=""
 if [ -f "$KUBECTX" ]; then
     # show '-' only if there's a saved previous context
     local PREV=$(cat "${KUBECTX}")
-    _arguments "1: :((-\:Back\ to\ ${PREV} \
+    _arguments "1: :((- \
         $(kubectl config get-contexts --output='name')))"
 else
     _arguments "1: :($(kubectl config get-contexts --output='name'))"

completion/kubens.fish

@@ -0,0 +1,3 @@
+# kubens
+complete -f -c kubens -a "(kubectl get ns -o=custom-columns=NAME:.metadata.name --no-headers)"
+

kubectx

@@ -21,29 +21,28 @@
 set -eou pipefail
 IFS=$'\n\t'
 
-SCRIPT_DIR="$(dirname "$( readlink -f "${0}" 2>/dev/null || \
-  python -c "import os,sys; print(os.path.realpath(sys.argv[1]))" "${0}" )")"
-
-if [[ -f "${SCRIPT_DIR}/utils.bash" ]]; then
-  source "${SCRIPT_DIR}/utils.bash"
-else
-  source "${SCRIPT_DIR}/../include/utils.bash"
-fi
-
 KUBECTX="${HOME}/.kube/kubectx"
 
 usage() {
   cat <<"EOF"
 USAGE:
   kubectx                   : list the contexts
-  kubectx <NAME>            : switch to context
+  kubectx <NAME>            : switch to context <NAME>
   kubectx -                 : switch to the previous context
-  kubectx <NEW_NAME>=<NAME> : create alias for context
+  kubectx <NEW_NAME>=<NAME> : rename context <NAME> to <NEW_NAME>
   kubectx -h,--help         : show this message
 EOF
   exit 1
 }
 
+current_context() {
+  kubectl config view -o=jsonpath='{.current-context}'
+}
+
+get_contexts() {
+  kubectl config get-contexts -o=name | sort -n
+}
+
 list_contexts() {
   set -u pipefail
   local cur="$(current_context)"
@@ -107,7 +106,7 @@ cluster_of_context() {
     -o=jsonpath="{.contexts[?(@.name==\"${1}\")].context.cluster}"
 }
 
-alias_context() {
+rename_context() {
   local old_name="${1}"
   local new_name="${2}"
 
@@ -119,11 +118,7 @@ alias_context() {
     exit 1
   fi
 
-  kubectl config set-context "${new_name}" \
-    --cluster="${old_cluster}" \
-    --user="${old_user}" \
-
-  echo "Aliased \"${old_name}\" as \"${new_name}\"." >&2
+  kubectl config rename-context "${old_name}" "${new_name}"
 }
 
 main() {
@@ -141,7 +136,7 @@ main() {
       echo "error: unrecognized flag \"${1}\"" >&2
       usage
     elif [[ "${1}" =~ (.+)=(.+) ]]; then
-      alias_context "${BASH_REMATCH[2]}" "${BASH_REMATCH[1]}"
+      rename_context "${BASH_REMATCH[2]}" "${BASH_REMATCH[1]}"
     else
       set_context "${1}"
     fi

kubens

@@ -21,15 +21,6 @@
 set -eou pipefail
 IFS=$'\n\t'
 
-SCRIPT_DIR="$(dirname "$( readlink -f "${0}" 2>/dev/null || \
-  python -c "import os,sys; print(os.path.realpath(sys.argv[1]))" "${0}" )")"
-
-if [[ -f "${SCRIPT_DIR}/utils.bash" ]]; then
-  source "${SCRIPT_DIR}/utils.bash"
-else
-  source "${SCRIPT_DIR}/../include/utils.bash"
-fi
-
 KUBENS_DIR="${HOME}/.kube/kubens"
 
 usage() {
@@ -53,6 +44,14 @@ current_namespace() {
   fi
 }
 
+current_context() {
+  kubectl config view -o=jsonpath='{.current-context}'
+}
+
+get_namespaces() {
+  kubectl get namespaces -o=jsonpath='{range .items[*].metadata.name}{@}{"\n"}{end}'
+}
+
 namespace_file() {
   local ctx="${1}"
   echo "${KUBENS_DIR}/${ctx}"

utils.bash

@@ -1,11 +0,0 @@
-current_context() {
-  kubectl config view -o=jsonpath='{.current-context}'
-}
-
-get_contexts() {
-  kubectl config get-contexts -o=name | sort -n
-}
-
-get_namespaces() {
-  kubectl get namespaces -o=jsonpath='{range .items[*].metadata.name}{@}{"\n"}{end}'
-}