Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtan4/k8sec
CLI tool to manage Kubernetes Secrets easily
https://github.com/dtan4/k8sec
kubernetes kubernetes-secrets
Last synced: 3 days ago
JSON representation
CLI tool to manage Kubernetes Secrets easily
- Host: GitHub
- URL: https://github.com/dtan4/k8sec
- Owner: dtan4
- License: mit
- Created: 2016-05-17T06:33:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-21T10:47:58.000Z (21 days ago)
- Last Synced: 2024-11-29T01:43:57.585Z (13 days ago)
- Topics: kubernetes, kubernetes-secrets
- Language: Go
- Homepage:
- Size: 427 KB
- Stars: 258
- Watchers: 7
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kubernetes - K8sec - CLI tool to manage Kubernetes Secrets easily. (Tools)
- awesome-repositories - dtan4/k8sec - CLI tool to manage Kubernetes Secrets easily (Go)
README
# k8sec
[](https://github.com/dtan4/k8sec/actions?query=workflow%3ATest+branch%3Amaster)
[](https://codecov.io/gh/dtan4/k8sec)
[](https://github.com/dtan4/k8sec/releases)
CLI tool to manage [Kubernetes Secrets](http://kubernetes.io/docs/user-guide/secrets/) easily
## Requirements
Kubernetes 1.18 or above
## Installation
### Using Homebrew (OS X only)
Formula is available at [dtan4/homebrew-dtan4](https://github.com/dtan4/homebrew-tools).
```bash
brew tap dtan4/tools
brew install k8sec
```
### Precompiled binary
Precompiled binaries for Windows, OS X, Linux are available at [Releases](https://github.com/dtan4/k8sec/releases).
### From source
```sh-session
go get -d github.com/dtan4/k8sec
cd $GOPATH/src/github.com/dtan4/k8sec
make install
```
### Docker image
Docker image is no longer provided officially.
If you'd like to run k8sec in Docker image, see [`Dockerfile`](Dockerfile) and build image by yourself.
```bash
docker build -t k8sec .
```
## Usage
### Global options
|Option|Description|Required|Default|
|---------|-----------|-------|-------|
|`--context=CONTEXT`|Kubernetes context|||
|`--kubeconfig=KUBECONFIG`|Path of kubeconfig||`~/.kube/config`|
|`-n`, `--namespace=NAMESPACE`|Kubernetes namespace||`default`|
|`-h`, `-help`|Print command line usage|||
### `k8sec list`
List secrets
```sh-session
$ k8sec list [--base64] [NAME]
# Example
$ k8sec list rails
NAME TYPE KEY VALUE
rails Opaque database-url "postgres://example.com:5432/dbname"
# Show values as base64-encoded string
$ k8sec list --base64 rails
NAME TYPE KEY VALUE
rails Opaque database-url cG9zdGdyZXM6Ly9leGFtcGxlLmNvbTo1NDMyL2RibmFtZQ==
```
### `k8sec set`
Set secrets
```sh-session
$ k8sec set [--base64] NAME KEY1=VALUE1 [KEY2=VALUE2 ...]
$ k8sec set rails rails-env=production
rails
# Set base64-encoded value
$ echo -n dtan4 | base64
ZHRhbjQ=
$ k8sec set --base64 rails foo=ZHRhbjQ=
rails
# Result
$ k8sec list rails
NAME TYPE KEY VALUE
rails Opaque database-url "postgres://example.com:5432/dbname"
rails Opaque foo "dtan4"
```
### `k8sec unset`
Unset secrets
```sh-session
$ k8sec unset NAME KEY1 KEY2...
# Example
$ k8sec unset rails rails-env
```
### `k8sec load`
Load secrets from dotenv (key=value) format text
```sh-session
$ k8sec load [-f FILENAME] NAME
# Example
$ cat .env
database-url="postgres://example.com:5432/dbname"
$ k8sec load -f .env rails
# Load from stdin
$ cat .env | k8sec load rails
```
### `k8sec dump`
Dump secrets as dotenv (key=value) format
```sh-session
$ k8sec dump [-f FILENAME] [--noquotes] [NAME]
# Example
$ k8sec dump rails
database-url="postgres://example.com:5432/dbname"
# Save as .env
$ k8sec dump -f .env rails
$ cat .env
database-url="postgres://example.com:5432/dbname"
# Save as .env without qoutes
$ k8sec dump -f .env --noquotes rails
$ cat .env
database-url=postgres://example.com:5432/dbname
```
## Contribution
1. Fork ([https://github.com/dtan4/k8sec/fork](https://github.com/dtan4/k8sec/fork))
1. Create a feature branch
1. Commit your changes
1. Rebase your local changes against the master branch
1. Run test suite with the `go test ./...` command and confirm that it passes
1. Run `gofmt -s`
1. Create a new Pull Request
## Author
[dtan4](https://github.com/dtan4)
## License
[](LICENSE)