Update docs for version 1.5.0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 1.5.0
+
+* Allow plugin to be called as a [KRM Function][krm]. ([Ahmed AbouZaid](https://github.com/aabouzaid))
+
+[krm]: https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md
+
 ## Version 1.4.1
 
 * Update indirect dependencies and build with go 1.17
@@ -10,9 +16,11 @@
 
 ## Version 1.3.3
 
-* Update sops dependency to 3.7.1 to support [age](https://age-encryption.org/)-encrypted secrets.
+* Update sops dependency to 3.7.1 to support [age][age]-encrypted secrets.
 * Migrate CI to GitHub Actions.
 
+[age]: https://age-encryption.org/
+
 ## Version 1.3.2
 
 * Support files encrypted using sops versions 3.6.1 and 3.5. No longer supports
@@ -29,13 +37,17 @@
 ## Version 1.2.2
 
 * Improve messages for sops errors.
-* Document integration with [ArgoCD](https://github.com/argoproj/argo-cd). ([Leland Sindt](https://github.com/LelandSindt))
+* Document integration with [ArgoCD][argo]. ([Leland Sindt](https://github.com/LelandSindt))
 * Link to alternative plugins.
 
+[argo]: https://github.com/argoproj/argo-cd
+
 ## Version 1.2.1
 
 * Fix sops dependency.
-* Use [goreleaser](https://goreleaser.com) for releases.
+* Use [goreleaser][gr] for releases.
+
+[gr]: https://goreleaser.com/
 
 ## Version 1.2.0
 

README.md

@@ -15,6 +15,8 @@ SecretGenerator ❤ sops
 
 This Kustomize plugin allows you to create Secrets transparently from sops-encrypted files during resource generation. It is explicitly modeled after the builtin [SecretGenerator](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/plugins/builtins.md#secretgenerator) plugin. Because it is an exec plugin, it is not tied to the specific compilation of Kustomize, [like Go plugins are](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/plugins/goPluginCaveats.md).
 
+Since version 1.5.0, the plugin can be used as a [KRM Function](https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md).
+
 Credit goes to [Seth Pollack](https://github.com/sethpollack) for the [Kustomize Secret Generator Plugins KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-cli/kustomize-secret-generator-plugins.md) and subsequent implementation that made this possible.
 
 
@@ -25,9 +27,9 @@ Download the `SopsSecretGenerator` binary for your platform from the
 move it to `$XDG_CONFIG_HOME/kustomize/plugin/goabout.com/v1beta1/sopssecretgenerator`. (By default,
 `$XDG_CONFIG_HOME` points to `$HOME/.config` on Linux and OS X, and `%LOCALAPPDATA%` on Windows.)
 
-For example, to install version 1.4.1 on Linux:
+For example, to install version 1.5.0 on Linux:
 
-    VERSION=1.4.1 PLATFORM=linux ARCH=amd64
+    VERSION=1.5.0 PLATFORM=linux ARCH=amd64
     curl -Lo SopsSecretGenerator https://github.com/goabout/kustomize-sopssecretgenerator/releases/download/v${VERSION}/SopsSecretGenerator_${VERSION}_${PLATFORM}_${ARCH}
     chmod +x SopsSecretGenerator
     mkdir -p "${XDG_CONFIG_HOME:-$HOME/.config}/kustomize/plugin/goabout.com/v1beta1/sopssecretgenerator"
@@ -38,6 +40,8 @@ You do not need to install the `sops` binary for the plugin to work. The plugin
 
 ## Usage
 
+**Note:** This section documents legacy exec plugin usage. Usage as a KRM Function is also supported but not yet documented.
+
 Create some encrypted values using `sops`:
 
     echo FOO=secret >secret-vars.env
@@ -64,9 +68,9 @@ Add a generator to your kustomization:
       - secret-file.txt
     .
       
-Run `kustomize build` with the `--enable_alpha_plugins` flag:
+Run `kustomize build` with the `--enable-alpha-plugins` flag:
 
-    kustomize build --enable_alpha_plugins
+    kustomize build --enable-alpha-plugins
 
 The output is a Kubernetes secret containing the decrypted data:
 

docs/argocd.md

@@ -30,7 +30,7 @@ Use a kustomize [patchStrategicMerge](https://github.com/kubernetes-sigs/kustomi
                   name: custom-tools
               env:
                 - name: VERSION
-                  value: 1.4.1
+                  value: 1.5.0
                 - name: PLATFORM
                   value: linux
                 - name: ARCH