ykre/README.md

47 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2020-10-08 16:40:35 +00:00
# Ykre
**Ykre** is a small cli program written in rust wich purpose is to extract from a list
of yaml documents, documents matching a specified condition. **Ykre** goal is to find
specific Kubernetes Resource from the kustomize output.
2020-10-11 23:04:40 +00:00
**Ykre** stands for **Y**aml **K**ubernetes **R**esources **E**xtractor.
2020-10-08 16:40:35 +00:00
2020-10-09 20:27:36 +00:00
## Install
from a debian package :
``` 
2020-10-11 23:04:40 +00:00
wget -q https://github.com/pluie-org/ykre/raw/master/dist/ykre_0.2.0_amd64.deb
sudo apt install ./ykre_0.2.0_amd64.deb
2020-10-09 20:27:36 +00:00
```
via Cargo
``` 
wget -q -O - https://github.com/pluie-org/ykre/raw/master/install.sh | sh
```
## Usage
2020-10-08 16:40:35 +00:00
```
ykre SEARCH [DEF]
```
## examples
display content of the kubernetes resource 'myResourceName'
```
cat kubresources.yaml | ykre 'myResourceName'
```
write content of the kubernetes resource 'pv-dump' into a file
```
kustomize build ./config/volumes/local | ykre 'pv-dump' > ./tmp.yaml
```
retriew kubernetes pv resources matching 2Gi disk capacity
```
kustomize build ./config/volumes/dev | ykre 2Gi spec.capacity.storage
```
## License
MIT