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.1.tar.gz"
-  sha256 "4e995f5bec6f41c8d5b6e77f413a58ead077816348e72de26dde3655ec2b7d0b"
-  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

@@ -37,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.
 
 -----
@@ -67,35 +67,63 @@ 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:**
 
-:tada: kubectx is now in Homebrew! :confetti_ball:
+:confetti_ball: Use the [Homebrew](https://brew.sh/) package manager:
 
-> Use the [Homebrew](https://brew.sh/) package manager:
->
->     brew install kubectx
->
-> this will also set up bash/zsh completion scripts automatically.
+    brew install kubectx
 
-Running `brew install` with `--with-short-names` will install tools with names
+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.
 
-> Note: If you installed kubectx before it was accepted to Homebrew core
-> repository, reinstall with:
-> `brew untap ahmetb/kubectx && brew uninstall --force kubectx && brew update && brew install kubectx`
+- 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).
 
-**Other platforms:**
+**Linux:**
 
-- Download the `kubectx` script
-- Add it somewhere in your PATH
-- Make it executable (`chmod +x`)
-- You can also install bash/zsh [completion scripts](completion/) manually.
+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.
 
 -----
 

completion/kubectx.fish

@@ -0,0 +1,3 @@
+# kubectx
+complete -f -c kubectx -a "- (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,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
-
 KUBECTX="${HOME}/.kube/kubectx"
 
 usage() {
@@ -44,6 +35,14 @@ 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)"

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}'
-}