https://github.com/elsesiy/kubectl-view-secret
Kubernetes CLI plugin to decode Kubernetes secrets
https://github.com/elsesiy/kubectl-view-secret
Last synced: 10 days ago
JSON representation
Kubernetes CLI plugin to decode Kubernetes secrets
- Host: GitHub
- URL: https://github.com/elsesiy/kubectl-view-secret
- Owner: elsesiy
- License: mit
- Created: 2019-10-21T04:44:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T20:06:31.000Z (8 months ago)
- Last Synced: 2024-10-13T14:25:55.489Z (6 months ago)
- Language: Go
- Size: 410 KB
- Stars: 301
- Watchers: 7
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesomeness - kubectl-view-secret - Decode Kubernetes secrets easily. (📦 Containers / ☸️ Kubernetes)
- awesome-starred - elsesiy/kubectl-view-secret - Kubernetes CLI plugin to decode Kubernetes secrets (others)
- awesome-kubectl-plugins - kubectl view-secret - view-secret)](https://github.com/elsesiy/kubectl-view-secret/stargazers) | (kubectl Plugins / Installing plugins via awesome-kubectl-plugins)
README
# kubectl-view-secret
[](https://goreportcard.com/report/github.com/elsesiy/kubectl-view-secret)
[](https://codecov.io/github/elsesiy/kubectl-view-secret)
[](http://twitter.com/elsesiy)
[](https://github.com/elsesiy/kubectl-view-secret/releases)
This plugin allows for easy secret decoding. Useful if you want to see what's inside of a secret without always go through the following:
1. `kubectl get secret -o yaml`
2. Copy base64 encoded secret
3. `echo "b64string" | base64 -d`
Instead you can now do:
# print secret keys
kubectl view-secret
# decode specific entry
kubectl view-secret
# decode all contents
kubectl view-secret -a/--all
# print keys for secret in different namespace
kubectl view-secret -n/--namespace
# print keys for secret in different context
kubectl view-secret -c/--context
# print keys for secret by providing kubeconfig
kubectl view-secret -k/--kubeconfig
# suppress info output
kubectl view-secret -q/--quiet
## Usage
### Krew
This plugin is available through [krew](https://krew.dev) via:
```sh
kubectl krew install view-secret
```
### Binary releases
#### GitHub
You can find the latest binaries in the [releases](https://github.com/elsesiy/kubectl-view-secret/releases) section.
To install it, place it somewhere in your `$PATH` for `kubectl` to pick it up.
**Note**: If you build from source or download the binary, you'll have to change the name of the binary to `kubectl-view_secret` (`-` to `_` in `view-secret`)
due to the enforced naming convention for plugins by `kubectl`. More on this [here](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/#naming-a-plugin).
#### AUR package
Thanks to external contributions the plugin is available in the Arch user repository.
| Package | Contributor |
| -- | -- |
| [bin](https://aur.archlinux.org/packages/kubectl-view-secret-bin) | [@jocelynthode](https://github.com/jocelynthode) |
| [git](https://aur.archlinux.org/packages/kubectl-view-secret-git) | [@aryklein](https://github.com/aryklein) |
#### Nix
You can install the latest version from Nixpkgs ([24.11](https://search.nixos.org/packages?channel=24.11&show=kubectl-view-secret&from=0&size=50&sort=relevance&type=packages&query=kubectl-view-secret), [unstable](https://search.nixos.org/packages?channel=unstable&show=kubectl-view-secret&from=0&size=50&sort=relevance&type=packages&query=kubectl-view-secret)) or try it via a temporary nix-shell:
```
nix-shell -p kubectl-view-secret
```
### Build from source
# Clone this repository (or your fork)
git clone https://github.com/elsesiy/kubectl-view-secret
cd kubectl-view-secret
make
## License
This repository is available under the [MIT license](https://choosealicense.com/licenses/mit/).