v5.0.0
===================================================================== Excited to bring V5 to life. This includes some BREAKING CHANGES to several aspects of ZSH-type scwrypts. Please refer to the readme for upgrade details (specifically docs/upgrade/v4-to-v5.md) --- New Features ------------------------- - ZSH testing library with basic mock capabilities - new scwrypts environment file format includes metadata and more advanced features like optional parent env overrides, selection inheritence, and improved structurual flexibility - speedup cache for non-CI runs of ZSH-type scwrypts - ${scwryptsmodule} syntax now allows a consistent unique-naming scheme for functions in ZSH-type scwrypts while providing better insight into origin of API calls in other modules - reusable, case-statement-driven argument parsers in ZSH-type scwrypts --- Changes ------------------------------ - several utility function renames in ZSH-type scwrypts to improve consistency - documentation comments included in ZSH libraries - ZSH-type scwrypts now allow library modules to live alongside executables (zsh/lib still supported; autodetection determines default) --- Bug Fixes ---------------------------- - hardened environment checking for REQUIRED_ENV variables; this removes the ability to overwrite variables in local function contexts
This commit is contained in:
2
plugins/kube/.config/env.template
Normal file
2
plugins/kube/.config/env.template
Normal file
@ -0,0 +1,2 @@
|
||||
#!/bin/zsh
|
||||
export SCWRYPTS_KUBECTL_REDIS=
|
1
plugins/kube/.config/env.template.descriptions
Normal file
1
plugins/kube/.config/env.template.descriptions
Normal file
@ -0,0 +1 @@
|
||||
SCWRYPTS_KUBECTL_REDIS | (currently only 'managed') 'managed' or 'custom' redis configuration
|
5
plugins/kube/.config/env.yaml
Normal file
5
plugins/kube/.config/env.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
scwrypts-kubectl-redis:
|
||||
.DESCRIPTION: >-
|
||||
[currently only 'managed'] 'managed' or 'custom' redis configuration
|
||||
.ENVIRONMENT: SCWRYPTS_KUBECTL_REDIS
|
4
plugins/kube/.config/static/redis.zsh
Normal file
4
plugins/kube/.config/static/redis.zsh
Normal file
@ -0,0 +1,4 @@
|
||||
export SCWRYPTS_KUBECTL_REDIS_HOST__managed=127.0.0.1
|
||||
export SCWRYPTS_KUBECTL_REDIS_PORT__managed=26379
|
||||
export SCWRYPTS_KUBECTL_REDIS_AUTH__managed=
|
||||
export SCWRYPTS_KUBECTL_REDIS_KEY_PREFIX__managed=
|
10
plugins/kube/README.md
Normal file
10
plugins/kube/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Kubernetes `kubectl` Helper Plugin
|
||||
|
||||
Leverages a local `redis` application to quickly and easily set an alias `k` for `kubectl --context <some-context> --namespace <some-namespace>`.
|
||||
Much like scwrypts environments, `k` aliases are *only* shared amongst session with the same `SCWRYPTS_ENV` to prevent accidental cross-contamination.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
Enable the plugin in `~/.config/scwrypts/config.zsh` by adding `SCWRYPTS_PLUGIN_ENABLED__KUBECTL=1`.
|
||||
Use `k` as your new `kubectl` and checkout `k --help` and `k meta --help`.
|
47
plugins/kube/driver/kubectl.completion.zsh
Normal file
47
plugins/kube/driver/kubectl.completion.zsh
Normal file
@ -0,0 +1,47 @@
|
||||
#####################################################################
|
||||
command -v compdef >/dev/null 2>&1 || return 0
|
||||
#####################################################################
|
||||
|
||||
for CLI in kubectl helm flux
|
||||
do
|
||||
eval "_${CLI[1]}() {
|
||||
local SUBSESSION=0
|
||||
local SUBSESSION_OFFSET=2
|
||||
echo \${words[2]} | grep -q '^[0-9]\\+$' && SUBSESSION=\${words[2]} && SUBSESSION_OFFSET=3
|
||||
|
||||
local PASSTHROUGH_WORDS=($CLI)
|
||||
[[ \$CURRENT -gt \${SUBSESSION_OFFSET} ]] && echo \${words[\${SUBSESSION_OFFSET}]} | grep -qv '^[0-9]\\+$' && {
|
||||
local KUBECONTEXT=\$(k \$SUBSESSION meta get context)
|
||||
local NAMESPACE=\$(k \$SUBSESSION meta get namespace)
|
||||
|
||||
[ \$KUBECONTEXT ] \
|
||||
&& PASSTHROUGH_WORDS+=($([[ $CLI =~ ^helm$ ]] && echo '--kube-context' || echo '--context') \$KUBECONTEXT) \
|
||||
;
|
||||
[ \$NAMESPACE ] \
|
||||
&& PASSTHROUGH_WORDS+=(--namespace \$NAMESPACE) \
|
||||
;
|
||||
}
|
||||
|
||||
local DELIMIT_COUNT=0
|
||||
local WORD
|
||||
for WORD in \${words[@]:1}
|
||||
do
|
||||
case \$WORD in
|
||||
( [0-9]* ) continue ;;
|
||||
( -- )
|
||||
echo \$words | grep -q 'exec' && ((DELIMIT_COUNT+=1))
|
||||
[[ \$DELIMIT_COUNT -eq 0 ]] && ((DELIMIT_COUNT+=1)) && continue
|
||||
;;
|
||||
esac
|
||||
PASSTHROUGH_WORDS+=(\"\$WORD\")
|
||||
done
|
||||
|
||||
echo \"\$words\" | grep -q '\\s\\+$' && PASSTHROUGH_WORDS+=(' ')
|
||||
|
||||
words=\"\${PASSTHROUGH_WORDS[@]}\"
|
||||
_$CLI
|
||||
}
|
||||
"
|
||||
|
||||
compdef _${CLI[1]} ${CLI[1]}
|
||||
done
|
198
plugins/kube/driver/kubectl.driver.zsh
Normal file
198
plugins/kube/driver/kubectl.driver.zsh
Normal file
@ -0,0 +1,198 @@
|
||||
[[ $SCWRYPTS_KUBECTL_DRIVER_READY -eq 1 ]] && return 0
|
||||
|
||||
unalias k h f >/dev/null 2>&1
|
||||
k() { _SCWRYPTS_KUBECTL_DRIVER kubectl $@; }
|
||||
h() { _SCWRYPTS_KUBECTL_DRIVER helm $@; }
|
||||
f() { _SCWRYPTS_KUBECTL_DRIVER flux $@; }
|
||||
|
||||
_SCWRYPTS_KUBECTL_DRIVER() {
|
||||
[ ! $SCWRYPTS_ENV ] && {
|
||||
echo.error "must set SCWRYPTS_ENV in order to use '$(echo $CLI | head -c1)'"
|
||||
return 1
|
||||
}
|
||||
|
||||
which kube.redis >/dev/null 2>&1 \
|
||||
|| eval "$(scwrypts -n --name meta/get-static-redis-definition --type zsh --group kube)"
|
||||
|
||||
local CLI="$1"; shift 1
|
||||
|
||||
local SCWRYPTS_GROUP CUSTOM_COMMANDS=(meta)
|
||||
for SCWRYPTS_GROUP in ${SCWRYPTS_GROUPS[@]}
|
||||
do
|
||||
CUSTOM_COMMANDS+=($(eval echo '$SCWRYPTS_KUBECTL_CUSTOM_COMMANDS__'$SCWRYPTS_GROUP))
|
||||
done
|
||||
|
||||
##########################################
|
||||
|
||||
local USAGE="
|
||||
usage: - [...args...] [...options...] -- [...$CLI options...]
|
||||
|
||||
args: -
|
||||
|
||||
options: -
|
||||
--subsession [0-9] use indicated subsession (use for script clarity instead of positional arg)
|
||||
|
||||
-h, --help display this help dialogue
|
||||
-v, --verbose output debugging information
|
||||
|
||||
description: -
|
||||
"
|
||||
|
||||
local USAGE__usage=$(echo $CLI | head -c1)
|
||||
|
||||
local USAGE__args="$(
|
||||
{
|
||||
echo "$(utils.colors.print green '[0-9]')^if the first argument is a number 0-9, uses or creates a subsession (default 0)"
|
||||
echo " ^ "
|
||||
for C in ${CUSTOM_COMMANDS[@]}
|
||||
do
|
||||
echo "$(utils.colors.print green ${C})^$(SCWRYPTS_KUBECTL_CUSTOM_COMMAND_DESCRIPTION__$C 2>/dev/null)"
|
||||
done
|
||||
} | column -ts '^'
|
||||
)"
|
||||
|
||||
local USAGE__options="
|
||||
-n, --namespace set the namespace
|
||||
-k, --context set the context
|
||||
"
|
||||
|
||||
local USAGE__description="
|
||||
Provides 'k' (kubectl), 'h' (helm), and 'f' (flux) shorthands to the respective
|
||||
utility. These functions leverage redis and scwrypts environments to
|
||||
allow quick selection of contexts and namespaces usable across all
|
||||
active shell instances.
|
||||
|
||||
The scwrypts group 'kubectl' has simple selection executables for
|
||||
kubecontext and namespace, but also provides the library to enable
|
||||
enriched, use-case-sensitive setup of kubernetes context.
|
||||
|
||||
All actions are scoped to the current SCWRYPTS_ENV
|
||||
currently : $(utils.colors.print yellow ${SCWRYPTS_ENV})
|
||||
|
||||
"
|
||||
|
||||
##########################################
|
||||
|
||||
local USER_ARGS=()
|
||||
|
||||
local CUSTOM_COMMAND=0
|
||||
local VERBOSE=0
|
||||
local HELP=0
|
||||
local ERRORS=0
|
||||
|
||||
local COMMAND_SWITCH_CASE="@($(echo $CUSTOM_COMMANDS | sed 's/ /|/g'))"
|
||||
|
||||
[ ! $SUBSESSION ] && local SUBSESSION=0
|
||||
[[ $1 =~ ^[0-9]$ ]] && SUBSESSION=$1 && shift 1
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
meta )
|
||||
CUSTOM_COMMAND=$1
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__$1 ${@:2}
|
||||
break
|
||||
;;
|
||||
|
||||
-v | --verbose ) VERBOSE=1 ;;
|
||||
-h | --help ) HELP=1 ;;
|
||||
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
-n | --namespace )
|
||||
_SCWRYPTS_KUBECTL_DRIVER kubectl meta set namespace $2
|
||||
shift 1
|
||||
;;
|
||||
|
||||
-k | --context | --kube-context )
|
||||
_SCWRYPTS_KUBECTL_DRIVER kubectl meta set context $2
|
||||
shift 1
|
||||
;;
|
||||
|
||||
-- )
|
||||
echo $USER_ARGS | grep -q 'exec' && USER_ARGS+=(--)
|
||||
shift 1
|
||||
break
|
||||
;;
|
||||
|
||||
* )
|
||||
[ ! $CUSTOM_COMMAND ] && {
|
||||
for C in ${CUSTOM_COMMANDS[@]}
|
||||
do
|
||||
[[ $1 =~ ^$C$ ]] && {
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__$1 ${@:2}
|
||||
break
|
||||
}
|
||||
done
|
||||
}
|
||||
USER_ARGS+=($1)
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
while [[ $# -gt 0 ]]; do USER_ARGS+=($1); shift 1; done
|
||||
|
||||
|
||||
utils.check-errors || return 1
|
||||
|
||||
[[ $HELP -eq 1 ]] && { utils.io.usage; return 0; }
|
||||
|
||||
#####################################################################
|
||||
|
||||
local STRICT=$(_SCWRYPTS_KUBECTL_SETTINGS get strict || echo 1)
|
||||
|
||||
case $CUSTOM_COMMAND in
|
||||
0 )
|
||||
local CLI_ARGS=()
|
||||
|
||||
local CONTEXT=$(k meta get context)
|
||||
local NAMESPACE=$(k meta get namespace)
|
||||
|
||||
[ $CONTEXT ] && [[ $CLI =~ ^helm$ ]] && CLI_ARGS+=(--kube-context $CONTEXT)
|
||||
[ $CONTEXT ] && [[ $CLI =~ ^kubectl$ ]] && CLI_ARGS+=(--context $CONTEXT)
|
||||
[ $CONTEXT ] && [[ $CLI =~ ^flux$ ]] && CLI_ARGS+=(--context $CONTEXT)
|
||||
|
||||
[[ $STRICT -eq 1 ]] && {
|
||||
[ $CONTEXT ] || echo.error "missing kubectl 'context'"
|
||||
[ $NAMESPACE ] || echo.error "missing kubectl 'namespace'"
|
||||
|
||||
utils.check-errors --no-fail --no-usage || {
|
||||
echo.error "with 'strict' settings enabled, context and namespace must be set!"
|
||||
echo.reminder "
|
||||
these values can be set directly with
|
||||
$(echo $CLI | head -c1) meta set (namespace|context)
|
||||
"
|
||||
|
||||
return 2
|
||||
}
|
||||
}
|
||||
|
||||
[ $NAMESPACE ] && CLI_ARGS+=(--namespace $NAMESPACE)
|
||||
[[ $VERBOSE -eq 1 ]] && {
|
||||
echo.reminder "
|
||||
context '$CONTEXT'
|
||||
namespace '$NAMESPACE'
|
||||
environment '$SCWRYPTS_ENV'
|
||||
subsession '$SUBSESSION'
|
||||
"
|
||||
echo.status "running $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
} || {
|
||||
[[ $(_SCWRYPTS_KUBECTL_SETTINGS get context) =~ ^show$ ]] && {
|
||||
echo.reminder "$SCWRYPTS_ENV.$SUBSESSION : $CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}"
|
||||
}
|
||||
}
|
||||
$CLI ${CLI_ARGS[@]} ${USER_ARGS[@]}
|
||||
;;
|
||||
* ) SCWRYPTS_KUBECTL_CUSTOM_COMMAND__$CUSTOM_COMMAND ${USER_ARGS[@]} ;;
|
||||
esac
|
||||
}
|
||||
|
||||
_SCWRYPTS_KUBECTL_SETTINGS() {
|
||||
# (get setting-name) or (set setting-name setting-value)
|
||||
kube.redis h$1 ${SCWRYPTS_ENV}:kubectl:settings ${@:2} | grep .
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
source ${0:a:h}/kubectl.completion.zsh
|
||||
source ${0:a:h}/meta.zsh
|
149
plugins/kube/driver/meta.zsh
Normal file
149
plugins/kube/driver/meta.zsh
Normal file
@ -0,0 +1,149 @@
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND_PARSE__meta() {
|
||||
USAGE__usage+=" meta"
|
||||
USAGE__args="
|
||||
- get output value of meta variable
|
||||
- set interactively configure value of meta variable
|
||||
- clear clear current subsession variables
|
||||
|
||||
(settings args)
|
||||
- show output context for every command
|
||||
- hide (default) hide output context for every command
|
||||
|
||||
- strict (default) require context *and* namespace to be set
|
||||
- loose do not require context and namespace to be set
|
||||
"
|
||||
USAGE__options=''
|
||||
USAGE__description=$(SCWRYPTS_KUBECTL_CUSTOM_COMMAND_DESCRIPTION__meta)
|
||||
|
||||
META_SUBARGS="
|
||||
- namespace
|
||||
- context
|
||||
"
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
( -h | --help ) HELP=1 ;;
|
||||
|
||||
( set )
|
||||
USAGE__usage+=" set"
|
||||
USAGE__args="set (namespace|context)"
|
||||
USAGE__description="interactively set a namespace or context for '$SCWRYPTS_ENV'"
|
||||
case $2 in
|
||||
( namespace | context ) USER_ARGS+=($1 $2 $3); [ $3 ] && shift 1 ;;
|
||||
( -h | --help ) HELP=1 ;;
|
||||
( '' )
|
||||
: \
|
||||
&& SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta set context \
|
||||
&& SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta set namespace \
|
||||
;
|
||||
return $?
|
||||
;;
|
||||
|
||||
( * ) echo.error "cannot set '$2'" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( get )
|
||||
USAGE__usage+=" get"
|
||||
USAGE__args="get (namespace|context|all)"
|
||||
USAGE__description="output the current namespace or context for '$SCWRYPTS_ENV'"
|
||||
case $2 in
|
||||
( namespace | context | all ) USER_ARGS+=($1 $2) ;;
|
||||
|
||||
( -h | --help ) HELP=1 ;;
|
||||
|
||||
( * ) echo.error "cannot get '$2'" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( copy )
|
||||
USAGE__usage+=" copy"
|
||||
USAGE__args+="copy [0-9]"
|
||||
USAGE__description="copy current subsession ($SUBSESSION) to target subsession id"
|
||||
case $2 in
|
||||
( [0-9] ) USER_ARGS+=($1 $2) ;;
|
||||
( -h | --help ) HELP=1 ;;
|
||||
( * ) echo.error "target session must be a number [0-9]" ;;
|
||||
esac
|
||||
shift 1
|
||||
;;
|
||||
|
||||
( clear | show | hide | strict | loose ) USER_ARGS+=($1) ;;
|
||||
|
||||
( * ) echo.error "no meta command '$1'"
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
}
|
||||
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND__meta() {
|
||||
case $1 in
|
||||
( get )
|
||||
[[ $2 =~ ^all$ ]] && {
|
||||
local CONTEXT=$(kube.redis get --prefix current:context | grep . || utils.colors.print bright-red "none set")
|
||||
local NAMESPACE=$(kube.redis get --prefix current:namespace | grep . || utils.colors.print bright-red "none set")
|
||||
echo "
|
||||
environment : $SCWRYPTS_ENV
|
||||
context : $CONTEXT
|
||||
namespace : $NAMESPACE
|
||||
|
||||
CLI settings
|
||||
command context : $(_SCWRYPTS_KUBECTL_SETTINGS get context)
|
||||
strict mode : $([[ $STRICT -eq 1 ]] && utils.colors.print green on || utils.colors.print bright-red off)
|
||||
" | sed 's/^ \+//' >&2
|
||||
return 0
|
||||
}
|
||||
|
||||
kube.redis get --prefix current:$2
|
||||
;;
|
||||
|
||||
( set )
|
||||
: \
|
||||
&& scwrypts -n --name set-$2 --type zsh --group kube -- $3 --subsession $SUBSESSION >/dev/null \
|
||||
&& k $SUBSESSION meta get $2 \
|
||||
;
|
||||
;;
|
||||
|
||||
( copy )
|
||||
: \
|
||||
&& echo.status "copying $1 to $2" \
|
||||
&& scwrypts -n --name set-context --type zsh --group kube -- --subsession $2 $(k $1 meta get context | grep . || echo 'reset') \
|
||||
&& scwrypts -n --name set-namespace --type zsh --group kube -- --subsession $2 $(k $1 meta get namespace | grep . || echo 'reset') \
|
||||
&& echo.success "subsession $1 copied to $2" \
|
||||
;
|
||||
;;
|
||||
|
||||
( clear )
|
||||
scwrypts -n --name set-context --type zsh --group kube -- --subsession $SUBSESSION reset >/dev/null \
|
||||
&& echo.success "subsession $SUBSESSION reset to default"
|
||||
;;
|
||||
|
||||
( show )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set context show >/dev/null \
|
||||
&& echo.success "now showing full command context"
|
||||
;;
|
||||
|
||||
( hide )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set context hide >/dev/null \
|
||||
&& echo.success "now hiding command context"
|
||||
;;
|
||||
|
||||
( loose )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set strict 0 >/dev/null \
|
||||
&& echo.warning "now running in 'loose' mode"
|
||||
;;
|
||||
|
||||
( strict )
|
||||
_SCWRYPTS_KUBECTL_SETTINGS set strict 1 >/dev/null \
|
||||
&& echo.success "now running in 'strict' mode"
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
SCWRYPTS_KUBECTL_CUSTOM_COMMAND_DESCRIPTION__meta() {
|
||||
[ $CLI ] || CLI='kubectl'
|
||||
echo "operations for $CLI session variables and other CLI settings"
|
||||
}
|
7
plugins/kube/get-context
Executable file
7
plugins/kube/get-context
Executable file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
kube.kubectl.context.get
|
||||
}
|
7
plugins/kube/get-namespace
Executable file
7
plugins/kube/get-namespace
Executable file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
kube.kubectl.namespace.get
|
||||
}
|
10
plugins/kube/kube.scwrypts.zsh
Normal file
10
plugins/kube/kube.scwrypts.zsh
Normal file
@ -0,0 +1,10 @@
|
||||
export ${scwryptsgroup}__type=zsh
|
||||
export ${scwryptsgroup}__color=$(utils.colors.red)
|
||||
|
||||
#####################################################################
|
||||
|
||||
SCWRYPTS_STATIC_CONFIG__kubectl+=(
|
||||
"${scwryptsgrouproot}/.config/static/redis.zsh"
|
||||
)
|
||||
|
||||
source "${scwryptsgrouproot}/driver/kubectl.driver.zsh"
|
18
plugins/kube/kubectl/cli.module.zsh
Normal file
18
plugins/kube/kubectl/cli.module.zsh
Normal file
@ -0,0 +1,18 @@
|
||||
#####################################################################
|
||||
|
||||
DEPENDENCIES+=(kubectl)
|
||||
|
||||
use redis --group kube
|
||||
|
||||
#####################################################################
|
||||
|
||||
kube.cli() {
|
||||
local NAMESPACE="$(kube.redis get --prefix "current:namespace")"
|
||||
local CONTEXT="$(kube.kubectl.context.get)"
|
||||
|
||||
local ARGS=()
|
||||
[ "${NAMESPACE}" ] && ARGS+=(--namespace "${NAMESPACE}")
|
||||
[ "${CONTEXT}" ] && ARGS+=(--context "${CONTEXT}")
|
||||
|
||||
kubectl ${ARGS[@]} $@
|
||||
}
|
56
plugins/kube/kubectl/context.module.zsh
Normal file
56
plugins/kube/kubectl/context.module.zsh
Normal file
@ -0,0 +1,56 @@
|
||||
#####################################################################
|
||||
|
||||
use --group kube kubectl/cli
|
||||
use --group kube kubectl/namespace
|
||||
use --group kube redis
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.get() { kube.redis get --prefix "current:context"; }
|
||||
|
||||
${scwryptsmodule}.set() {
|
||||
local CONTEXT=$1
|
||||
[ ! "${CONTEXT}" ] && return 1
|
||||
|
||||
[[ "${CONTEXT}" =~ reset ]] && {
|
||||
: \
|
||||
&& kube.redis del --prefix "current:context" \
|
||||
&& kube.kubectl.namespace.set reset \
|
||||
;
|
||||
return $?
|
||||
}
|
||||
|
||||
: \
|
||||
&& kube.redis set --prefix "current:context" "${CONTEXT}" \
|
||||
&& kube.kubectl.namespace.set reset \
|
||||
;
|
||||
}
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
case "$(kube.kubectl.context.list | grep -v '^reset$' | wc -l)" in
|
||||
( 0 )
|
||||
echo.error "no contexts available"
|
||||
return 1
|
||||
;;
|
||||
( 1 )
|
||||
kube.kubectl.context.list | tail -n1
|
||||
;;
|
||||
( * )
|
||||
kube.kubectl.context.list | utils.fzf 'select a context'
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
echo reset
|
||||
local ALL_CONTEXTS="$(kube.cli config get-contexts -o name | sort -u)"
|
||||
|
||||
echo "${ALL_CONTEXTS}" | grep -v '^arn:aws:eks'
|
||||
|
||||
[[ "${AWS_ACCOUNT}" ]] && {
|
||||
echo "${ALL_CONTEXTS}" | grep "^arn:aws:eks:.*:${AWS_ACCOUNT}"
|
||||
true
|
||||
} || {
|
||||
echo "${ALL_CONTEXTS}" | grep '^arn:aws:eks'
|
||||
}
|
||||
}
|
17
plugins/kube/kubectl/kubectl.module.zsh
Normal file
17
plugins/kube/kubectl/kubectl.module.zsh
Normal file
@ -0,0 +1,17 @@
|
||||
#
|
||||
# combines kubectl with redis to both facilitate use of kubectl
|
||||
# between varying contexts/namespaces AND grant persistence between
|
||||
# terminal sessions
|
||||
#
|
||||
|
||||
# redis wrapper for kubectl
|
||||
use --group kube kubectl/cli
|
||||
|
||||
# simplify commands for kubecontexts
|
||||
use --group kube kubectl/context
|
||||
|
||||
# simplify commands for namespaces
|
||||
use --group kube kubectl/namespace
|
||||
|
||||
# local redirect commands for remote kubernetes services
|
||||
use --group kube kubectl/service
|
23
plugins/kube/kubectl/namespace.module.zsh
Normal file
23
plugins/kube/kubectl/namespace.module.zsh
Normal file
@ -0,0 +1,23 @@
|
||||
${scwryptsmodule}.get() { kube.redis get --prefix "current:namespace"; }
|
||||
|
||||
${scwryptsmodule}.set() {
|
||||
local NAMESPACE=$1
|
||||
[ ! "${NAMESPACE}" ] && return 1
|
||||
|
||||
[[ "${NAMESPACE}" =~ reset ]] && {
|
||||
kube.redis del --prefix "current:namespace"
|
||||
return $?
|
||||
}
|
||||
|
||||
kube.redis set --prefix "current:namespace" "${NAMESPACE}"
|
||||
}
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
kube.kubectl.namespace.list | utils.fzf 'select a namespace'
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
echo reset
|
||||
echo default
|
||||
kube.cli get namespaces -o name | sed 's/^namespace\///' | sort | grep -v '^default$'
|
||||
}
|
77
plugins/kube/kubectl/service.module.zsh
Normal file
77
plugins/kube/kubectl/service.module.zsh
Normal file
@ -0,0 +1,77 @@
|
||||
#####################################################################
|
||||
|
||||
use --group kube kubectl/cli
|
||||
use --group kube kubectl/context
|
||||
use --group kube kubectl/namespace
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.serve() {
|
||||
[ "${CONTEXT}" ] || local CONTEXT="$(kube.kubectl.context.get)"
|
||||
[ "${CONTEXT}" ] || echo.error 'must configure a context in which to serve'
|
||||
|
||||
[ "${NAMESPACE}" ] || local NAMESPACE="$(kube.kubectl.namespace.get)"
|
||||
[ "${NAMESPACE}" ] || echo.error 'must configure a namespace in which to serve'
|
||||
|
||||
utils.check-errors --no-usage || return 1
|
||||
|
||||
[ "${SERVICE}" ] && SERVICE="$(kube.kubectl.service.list | jq -c "select (.service == \"${SERVICE}\")" || echo ${SERVICE})"
|
||||
[ "${SERVICE}" ] || local SERVICE="$(kube.kubectl.service.select)"
|
||||
[ "${SERVICE}" ] || echo.error 'must provide or select a service'
|
||||
|
||||
kube.kubectl.service.list | grep -q "^${SERVICE}$"\
|
||||
|| echo.error "no service '${SERVICE}' in '${CONFIG}/${NAMESPACE}'"
|
||||
|
||||
utils.check-errors --no-usage || return 1
|
||||
|
||||
##########################################
|
||||
|
||||
SERVICE_PASSWORD="$(kube.kubectl.service.get-password)"
|
||||
kube.kubectl.service.parse
|
||||
|
||||
echo.reminder "attempting to serve ${NAMESPACE}/${SERVICE_NAME}:${SERVICE_PORT}"
|
||||
[ "${SERVICE_PASSWORD}" ] && echo.reminder "password : ${SERVICE_PASSWORD}"
|
||||
|
||||
kube.cli port-forward "service/${SERVICE_NAME}" "${SERVICE_PORT}"
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
|
||||
${scwryptsmodule}.select() {
|
||||
[ "${NAMESPACE}" ] || local NAMESPACE="$(kube.kubectl.namespace.get)"
|
||||
[ "${NAMESPACE}" ] || return 1
|
||||
|
||||
local SERVICES="$(kube.kubectl.service.list)"
|
||||
local SELECTED="$({
|
||||
echo "namespace service port"
|
||||
echo ${SERVICES} \
|
||||
| jq -r '.service + " " + .port' \
|
||||
| sed "s/^/${NAMESPACE} /" \
|
||||
;
|
||||
} \
|
||||
| column -t \
|
||||
| utils.fzf 'select a service' --header-lines=1 \
|
||||
| awk '{print $2;}' \
|
||||
)"
|
||||
|
||||
echo "${SERVICES}" | jq -c "select (.service == \"${SELECTED}\")"
|
||||
}
|
||||
|
||||
${scwryptsmodule}.list() {
|
||||
kube.cli get service --no-headers\
|
||||
| awk '{print "{\"service\":\""$1"\",\"ip\":\""$3"\",\"port\":\""$5"\"}"}' \
|
||||
| jq -c 'select (.ip != "None")' \
|
||||
;
|
||||
}
|
||||
|
||||
${scwryptsmodule}.get-password() {
|
||||
[ "${PASSWORD_SECRET}" ] && [ "${PASSWORD_KEY}" ] || return 0
|
||||
|
||||
kube.cli get secret "${PASSWORD_SECRET}" -o jsonpath="{.data.${PASSWORD_KEY}}" \
|
||||
| base64 --decode
|
||||
}
|
||||
|
||||
${scwryptsmodule}.parse() {
|
||||
SERVICE_NAME="$(echo "${SERVICE}" | jq -r .service)"
|
||||
SERVICE_PORT="$(echo "${SERVICE}" | jq -r .port | sed 's|/.*$||')"
|
||||
}
|
7
plugins/kube/meta/get-static-redis-definition
Executable file
7
plugins/kube/meta/get-static-redis-definition
Executable file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env zsh
|
||||
use redis --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
echo $(kube.redis --get-static-definition)
|
||||
}
|
94
plugins/kube/redis/redis.module.zsh
Normal file
94
plugins/kube/redis/redis.module.zsh
Normal file
@ -0,0 +1,94 @@
|
||||
#####################################################################
|
||||
|
||||
DEPENDENCIES+=(
|
||||
redis-cli
|
||||
docker
|
||||
)
|
||||
|
||||
REQUIRED_ENV+=()
|
||||
|
||||
utils.environment.check SCWRYPTS_KUBECTL_REDIS --default managed
|
||||
|
||||
#####################################################################
|
||||
|
||||
kube.redis() {
|
||||
[ ! $USAGE ] && local USAGE="
|
||||
usage: [...options...]
|
||||
|
||||
options:
|
||||
--subsession [0-9] use a particular subsession
|
||||
|
||||
-p, --prefix apply dynamic prefix to the next command line argument
|
||||
|
||||
--get-prefix output key prefix for current session+subsession
|
||||
--get-static-definition output the static ZSH function definition for kube.redis
|
||||
|
||||
additional arguments and options are passed through to 'redis-cli'
|
||||
"
|
||||
|
||||
local REDIS_ARGS=() USER_ARGS=()
|
||||
|
||||
[ $SUBSESSION ] || local SUBSESSION=0
|
||||
|
||||
local REDIS_PREFIX=$(eval echo '$SCWRYPTS_KUBECTL_REDIS_KEY_PREFIX__'$SCWRYPTS_KUBECTL_REDIS)
|
||||
[ $REDIS_PREFIX ] && REDIS_PREFIX+=':'
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
( -p | --prefix ) USER_ARGS+=("${REDIS_PREFIX}${SCWRYPTS_ENV}:${SUBSESSION}:$2"); shift 1 ;;
|
||||
|
||||
( --subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
( --get-prefix ) echo $REDIS_PREFIX; return 0 ;;
|
||||
( --get-static-definition ) ECHO_STATIC_DEFINITION=1 ;;
|
||||
|
||||
( * ) USER_ARGS+=($1) ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
local REDIS_HOST=$(eval echo '$SCWRYPTS_KUBECTL_REDIS_HOST__'$SCWRYPTS_KUBECTL_REDIS)
|
||||
local REDIS_PORT=$(eval echo '$SCWRYPTS_KUBECTL_REDIS_PORT__'$SCWRYPTS_KUBECTL_REDIS)
|
||||
local REDIS_AUTH=$(eval echo '$SCWRYPTS_KUBECTL_REDIS_AUTH__'$SCWRYPTS_KUBECTL_REDIS)
|
||||
|
||||
[ $REDIS_HOST ] && REDIS_ARGS+=(-h $REDIS_HOST)
|
||||
[ $REDIS_PORT ] && REDIS_ARGS+=(-p $REDIS_PORT)
|
||||
[ $REDIS_AUTH ] && REDIS_ARGS+=(-a $REDIS_AUTH)
|
||||
|
||||
REDIS_ARGS+=(--raw)
|
||||
|
||||
[[ $ECHO_STATIC_DEFINITION -eq 1 ]] && {
|
||||
echo "kube.redis() {\
|
||||
local USER_ARGS=(); \
|
||||
[ ! \$SUBSESSION ] && local SUBSESSION=0 ;\
|
||||
while [[ \$# -gt 0 ]]; \
|
||||
do \
|
||||
case \$1 in
|
||||
( -p | --prefix ) USER_ARGS+=(\"${REDIS_PREFIX}\${SCWRYPTS_ENV}:\${SUBSESSION}:\$2\"); shift 1 ;; \
|
||||
( * ) USER_ARGS+=(\$1) ;; \
|
||||
esac; \
|
||||
shift 1; \
|
||||
done; \
|
||||
redis-cli ${REDIS_ARGS[@]} \${USER_ARGS[@]}; \
|
||||
}" | sed 's/\s\+/ /g'
|
||||
return 0
|
||||
}
|
||||
|
||||
redis-cli ${REDIS_ARGS[@]} ${USER_ARGS[@]}
|
||||
}
|
||||
|
||||
kube.redis ping 2>/dev/null | grep -qi pong || {
|
||||
RPID=$(docker ps -a | grep scwrypts-kubectl-redis | awk '{print $1;}')
|
||||
[ $RPID ] && echo.status 'refreshing redis instance' && docker rm -f $RPID
|
||||
unset RPID
|
||||
|
||||
docker run \
|
||||
--detach \
|
||||
--name scwrypts-kubectl-redis \
|
||||
--publish $SCWRYPTS_KUBECTL_REDIS_PORT__managed:6379 \
|
||||
redis >/dev/null 2>&1
|
||||
|
||||
echo.status 'awaiting redis connection'
|
||||
until kube.redis ping 2>/dev/null | grep -qi pong; do sleep 0.5; done
|
||||
}
|
49
plugins/kube/serve
Executable file
49
plugins/kube/serve
Executable file
@ -0,0 +1,49 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
local USAGE="
|
||||
usage: [service] [...options...]
|
||||
|
||||
args:
|
||||
service (optional) name of the service to forward locally
|
||||
|
||||
options:
|
||||
--context override context
|
||||
--namespace override namespace
|
||||
--subsession kube.redis subsession (default 0)
|
||||
|
||||
to show a required password on screen, use both:
|
||||
--password-secret Secret resource
|
||||
--password-key key within Secret's 'data'
|
||||
|
||||
-h, --help show this dialogue and exit
|
||||
"
|
||||
local CONTEXT NAMESPACE SERVICE
|
||||
local SUBSESSION=0
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--context ) CONTEXT=$2; shift 1 ;;
|
||||
--namespace ) NAMESPACE=$2; shift 1 ;;
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
--password-secret ) PASSWORD_SECRET=$2; shift 1 ;;
|
||||
--password-key ) PASSWORD_KEY=$2; shift 1 ;;
|
||||
|
||||
-h | --help ) utils.io.usage; return 0 ;;
|
||||
|
||||
* )
|
||||
[ $SERVICE ] && echo.error "unexpected argument '$2'"
|
||||
SERVICE=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
utils.check-errors --fail
|
||||
|
||||
kube.kubectl.serve
|
||||
}
|
39
plugins/kube/set-context
Executable file
39
plugins/kube/set-context
Executable file
@ -0,0 +1,39 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
local USAGE="
|
||||
usage: [context] [...options...]
|
||||
|
||||
args:
|
||||
context (optional) the full name of the kubeconfig context to set
|
||||
|
||||
options:
|
||||
--subsession kube.redis subsession (default 0)
|
||||
|
||||
-h, --help show this dialogue and exit
|
||||
"
|
||||
local CONTEXT
|
||||
local SUBSESSION=0
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
* )
|
||||
[ $CONTEXT ] && echo.error "unexpected argument '$2'"
|
||||
CONTEXT=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[ $CONTEXT ] || CONTEXT=$(kube.kubectl.context.select)
|
||||
[ $CONTEXT ] || echo.error 'must provide or select a valid kube context'
|
||||
|
||||
utils.check-errors --fail
|
||||
|
||||
kube.kubectl.context.set $CONTEXT
|
||||
}
|
41
plugins/kube/set-namespace
Executable file
41
plugins/kube/set-namespace
Executable file
@ -0,0 +1,41 @@
|
||||
#!/usr/bin/env zsh
|
||||
use kubectl --group kube
|
||||
#####################################################################
|
||||
|
||||
MAIN() {
|
||||
local USAGE="
|
||||
usage: [namespace] [...options...]
|
||||
|
||||
args:
|
||||
namespace (optional) the full name of the namespace context to set
|
||||
|
||||
options:
|
||||
--subsession kube.redis subsession (default 0)
|
||||
|
||||
-h, --help show this dialogue and exit
|
||||
"
|
||||
local NAMESPACE
|
||||
local SUBSESSION=0
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--subsession ) SUBSESSION=$2; shift 1 ;;
|
||||
|
||||
-h | --help ) utils.io.usage; return 0 ;;
|
||||
|
||||
* )
|
||||
[ $NAMESPACE ] && echo.error "unexpected argument '$2'"
|
||||
NAMESPACE=$1
|
||||
;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[ $NAMESPACE ] || NAMESPACE=$(kube.kubectl.namespace.select)
|
||||
[ $NAMESPACE ] || echo.error 'must provide or select a valid namespace'
|
||||
|
||||
utils.check-errors --fail
|
||||
|
||||
kube.kubectl.namespace.set $NAMESPACE
|
||||
}
|
Reference in New Issue
Block a user