ContextQMD
Back to Kubebuilder

[Default Scaffold] Kustomize v2

docs/book/src/plugins/kustomize-v2.md

4.13.15.8 KB
Original Source

[Default Scaffold] Kustomize v2

The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language base plugin base.go.kubebuilder.io/v4. This plugin is used to generate the manifest under config/ directory for the projects build within the go/v4 plugin (default scaffold).

Note that projects such as Operator-sdk consume the Kubebuilder project as a lib and provide options to work with other languages like Ansible and Helm. The kustomize plugin allows them to easily keep a maintained configuration and ensure that all languages have the same configuration. It is also helpful if you are looking to provide nice plugins which will perform changes on top of what is scaffolded by default. With this approach we do not need to keep manually updating this configuration in all possible language plugins which uses the same and we are also able to create "helper" plugins which can work with many projects and languages.

<aside class="note"> <h1>Examples</h1>

You can check the kustomize content by looking at the config/ directory provide on the sample project-v4-* under the testdata directory of the Kubebuilder project.

</aside>

When to use it

  • If you are looking to scaffold the kustomize configuration manifests for your own language plugin
  • If you are looking for support on Apple Silicon (darwin/arm64). (Before kustomize 4.x the binary for this plataform is not provided)
  • If you are looking for to begin to try out the new syntax and features provide by kustomize v4 (More info) and v5 (More info)
  • If you are NOT looking to build projects which will be used on Kubernetes cluster versions < 1.22 (The new features provides by kustomize v4 are not officially supported and might not work with kubectl < 1.22)
  • If you are NOT looking to rely on special URLs in resource fields
  • If you want to use replacements since vars are deprecated and might be removed soon

How to use it

If you are looking to define that your language plugin should use kustomize use the Bundle Plugin to specify that your language plugin is a composition with your plugin responsible for scaffold all that is language specific and kustomize for its configuration, see:

go
import (
...
   kustomizecommonv2 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/common/kustomize/v2"
   golangv4 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4"
...
)

	// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v4
	// The follow code is creating a new plugin with its name and version via composition
	// You can define that one plugin is composite by 1 or Many others plugins
	gov3Bundle, _ := plugin.NewBundle(plugin.WithName(golang.DefaultNameQualifier),
		plugin.WithVersion(plugin.Version{Number: 3}),
        plugin.WithPlugins(kustomizecommonv2.Plugin{}, golangv4.Plugin{}), // scaffold the config/ directory and all kustomize files
		// Scaffold the Golang files and all that specific for the language e.g. go.mod, apis, controllers
	)

Also, with Kubebuilder, you can use kustomize/v2 alone via:

sh
kubebuilder init --plugins=kustomize/v2
$ ls -la
total 24
drwxr-xr-x   6 camilamacedo86  staff  192 31 Mar 09:56 .
drwxr-xr-x  11 camilamacedo86  staff  352 29 Mar 21:23 ..
-rw-------   1 camilamacedo86  staff  129 26 Mar 12:01 .dockerignore
-rw-------   1 camilamacedo86  staff  367 26 Mar 12:01 .gitignore
-rw-------   1 camilamacedo86  staff   94 31 Mar 09:56 PROJECT
drwx------   6 camilamacedo86  staff  192 31 Mar 09:56 config

Or combined with the base language plugins:

sh
# Provides the same scaffold of go/v4 plugin which is composition but with kustomize/v2
kubebuilder init --plugins=kustomize/v2,base.go.kubebuilder.io/v4 --domain example.org --repo example.org/guestbook-operator

Subcommands

The kustomize plugin implements the following subcommands:

  • init ($ kubebuilder init [OPTIONS])
  • create api ($ kubebuilder create api [OPTIONS])
  • create webhook ($ kubebuilder create api [OPTIONS])
<aside class="note"> <h1>Create API and Webhook</h1>

Its implementation for the subcommand create api will scaffold the kustomize manifests which are specific for each API, see here. The same applies to its implementation for create webhook.

</aside>

Affected files

The following scaffolds will be created or updated by this plugin:

  • config/*

Further resources