feat: add plugin code, dockerfile, and docs

This commit is contained in:
2026-05-07 16:24:25 +06:00
commit 08a587b336
5 changed files with 90 additions and 0 deletions

0
.dockerignore Normal file
View File

8
Dockerfile Normal file
View File

@ -0,0 +1,8 @@
ARG YQVERSION=4.48.1
FROM mikefarah/yq:${YQVERSION}
COPY --link --chmod=755 YqTransformer.sh /usr/local/bin/YqTransformer.sh
USER root
RUN apk add --no-cache bash
USER 1000
ENTRYPOINT ["/usr/local/bin/YqTransformer.sh"]

18
LICENSE Normal file
View File

@ -0,0 +1,18 @@
MIT License
Copyright (c) 2026 bdeshi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.

5
README.md Normal file
View File

@ -0,0 +1,5 @@
# kustomize-plugin-yqtransformer
This is a Kustomize plugin that modifies resources with [yq][yq] expressions.
[yq]: https://github.com/mikefarah/yq

59
YqTransformer.sh Executable file
View File

@ -0,0 +1,59 @@
#!/bin/bash
# this kustomize transformer plugin modifies resources with yq expressions.
# the plugin accepts the following manifest structure:
# ```yaml
# targets:
# - <target filter>
# expression: <yq expression>
# ```
# where each `target filter` is a partial resource manifest. the `yq expression`
# is applied to any resources that match *all attributes* in any target filter.
set -euo pipefail
# collect inputs
resource_list="$(</dev/stdin)"
configuration="$(yq '.functionConfig' -<<< "$resource_list")"
# extract configuration values
expression=$(echo "$configuration" | yq '.expression // "."')
target_list=$(yq '.targets // []' -<<< "$configuration")
target_count=$(yq '. | length' -<<< "$target_list")
resource_count=$(yq '.items | length' -<<< "$resource_list")
# if there are no targets, output the manifest as-is
if [ "$target_count" -eq 0 ]; then
echo "$resource_list"
exit 0
fi
# loop over each resource document in the manifest
for resource_index in $(seq 0 $((resource_count - 1))); do
resource=$(yq ".items[$resource_index]" -<<< "$resource_list")
comparison="continue"
# try to match the resource against each target filter
for target_index in $(seq 0 $((target_count - 1))); do
target=$(yq ".[$target_index]" -<<< "$target_list")
# compare sorted key-value pairs and print any leftover keys in target
comparison=$(comm -23 \
<(yq -oprops 'sort_keys(..)' -<<< "$target") \
<(yq -oprops 'sort_keys(..)' -<<< "$resource") \
)
# $comparison is empty means no leftover keys, so a target matched
[ -z "$comparison" ] && break
done
if [ -z "$comparison" ]; then
# apply yq expression on current resource
update=$(yq eval "$expression" -<<< "$resource")
# replace current resource in the manifest with updated version
resource_list=$( \
yq eval-all \
"select(fi==0).items[$resource_index] = select(fi==1) | select(fi==0)" \
<(echo "$resource_list") <(echo "$update") \
)
fi
done
echo "$resource_list"