Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timebertt/kubectl-revisions
🚀 Time-travel through your workload's revision history 🕰️
https://github.com/timebertt/kubectl-revisions
kubectl kubectl-plugin kubernetes
Last synced: 9 days ago
JSON representation
🚀 Time-travel through your workload's revision history 🕰️
- Host: GitHub
- URL: https://github.com/timebertt/kubectl-revisions
- Owner: timebertt
- License: apache-2.0
- Created: 2023-08-09T06:55:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T17:07:49.000Z (5 months ago)
- Last Synced: 2024-05-29T07:17:33.139Z (5 months ago)
- Topics: kubectl, kubectl-plugin, kubernetes
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kubectl-revisions
🚀 *Time-travel through your workload revision history* 🕰️
## About
`kubectl-revisions` is a [kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) and can be invoked as `kubectl revisions`, or for short `k revisions`.
The `revisions` plugin allows you to go back in time in the history of revisions and answers common questions like "Why was my Deployment rolled?"
It gives more output than `kubectl rollout history` and is easier to use than `kubectl get replicaset` or `kubectl get controllerrevision`.
## Installation
Using [krew](https://krew.sigs.k8s.io/) (recommended):
```bash
kubectl krew install revisions
```
Using go:
```bash
go install github.com/timebertt/kubectl-revisions@latest
```
Set up shell completion ([docs](docs/kubectl_revisions_completion.md)):
```bash
kubectl revisions completion -h
```
## Usage
Also see the [reference docs](docs/kubectl_revisions.md).
### `k revisions get` / `k revisions list`
Get the revision history of a workload resource (`Deployment`, `StatefulSet`, or `DaemonSet`).
The history is based on the `ReplicaSets`/`ControllerRevisions` still in the system. I.e., the history is limited by the
configured `revisionHistoryLimit`.
By default, all revisions are printed as a list. If the `--revision` flag is given, the selected revision is printed
instead.
This is similar to using `k get replicaset` or `k get controllerrevision`, but allows easy selection of the relevant objects and returns a sorted list.
This is also similar to `k rollout history`, but doesn't only print revision numbers.
### `k revisions diff` / `k revisions why`
Compare multiple revisions of a workload resource (`Deployment`, `StatefulSet`, or `DaemonSet`).
A.k.a., "Why was my Deployment rolled?"
The history is based on the `ReplicaSets`/`ControllerRevisions` still in the system. I.e., the history is limited by the
configured `revisionHistoryLimit`.
By default, the latest two revisions are compared. The `--revision` flag allows selecting the revisions to compare.
The `k revisions diff` command uses `diff -u -N` to compare revisions by default.
It also respects the `KUBECTL_EXTERNAL_DIFF` environment variable like the `kubectl diff` command.
To get a nicer diff output, you can use one of these:
```bash
# Use a colored external diff program
export KUBECTL_EXTERNAL_DIFF="colordiff -u"
# Use dyff as a rich diff program
export KUBECTL_EXTERNAL_DIFF="dyff between --omit-header"
# Show diff in VS Code
export KUBECTL_EXTERNAL_DIFF="code --diff --wait"
```
For example:
