peymanabbasi/kubectl-aliases-powershell

Programmatically generated handy kubectl PowerShell aliases

kubectl-aliases-powershell

Forked from: https://github.com/ahmetb/kubectl-aliases

This repository contains a script to generate hundreds of convenient kubectl PowerShell aliases programmatically.

Examples

Some of the 800 generated aliases are:

function k([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl $params }
function kg([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl get $params }
function kgpo([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl get pods $params }

function ksysgpo([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl --namespace=kube-system get pods $params }

function krm([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl delete $params }
function krmf([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl delete --recursive -f $params }
function krming([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl delete ingress $params }
function krmingl([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl delete ingress -l $params }
function krmingall([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl delete ingress --all $params }

function kgsvcoyaml([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl get service -o=yaml $params }
function kgsvcwn([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl get service --watch --namespace $params }

function kgwf([Parameter(ValueFromRemainingArguments = $true)]$params) { & kubectl get --watch --recursive -f $params }
...

See the full list.

Installation

You can directly download the kubectl_aliases.ps1 file and save it to PowerShell profile directory: $Home\Documents\WindowsPowerShell\ then run this command to edit your profile.ps1:

'. $Home\Documents\WindowsPowerShell\kubectl_aliases.ps1' | Out-File $PROFILE.CurrentUserAllHosts -Encoding ascii -Append

To print the full command before running it, add this to your profile.ps1 file:

function kubectl([Parameter(ValueFromRemainingArguments = $true)]$params) { Write-Output "> kubectl $(@($params | ForEach-Object {$_}) -join ' ')"; & kubectl.exe $params; }

Syntax explanation

• k=kubectl
  • sys=--namespace kube-system
• commands:
  • g=get
  • d=describe
  • rm=delete
  • a:apply -f
  • ex: exec -i -t
  • lo: logs -f
• resources:
  • po=pod, dep=deployment, ing=ingress, svc=service, cm=configmap, sec=secret, ns=namespace, no=node
• flags:
  • output format: oyaml, ojson, owide
  • all: --all or --all-namespaces depending on the command
  • sl: --show-labels
  • w=-w/--watch
• value flags (should be at the end):
  • f=-f/--filename
  • l=-l/--selector

FAQ

Does this not slow down my shell start up?

Sourcing the file that contains ~800 aliases takes less than 30 milliseconds on my laptop. Measure it yourself with Measure-Command { . $Home\Documents\WindowsPowerShell\kubectl_aliases.ps1 } command.

How to regenerate the PowerShell aliases file?

# powershell
generate_aliases.py --output ps1 | Out-File -Encoding ascii kubectl_aliases.ps1

---

This is not an official Google project.