Generate aliases

.gitignore

@@ -0,0 +1 @@
+generate/bin

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Danny Burt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,114 +1,237 @@
 # kube-aliases
 
-This is an oh-my-zsh plugin (or source `kube-aliases.plugin.zsh` for bash) to
-make working with kubernetes easier. It provides a bunch of bash aliases and
-zsh functions. Docs can be found
-[here](https://github.com/Dbz/kube-aliases/blob/master/docs/usage), which
-clarifies all aliases.
+kube-aliases comes with a comprehensive set of aliases for Kubernetes. If
+desired, there is a utility tool to generate custom aliases or to change the
+aliases automatically. For example, if you prefer `rm` to `del` for deleting.
+
+- [kube-aliases](#kube-aliases)
+- [Usage](#usage)
+  * [General Alias Rules](#general-alias-rules)
+  * [Generating Aliases](#generating-aliases)
+    + [Customizing Aliases Yaml](#customizing-aliases-yaml)
+      - [resources](#resources)
+      - [cmds](#cmds)
+      - [additional](#additional)
+- [Installation](#installation)
+  * [Bash Example](#bash-example)
+  * [Zsh Example](#zsh-example)
+  * [Generate Aliases](#generate-aliases)
+  * [AUR](#aur)
+
+
+# Usage
+
+## General Alias Rules
+
+Aliases follow the following conventions:
 
-## Usage
+```bash
+k             # kubectl
+kc<r>         # kubectl create <resource>, e.g. kcd for kubectl create deployment
+kdel<r>       # kubectl delete <resource>, e.g. kdelp for kubectl delete pods
+kd<r>         # kubectl describe <resource>, e.g. kdp for kubectl describe pod
+kg<r>         # kubectl get <resource>, e.g. kgp for kubectl get pods
+kg<r>g        # kubectl get <resource> -o wide | grep, e.g. kgpg for kubectl get pods -o wide | grep
+kga<r>        # kubectl get --all-namespaces -o wide <resource>, e.g. kgap for kubectl --all-namespaces -o wide get pods
+kga<r>g       # kubectl get --all-namespaces -o wide <resource> | grep, e.g. kgap for kubectl --all-namespaces -o wide get pods | grep
+kgy<r>        # kubectl get <resource> -o yaml, e.g. kgyp for kubectl get pods -o yaml
+ke<r>         # kubectl edit <resource>, e.g. kep for kubectl edit pods
+wkg<resource> # watch kubectl get <resource>, e.g. wkgp for watch kubectl get pods
+wkga<r>       # watch kubectl get --all-namespaces -o wide <resource>, e.g. wkgap for watch kubectl --all-namespaces -o wide get pods
+
+# Get all names of a resource
+kg<r>n       # kubectl get <resource> -o go-template --template '{{range .items}}{{.metadata.name}}{{\" \"}}{{end}}'", e.g. kgpn for kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{\" \"}}{{end}}'"
+```
+
+## Generating Aliases
+
+Want to generate custom aliases? [Install](#generate-aliases) the latest `generate-kube-aliases`
+from releases. Then grab a copy of the default `aliases.yaml` with
+
+```bash
+curl https://raw.githubusercontent.com/Dbz/kube-aliases/master/aliases.yaml -o ${HOME}/aliases.yaml
+```
+
+Modify `aliases.yaml` to make any desired changes and generate the aliases with
+```bash
+generate-kube-aliases aliases.yaml ~/.kube-aliases
+```
 
-There are a few main features of this plugin. First, there are lots of aliases
-to make working with Kubernetes easier. Second, there are bash functions to
-help with varies tasks such as switching contexts to use different clusters.
+and then source it in the `.bashrc` or `.zshrc` file.
 
-### Aliases
+```bash
+echo "source ${HOME}/.kube-aliases" >> .bashrc
+```
+
+Or following the same steps, one can create a smaller list of only additional
+content. For example in an `additonal.yaml` file
+
+```yaml
+resources:
+  customresourcefoo:
+    short: crf
+
+cmds:
+  - short: g
+    cmd: get
+```
 
-To see a full list of aliases, use
+and 
 
 ```bash
-khelp usage
+generate-kube-aliases additional.yaml ~/.kube-aliases-additional
+echo "source ${HOME}/.additional.yaml" >> .bashrc
 ```
 
-In general and when it makes sense, aliases follow the following conventions.
+would generate the `.kube-aliases-additional` file with content
 
 ```bash
-k           # kubectl
-kd<r>       # kubectl delete <resource>, e.g. kgp for kubectl delete pods
-kds<r>      # kubectl describe <resource>, e.g. kdsp for kubectl describe pod
-ke<r>       # kubectl edit <resource>, e.g. kgp for kubectl edit pods
-kg<r>       # kubectl get <resource>, e.g. kgp for kubectl get pods
-kga<r>      # kubectl get --all-namespaces -o wide <resource>, e.g. kgap for kubectl --all-namespaces -o wide get pods
-kl          # kubectl logs <podname>
-klf         # kubectl logs -f <podname>: i.e. watch logs live
+alias kgcrf="kubectl get customresourcefoo"
+```
+
+### Customizing Aliases Yaml
+
+An example small `alias.yaml` file
+
+```yaml
+# Kubernetes Resources
+resources:
+  pods:
+    short: p
+
+# Commands to add to all resources
+cmds:
+  - short: g
+    cmd: get
+
+# Any other aliases to be generated
+additional:
+  - short: wkgp
+    cmd: "watch kubectl get pods"
+    comment: "Extra pod commands."
 ```
 
-There is also some other useful commands such as the following:
+Which will generate the following file
 
 ```bash
-kcon       # create configuration files
-kdap       # delete all pods within a namespace
-kdrain     # drain a node
-kexec      # execute a command in a specified pod,
-           # default drops user into a shell
-kfind      # use a regular expression to find items across everything except
-           # custom resources
-kgpns      # Get just pod names in a namespace
-kpfind     # Search through pods with regular expressions
-krd        # restart a deployment
-kstatus    # search across namespaces to find pods statuses
+# Manage pods.
+alias kgp="kubectl get pods"
+
+# Extra pod commands.
+alias wkgp="watch kubectl get pods"
+```
+
+
+
+#### resources
+
+Resources defines Kubernetes resources and what the short letter representation
+should be.
+
+```yaml
+resources:
+  <resource>:
+    short: <short name>
+```
+
+For example
+
+```yaml
+resources:
+  pods:
+    short: p
 ```
 
-For a more detailed list of aliases, view the [docs](https://github.com/Dbz/kube-aliases/blob/master/docs/usage).
+Which will generate aliases `alias k<cmd>p=kubectl <cmd> pod`.
 
-Not everything is currently implemented, but more and more is being added to
-the list. If something is missing that is desired, feel free to submit a pull
-request.
+####  cmds
 
+The cmd block will generate commands on all resources.
 
-## Installation
+```yaml
+cmd:
+  - short: <short name>
+    cmd: <cmd>
+    # Optional
+    prefix:
+      short: <short name>
+      cmd: <cmd>
+    # Optional
+    suffix:
+      short: <short name>
+      cmd: <cmd>
+```
 
-### Oh-My-Zsh
+For example:
 
+```yaml
+cmd:
+  - short: g
+    cmd: get
 ```
-git clone [email protected]:Dbz/kube-aliases.git ~/.oh-my-zsh/custom/plugins/kube-aliases
-echo "plugins+=(kube-aliases)" >> ~/.zshrc
+
+Will generate aliases for get commands for each specified resource in the
+format `alias kg<resource>=kubectl get <resource>`.  An example with the `pod`
+resource is `alias kgp=kubectl get pod`.  Prefix and suffix will generate
+commands before and after the alias respectively.
+
+Here is an example cmd prefix that will generate `alias wkg<resource short>=watch kubectl get <resource>`:
+
+```yaml
+  - short: g
+    cmd: get
+    prefix:
+      short: w
+      cmd: watch
 ```
 
-You can also manually place `zsh-kuberenetes` inside of `plugins=(...)`
 
-If you have set the `ZSH_CUSTOM` environment variable in your zshrc, then you should modify the git clone directory to be `$ZSH_CUSTOM/plugins/kube-aliases`.
+#### additional
 
-### Antigen
+Any other aliases can be generated by the following
 
-Add `antigen bundle dbz/kube-aliases` to your antigen bundles in your `.zshrc`
+```yaml
+additional:
+  - short: <short>
+    cmd: <cmd>
+    comment: <comment>
+```
 
-### Zgen
+The following is an example we using to generate `alias krd="kubectl rollout restart deployment"`
 
-Add `zgen load dbz/kube-aliases` to your zgen plugins in your `.zshrc`
+```yaml
+additional:
+  - short: krd
+    cmd: "kubectl rollout restart deployment"
+    comment: "Modifying deployments."
+```
 
-### Bash
+All commands with the same comment will be grouped together in the generated file under the same comment.
 
-Source `kube-aliases.plugin.zsh` in your `.bashrc`.
+# Installation
 
-### Aliases for Kubernetes Extensions
+To grab a bunch of aliases without customization get the
+`aliases` file and source it in your `bashrc` or `zshrc` file.
 
-#### kubectx
-For easy context and namespace switching there is
-[kubectx](https://github.com/ahmetb/kubectx). `kubectx` allows users context
-switching, and the linked github comes with `kubens` which allows for simple
-namespace switching. You can use the following aliases:
+## Bash Example
 
 ```bash
-alias kctx='kubectx'
-alias kns='kubens'
+curl https://raw.githubusercontent.com/Dbz/kube-aliases/master/aliases -o ${HOME}/.kube-aliases
+echo "source ${HOME}/.kube-aliases" >> .bashrc
 ```
-#### Kubernetes Metrics Server
 
-To get some metrics from nodes or pods, you can use [Kubernetes Metrics
-Server](https://github.com/kubernetes-incubator/metrics-server). There are 
-the aliases
+## Zsh Example
 
 ```bash
-alias kt='kubectl top'
-alias ktn='kubectl top nodes'
-alias ktp='kubectl top pods'
+curl https://raw.githubusercontent.com/Dbz/kube-aliases/master/aliases -o ${HOME}/.kube-aliases
+echo "source ${HOME}/.kube-aliases" >> .zshrc
 ```
 
-### Trouble Shooting
+## Generate Aliases
+
+Coming soon
+
+## AUR
 
-#### Autocomplete
+Coming soon
 
-If there is problems with autocomplete, it may be that kubectl is not on the
-path when the plugin is loaded. To fix, load plugins after adding kubectl to
-path.