Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reconquest/tubekit
🧪 kubectl alternative with quick context switching, kubectl on steroids
https://github.com/reconquest/tubekit
aliases cli kubectl kubernetes productivity
Last synced: 3 days ago
JSON representation
🧪 kubectl alternative with quick context switching, kubectl on steroids
- Host: GitHub
- URL: https://github.com/reconquest/tubekit
- Owner: reconquest
- License: mit
- Created: 2019-02-24T09:53:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-04T06:49:37.000Z (over 1 year ago)
- Last Synced: 2025-01-01T19:12:25.244Z (10 days ago)
- Topics: aliases, cli, kubectl, kubernetes, productivity
- Language: Go
- Homepage:
- Size: 62.5 KB
- Stars: 217
- Watchers: 9
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - tubekit - 🧪 kubectl alternative with quick context switching, kubectl on steroids (Go)
- awesome-repositories - reconquest/tubekit - 🧪 kubectl alternative with quick context switching, kubectl on steroids (Go)
README
# TUBEKIT
[](#contributors)
tubekit helps you to operate Kubernetes clusters more effectively by reducing
time spent on everyday routines.
## tubectl
[](https://travis-ci.org/reconquest/tubekit)
Tubectl is a simple yet powerful wrapper around kubectl which adds a bit of magic
to your everyday kubectl routines by reducing the complexity of working with
contexts, namespaces and intelligent matching resources.
## Installation
#### Arch Linux
The package is always available in AUR:
[tubekit-git](https://aur.archlinux.org/packages/tubekit-git).
#### Debian/Fedora/CentOS
Packages can be found on [releases page](https://github.com/reconquest/tubekit/releases).
#### nix (on Linux or macOS) / nixOS
With flakes support:
```
$ nix profile install github:reconquest/tubekit
```
#### macOS
```
brew tap reconquest/tubekit https://github.com/reconquest/tubekit.git
brew install tubekit
```
#### Binaries
Binaries can be found on [releases page](https://github.com/reconquest/tubekit/releases).
#### Standalone
With your [GOPATH](https://github.com/golang/go/wiki/GOPATH) already set up:
```
go get github.com/reconquest/tubekit/cmd/...
```
## Usage
[](https://asciinema.org/a/233185)
### Quick context
Very often you need to switch between environments and therefore you need to
switch your kubectl's context or specify it in kubectl's command line with the flag
`--context`. Well, there is even no short option for that flag. This is where
tubectl starts its magic.
You can just specify `@` followed by a name of the context, you don't need to specify
full name of the context, it will be matched by the existing list of contexts
specified in your kubectl configs.
Instead of typing `kubectl --context staging` or `kubectl --context production`
now you just type `tubectl @st` or `tubectl @prod`. It doesn't mean that
`--context` will no longer work because it will. `tubectl` does not break
`kubectl` as it has full backwards compatibility with the original kubectl.
### Quick namespaces
Boring to type `-n monitoring`, huh? Here is the solution — don't type so much,
just type `+mon` with tubectl. tubectl retrieves a list of namespaces from
a cluster and matches given namespace. It's fully back compatible with `-n
--namespace` flags.
Forget about `--all-namespaces`, just use the `++` flag.
With kubectl you used to do like that:
```
kubectl --context staging --all-namespaces get pods
```
Now you can type:
```
tubectl @st ++ get pods
```
Instead of `kube-system` in such command:
```
kubectl get pods -n kube-system
```
You can now type like this:
```
tubectl get pods +sys
```
Also, you can type `++` and `@st` at the end of cmdline or in the middle of
it, it really doesn't matter — tubectl will figure it out.
### Resource matching
That is the real panacea for several problems if you ever had a thought like:
* tailing logs of multiple containers at the same time
* executing a command in multiple containers in serial or parallel mode
* deleting/retrieving/patching all pods/deployments/ingresses matching given
regular expression
* just want to attach to the first container of the pod with several replicas whatever
suffix it might have
Meet the matching operator — `%`.
For example, we have two replicas of nginx running in a cluster:
```
nginx-59d4c6bbcf-dft5z 1/1 Running 8 18d
nginx-59d4c6bbcf-dvfd2 1/1 Running 8 18d
```
Instead of getting the list of pods and then running `kubectl logs` against all
of them you can do the following:
```
tubectl logs nginx%
```
You need to put `%` at the end of your matching query, tubectl will figure out
what resource are you trying to match, will retrieve list of these resources
from given cluster with given namespace, will match it and then run your
command against these resources with all other arguments you've passed.
When you specify one `%` at the end of the query tubectl will run the command
against all matched resources. If you want to run only against a specific
replica, you need to specify its number like `%:X`, example:
```
tubectl logs nginx%:1
```
In this example, tubectl will retrieve all pods matching `nginx` and then get
1st pod from the list, the same can be applied to the second pod — `%:2`.
**What if you want to run the command against all the pods but in parallel mode?**
Similar to `++` for `--all-namespaces` tubectl introduces an operator `%%`,
let's say you want to tail logs of all nginx pods at the same time, then you
just do the following:
```
tubectl logs nginx%% -f
```
tubectl will match resources and will run `kubectl logs` against all pods at
the same time.
### Other advanced examples
* Deleting all deployments matching word `backend` in `staging` namespace
```
tubectl delete deployment +stag backend%
```
or in parallel (concurrent) mode:
```
tubectl delete deployment +stag backend%%
```
* Describing all statefulsets matching word `redis` in `staging` namespace
```
tubectl describe sts +stag redis%%
```
or in parallel (concurrent) mode:
```
tubectl describe sts +stag redis%%
```
* Executing a command in all pods matching word `apiserver` or `scheduler` in
`kube-system` namespace
```
tubectl exec +sys '(apiserver|scheduler)%' -- id
```
or in parallel (concurrent) mode:
```
tubectl exec +sys '(apiserver|scheduler)%%' -- id
```
### Custom flags
Tubectl supports a few own flags, they all have prefix `--tube`:
* `--tube-version` - prints version of the program
* `--tube-debug` - enables debug mode, also can be turned on by `TUBEKIT_DEBUG`
* `--tube-help` - prints short help message about the program.
#### Support
Have a question or problem? Join us in Slack:
[slack.reconquest.io](https://slack.reconquest.io)
### Authors
* [Egor Kovetskiy](https://github.com/kovetskiy)
* [Stanislav Seletskiy](https://github.com/seletskiy)
Hire us, we do reduce business costs by optimizing the things.
### License
MIT
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Sergey Romanov
💻
Dmitry Shaposhnik
📦
Harrison Heck
📦
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!