-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1488 from yujunz/plugin/go-getter
Add example plugin for go-getter
- Loading branch information
Showing
5 changed files
with
314 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # Remote Sources | ||
|
|
||
| Kustomize supports building a [remote target], but the URLs are limited to common [Git repository specs]. | ||
|
|
||
| To extend the supported format, Kustomize has a [plugin] system that allows one to integrate third-party tools such as [hashicorp/go-getter] to "download things from a string URL suing a variety of protocols", extract the content and generated resources as part of kustomize build. | ||
|
|
||
| [remote target]: https://github.com/kubernetes-sigs/kustomize/blob/master/examples/remoteBuild.md | ||
| [Git repository specs]: https://github.com/kubernetes-sigs/kustomize/blob/master/pkg/git/repospec_test.go | ||
| [plugin]: ../docs/plugins | ||
| [hashicorp/go-getter]: https://github.com/hashicorp/go-getter | ||
|
|
||
| ## Make a place to work | ||
|
|
||
| <!-- @makeWorkplace @test --> | ||
| ```sh | ||
| DEMO_HOME=$(mktemp -d) | ||
| mkdir -p $DEMO_HOME/base | ||
| ``` | ||
|
|
||
| ## Use a remote kustomize layer | ||
|
|
||
| Define a kustomization representing your _local_ variant (aka environment). | ||
|
|
||
| This could involve any number of kustomizations (see other examples), but in this case just add the name prefix `my-` to all resources: | ||
|
|
||
| <!-- @writeKustLocal @test --> | ||
| ```sh | ||
| cat <<'EOF' >$DEMO_HOME/kustomization.yaml | ||
| namePrefix: my- | ||
| resources: | ||
| - base/ | ||
| EOF | ||
| ``` | ||
|
|
||
| It refer a remote base defined as below: | ||
|
|
||
| <!-- @writeKustLocal @test --> | ||
| ```sh | ||
| cat <<'EOF' >$DEMO_HOME/base/kustomization.yaml | ||
| generators: | ||
| - goGetter.yaml | ||
| EOF | ||
| ``` | ||
|
|
||
| The base refers to a generator configuration file called `goGetter.yaml`. | ||
|
|
||
| This file lets one specify the source URL, and other things like sub path in the package, defaulting to base directory, and command to run under the path, defaulting to `kustomize build`. | ||
|
|
||
| Create the config file `goGetter.yaml`, specifying the arbitrarily chosen name _example_: | ||
|
|
||
| <!-- @writeGeneratorConfig @test --> | ||
| ```sh | ||
| cat <<'EOF' >$DEMO_HOME/base/goGetter.yaml | ||
| apiVersion: someteam.example.com/v1 | ||
| kind: GoGetter | ||
| metadata: | ||
| name: example | ||
| url: github.com/kustless/kustomize-examples.git | ||
| EOF | ||
| ``` | ||
|
|
||
| Because this particular YAML file is listed in the `generators:` stanza of a kustomization file, it is treated as the binding between a generator plugin - identified by the _apiVersion_ and _kind_ fields - and other fields that configure the plugin. | ||
|
|
||
| Download the plugin to your `DEMO_HOME` and make it executable: | ||
|
|
||
| <!-- @installPlugin @test --> | ||
| ```sh | ||
| plugin=plugin/someteam.example.com/v1/gogetter/GoGetter | ||
| curl -s --create-dirs -o \ | ||
| "$DEMO_HOME/kustomize/$plugin" \ | ||
| "https://raw.githubusercontent.com/\ | ||
| kubernetes-sigs/kustomize/master/$plugin" | ||
|
|
||
| chmod a+x $DEMO_HOME/kustomize/$plugin | ||
| ``` | ||
|
|
||
| Define a helper function to run kustomize with the correct environment and flags for plugins: | ||
|
|
||
| <!-- @defineKustomizeIt @test --> | ||
| ```sh | ||
| function kustomizeIt { | ||
| XDG_CONFIG_HOME=$DEMO_HOME \ | ||
| kustomize build --enable_alpha_plugins \ | ||
| $DEMO_HOME/$1 | ||
| } | ||
| ``` | ||
|
|
||
| Finally, build the local variant. Notice that all | ||
| resource names now have the `my-` prefix: | ||
|
|
||
| <!-- @doLocal @test --> | ||
| ```sh | ||
| clear | ||
| kustomizeIt | ||
| ``` | ||
|
|
||
| Compare local variant to remote base: | ||
|
|
||
| <!-- @doCompare @test--> | ||
| ```sh | ||
| diff <(kustomizeIt) <(kustomizeIt base) | more | ||
|
|
||
| ... | ||
| < name: my-remote-cm | ||
| --- | ||
| > name: remote-cm | ||
| ``` | ||
|
|
||
| To see the unmodified but extracted sources, run kustomize on the base. Every invocation here is re-downloading and re-building the package. | ||
|
|
||
| <!-- @showBase @test --> | ||
| ```sh | ||
| kustomizeIt base | ||
| ``` | ||
|
|
||
| ## Use non-kustomize remote sources | ||
|
|
||
| Sometimes the remote sources does not include `kustomization.yaml`. To use that in the plugin, set command to override the default build. | ||
|
|
||
| <!-- @setCommand @test --> | ||
| ```sh | ||
| echo "command: cat resources.yaml" >>$DEMO_HOME/base/goGetter.yaml | ||
| ``` | ||
|
|
||
| Finally, built it | ||
|
|
||
| <!-- @finalLocal @test --> | ||
| ```sh | ||
| kustomizeIt | ||
| ``` | ||
|
|
||
| and observe the output includes raw `resources.yaml` instead of building result of remote `kustomization.yaml`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| #!/bin/bash | ||
| # Copyright 2019 The Kubernetes Authors. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # HashiCorp go-getter | ||
| # | ||
| # Reads a file like this | ||
| # | ||
| # apiVersion: someteam.example.com/v1 | ||
| # kind: GoGetter | ||
| # metadata: | ||
| # name: example | ||
| # url: github.com/kustless/kustomize-examples.git | ||
| # # subPath: base # (optional) relative path in the package | ||
| # # command: cat *.yaml # (optional) build command, default `kustomize build $subPath` | ||
| # | ||
| # download kustomize layes and build it to stdout | ||
| # | ||
| # Example execution: | ||
| # ./plugin/someteam.example.com/v1/gogetter/GoGetter configFile.yaml | ||
| # | ||
| # TODO: cache downloads | ||
|
|
||
| set -e | ||
|
|
||
| # YAML parsing function borrowed from ChartInflator | ||
| function parseYaml { | ||
| local file=$1 | ||
| while read -r line | ||
| do | ||
| local k=${line%:*} | ||
| local v=${line#*:} | ||
| local t=${v#"${v%%[![:space:]]*}"} # trim leading space | ||
|
|
||
| if [ "$k" == "url" ]; then url=$t | ||
| elif [ "$k" == "subPath" ]; then subPath=$t | ||
| elif [ "$k" == "command" ]; then command=$t | ||
| fi | ||
| done <"$file" | ||
| } | ||
|
|
||
| TMP_DIR=$(mktemp -d) | ||
|
|
||
| parseYaml $1 | ||
|
|
||
| if [ -z "$command" ]; then | ||
| command="kustomize build" | ||
| fi | ||
|
|
||
| go-getter $url $TMP_DIR/got 2> /dev/null | ||
|
|
||
| (cd $TMP_DIR/got/$subPath; $command) | ||
|
|
||
| /bin/rm -rf $TMP_DIR |
105 changes: 105 additions & 0 deletions
105
plugin/someteam.example.com/v1/gogetter/GoGetter_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| // +build notravis | ||
|
|
||
| // Copyright 2019 The Kubernetes Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| // Disabled on travis, because don't want to install go-getter on travis. | ||
|
|
||
| package main_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| kusttest_test "sigs.k8s.io/kustomize/v3/pkg/kusttest" | ||
| plugins_test "sigs.k8s.io/kustomize/v3/pkg/plugins/test" | ||
| ) | ||
|
|
||
| // This test requires having the go-getter binary on the PATH. | ||
| // | ||
| func TestGoGetter(t *testing.T) { | ||
| tc := plugins_test.NewEnvForTest(t).Set() | ||
| defer tc.Reset() | ||
|
|
||
| tc.BuildExecPlugin( | ||
| "someteam.example.com", "v1", "GoGetter") | ||
|
|
||
| th := kusttest_test.NewKustTestPluginHarness(t, "/app") | ||
|
|
||
| m := th.LoadAndRunGenerator(` | ||
| apiVersion: someteam.example.com/v1 | ||
| kind: GoGetter | ||
| metadata: | ||
| name: example | ||
| url: github.com/kustless/kustomize-examples.git?ref=adef0a8 | ||
| `) | ||
|
|
||
| th.AssertActualEqualsExpected(m, ` | ||
| apiVersion: v1 | ||
| data: | ||
| altGreeting: Good Morning! | ||
| enableRisky: "false" | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: remote-cm | ||
| `) | ||
| } | ||
|
|
||
| func TestGoGetterCommand(t *testing.T) { | ||
| tc := plugins_test.NewEnvForTest(t).Set() | ||
| defer tc.Reset() | ||
|
|
||
| tc.BuildExecPlugin( | ||
| "someteam.example.com", "v1", "GoGetter") | ||
|
|
||
| th := kusttest_test.NewKustTestPluginHarness(t, "/app") | ||
|
|
||
| m := th.LoadAndRunGenerator(` | ||
| apiVersion: someteam.example.com/v1 | ||
| kind: GoGetter | ||
| metadata: | ||
| name: example | ||
| url: github.com/kustless/kustomize-examples.git?ref=adef0a8 | ||
| command: cat resources.yaml | ||
| `) | ||
|
|
||
| th.AssertActualEqualsExpected(m, ` | ||
| apiVersion: v1 | ||
| data: | ||
| altGreeting: Good Morning! | ||
| enableRisky: "false" | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: cm | ||
| `) | ||
| } | ||
|
|
||
|
|
||
| func TestGoGetterSubPath(t *testing.T) { | ||
| tc := plugins_test.NewEnvForTest(t).Set() | ||
| defer tc.Reset() | ||
|
|
||
| tc.BuildExecPlugin( | ||
| "someteam.example.com", "v1", "GoGetter") | ||
|
|
||
| th := kusttest_test.NewKustTestPluginHarness(t, "/app") | ||
|
|
||
| m := th.LoadAndRunGenerator(` | ||
| apiVersion: someteam.example.com/v1 | ||
| kind: GoGetter | ||
| metadata: | ||
| name: example | ||
| url: github.com/kustless/kustomize-examples.git?ref=9ca07d2 | ||
| subPath: dev | ||
| command: kustomize build --enable_alpha_plugins | ||
| `) | ||
|
|
||
| th.AssertActualEqualsExpected(m, ` | ||
| apiVersion: v1 | ||
| data: | ||
| altGreeting: Good Morning! | ||
| enableRisky: "false" | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: dev-remote-cm | ||
| `) | ||
| } |