https://github.com/gerardnico/kube-x
A Library of Kubernetes Utilities
https://github.com/gerardnico/kube-x
kubernetes utilities
Last synced: 5 months ago
JSON representation
A Library of Kubernetes Utilities
- Host: GitHub
- URL: https://github.com/gerardnico/kube-x
- Owner: gerardnico
- Created: 2024-10-12T19:47:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T20:13:23.000Z (7 months ago)
- Last Synced: 2024-11-09T21:20:22.872Z (7 months ago)
- Topics: kubernetes, utilities
- Language: Shell
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kube X - Kube Express - A Library of Kubernetes Utilities eXtension
## About
A library of Kubernetes Utilities eXtension
## Extras
### Vault
Init a vault after installation with [kube-x-vault-init](docs/bin-generated/kube-x-vault-init-unseal.md)
### PromTool
Validate and test PrometheusRules with [kube-x-promtool](docs/bin-generated/kube-x-promtool.md)
### Alert Manager
Query and send alert to the Prometheus Alert Manager with [kube-x-alertmanager](docs/bin-generated/kube-x-alertmanager.md)
### Xshell
* [Xshell](docs/bin-generated/kubectl-xshell.md) - get a shell from a busybox container or a pod
### Ephemere KubeConfig stored in pass
Generate a Ephemere Kubeconfig from pass with [kube-x-config](docs/lib/kube-x-config.md)
## List and documentation
* [xshell](docs/bin-generated/kubectl-xshell.md) - get a shell from a busybox container or a pod
* [xapply](docs/bin/kubectl-xapply) - apply a kustomize app (ie `kustomize apply`)
* [kube-x-env](docs/bin/kubectl-xenv) - print the environment configuration of an app
* [kube-x-events](docs/bin/kubectl-xevent) - shows the events of an app
* [kube-x-file-explorer](docs/bin/kubectl-xvolume-explorer) - Explore the files of an app via SCP/SFTP
* [kubectl-xlogs](docs/bin/kube-x-logs) - print the logs of pods by app name
* [kubectl-xpods](docs/bin/kubectl-xpod) - watch/list the pods of an app
* [kubectl-xrestart](docs/bin/kubectl-xrestart) - execute a rollout restart
* [kube-xtop](docs/bin/kubectl-xtop) - shows the top processes of an app
* [kube-xcert](docs/bin-generated/kubectl-xcert.md) - print the kubeconfig cert in plain text
* [kube-cidr](docs/bin/kube-x-pods-cidr) - print the cidr by pods
* [kube-k3s](docs/bin/kube-x-pods-cidr) - collection of k3s utilities
* [kube-memory](docs/bin/kube-x-memory) - print the cpu and memory used by pods
* [kube-ns-current](docs/bin/kubectl-xns) - set or show the current namespace
* [kube-ns-events](docs/bin/kubectl-xevents) - show the event of a namespace
* [kube-pods-ip](docs/bin/kube-x-pods-ip) - show the ip of pods
* [kube-pvc-move](docs/bin/kube-x-pvc-move) - move a pvc (Automation not finished)
## Installation
* Mac / Linux / Windows WSL with HomeBrew
```bash
brew install --HEAD gerardnico/tap/kube-x
```
## What is an app name?
In all `app` scripts, you need to give an `app name` as argument.
The scripts will try to find resources for an app:
* via the `app.kubernetes.io/name=$APP_NAME` label
* or via the `.envrc` of an app directory
Problem: We need multiple apps in the same directory
because an operator may ship multiple CRD definitions.
See: app.kubernetes.io/part-of: argocd
Example: the Prometheus Operator
* prometheus (Prometheus CRD)
* alertmanager (AlertManager CRD)
* pushgateway
* node exporter
### What is Envrc App Definition?
In this configuration:
* All apps are in a subdirectory of the `KUBE_APP_HOME` directory (given by the `$KUBE_APP_HOME` environment variable).
* The name of an app is the name of a subdirectory
* Each app expects a `kubeconfig` file located at `~/.kube/config-` with the default context set with the same app namespace
* Each app directory have a `.envrc` that:
* is run by `direnv`
* sets the app environment via the [kube-x-env](docs/bin/kubectl-xenv) script
```bash
# kube-x-env` is a direnv extension that set the name, namespace, kubeconfig and directory of an app as environment
# so that you don't execute an app in a bad namespace, context ever.
eval "$(kube-x-env appName [namespaceName])"
```
## Contribute
See [Contribute/Dev](contrib/contribute.md)
## Kubectl Plugins
To make these utilities [Kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/),
you can rename them from `kube-` to `kubectl-`
They should then show up in:
```bash
kubectl plugin list
```
You can discover other plugins at [Krew](https://krew.sigs.k8s.io/plugins/)