A CLI tool for querying and transforming YAML data: Grep matching objects, join YAML documents, get/add/edit/delete YAML nodes matching given selector, loop over objects and/or data arrays etc.
[input.yml] => [query or transformations] => [output.yml]
Note: The input YAML data might contain multiple YAML documents separated by ---
.
- One-liner commands
- Grep YAML documents (objects)
- Useful Kubernetes examples
- Known issues
- Transformation files
- Feedback
- License
Get value of a node matching the given selector.
$ kubectl get pod/nats-8576dfb67-vg6v7 -o yaml | yaml get spec.containers[0].image
nats-streaming:0.10.0
Print full node matching the given selector.
$ kubectl get pod/nats-8576dfb67-vg6v7 -o yaml | yaml print kind apiVersion metadata.annotations
kind: Pod
apiVersion: v1
metadata.annotations:
kubernetes.io/psp: eks.privileged
Add/overwrite field's value.
$ cat input.yml | yaml set "metadata.labels.environment: staging" > output.yml
Set field's value, if no such value exists yet.
$ cat input.yml | yaml default "metadata.labels.environment: staging" > output.yml
Delete specific field.
$ cat input.yml | yaml delete "metadata.labels.environment" > output.yml
Join multiple YAML files into a single file with multiple documents separated by ---
.
$ yaml cat k8s-apps/*.yml > output.yml
Print number of YAML documents within the input YAML stream.
input.yml
document: this is doc 1
---
document: this is doc 2
$ yaml count input.yml
2
Print Nth (index=0..N-1) YAML document from the input YAML stream.
input.yml
document: this is doc 1
---
document: this is doc 2
$ yaml doc 1
document: this is doc 2
Print number of items within an array matching the given selector.
Useful for ranging over arrays.
pods=$(kubectl get pods -o yaml)
count=$(echo "$pods" | yaml len items)
for ((i=0; i < $count; i++)); do
echo "$pods" | yaml get items[$i].status.phase
done
Grep documents/objects matching all of the given selector: value
pairs.
If a provided value is an array (ie. selector: [first, second]
), the matching value must match at least one of the provided values (logical "OR").
$ cat desired-state.yml | yaml grep "kind: Deployment" "metadata.name: linkerd"
Inverse grep.
$ cat desired-state.yml | yaml grep -v "kind: [Deployment, Pod, Job, ReplicaSet, ReplicationController]"
$ cat linkerd.yml | yaml grep "kind: Deployment" | yaml get "spec.template.spec.containers[0].image"
gcr.io/linkerd-io/controller:stable-2.4.0
gcr.io/linkerd-io/controller:stable-2.4.0
gcr.io/linkerd-io/web:stable-2.4.0
prom/prometheus:v2.10.0
gcr.io/linkerd-io/grafana:stable-2.4.0
gcr.io/linkerd-io/controller:stable-2.4.0
gcr.io/linkerd-io/controller:stable-2.4.0
gcr.io/linkerd-io/controller:stable-2.4.0
$ cat desired-state.yml | yaml grep -v "kind: [Deployment, Pod, Job]"
$ for file in *.yml; do
out=$(cat $file | yaml grep "kind: Deployment" | kubectl apply -f -)
for deploy in $(echo "$out" | cut -d' ' -f1); do
kubectl rollout status --timeout 180s $deploy || {
kubectl rollout undo $deploy
exit 1
}
done
done
- Merging complex nodes doesn't work well
set:
metadata:
we:
cant:
merge:
complex: objects
such:
as: this
properly:
just: yet
We'll want to fix this later. For now, use explicit paths to the final nodes:
set:
metadata.we.cant.merge.complex: objects
metadata.we.cant.merge.such.as: this
metadata.we.cant.merge.such.properly.just: yet
- Wildcard array[*] matching doesn't work yet
match:
spec.template.spec.containers[*].name: prometheus
- Selectors with
.
dots in the selector path, ie.
metadata:
annotations:
linkerd.io/inject: enabled
Since the match
selectors are separated with .
dots, we'll have to figure out how to support these selector keys with inner .
dots.
We might wanna support
delete:
- metadata.annotations."linkerd.io/inject"
set:
metadata.annotations."rbac.authorization.kubernetes.io/autoupdate": true
All of the above examples, and more, can be described in YAML transformation file syntax. Multiple such transformations can be applied at once.
Apply multiple YAML "transformations", see the .yt
file syntax below.
$ yaml cat k8s-apps/*.yml | yaml apply staging.yt enable-linkerd.yt > staging/desired-state.yml
staging.yt:
match:
# all YAML objects
set:
metadata.labels.environment: staging
---
match:
kind: Deployment
metadata.name: api
set:
metadata.labels.first: updated-label
spec.replicas: 3
enable-linkerd.yt:
match:
kind: [Deployment, Pod]
default:
metadata.annotations:
linkerd.io/inject: enabled
Changes applied to the original object:
apiVersion: apps/v1
kind: Deployment
metadata:
name: api
labels:
- first: label
+ first: updated-label
second: label
+ environment: staging
+ annotations:
+ linkerd.io/inject: enabled
spec:
- replicas: 1
+ replicas: 3
...
match:
kind: Deployment
set:
spec.template.spec.containers[*]:
imagePullPolicy: IfNotPresent
match:
kind: Deployment
set:
spec.template.spec.nodeSelector:
worker: generic
match:
kind: Deployment
metadata.name: api
set:
spec.replicas: 3
match:
kind: Ingress
set:
metadata:
annotations:
kubernetes.io/ingress.class: nginx
match:
kind: Deployment
delete: spec.replicas
match:
kind: Deployment
spec.template.spec.containers[0].image: nats-streaming
set:
spec.template.spec.containers[0].image: nats-streaming:0.15.1
Any feedback welcome! Please open issues and feature requests..
Licensed under the MIT License.