operator-sdk alpha config-gen

operator-sdk alpha config-gen

Generate configuration for controller-runtime based projects

Synopsis

config-gen programatically generates configuration for a controller-runtime based project using the project source code (golang) and a KubebuilderConfigGen resource file.

This is an alternative to expressing configuration as a static set of kustomize patches in the “config” directory.

config-gen may be used as a standalone command run against a file, as a kustomize transformer plugin, or as a configuration function (e.g. kpt).

config-gen uses the controller-tools generators to generate CRDs from the go source and then generates additional resources such as the namespace, controller-manager, webhooks, etc.

Following is an example KubebuilderConfigGen resource used by config-gen:

kubebuilderconfiggen.yaml

this resource describes how to generate configuration for a controller-runtime

based project

apiVersion: kubebuilder.sigs.k8s.io/v1alpha1 kind: KubebuilderConfigGen metadata: name: my-project-name spec: controllerManager: image: my-org-name/my-project-name:v0.1.0

If this file was at the project source root, config-gen could be used to emit configuration using:

kubebuilder alpha config-gen ./kubebuilderconfiggen.yaml

The KubebuilderConfigGen resource has the following fields:

apiVersion: kubebuilder.sigs.k8s.io/v1alpha1 kind: KubebuilderConfigGen

metadata: # name of the project. used in various resource names. # required name: project-name

  1. # namespace for the project
  2. # optional -- defaults to "${metadata.name}-system"
  3. namespace: project-namespace

spec: # configure how CRDs are generated crds: # path to go module source directory provided to controller-gen libraries # optional – defaults to ‘.’ sourceDirectory: ./relative/path

  1. # configure how the controller-manager is generated
  2. controllerManager:
  3.   # image to run
  4.   image: my-org/my-project:v0.1.0
  6.   # if set, use component config for the controller-manager
  7.   # optional
  8.   componentConfig:
  9.     # use component config
  10.     enable: true
  12.     # path to component config to put into a ConfigMap
  13.     configFilepath: ./path/to/componentconfig.yaml
  15.   # configure how metrics are exposed
  16.   metrics:
  17.     # disable the auth proxy required for scraping metrics
  18.     # disable: false
  20.     # generate prometheus ServiceMonitor resource
  21.     enableServiceMonitor: true
  23. # configure how webhooks are generated
  24. # optional -- defaults to not generating webhook configuration
  25. webhooks:
  26.   # enable will cause webhook config to be generated
  27.   enable: true
  29.   # configures crds which use conversion webhooks
  30.   enableConversion:
  31.     # key is the name of the CRD
  32.     "bars.example.my.domain": true
  34.   # configures where to get the certificate used for webhooks
  35.   # discriminated union
  36.   certificateSource:
  37.     # type of certificate source
  38.     # one of ["certManager", "dev", "manual"] -- defaults to "manual"
  39.     # certManager: certmanager is used to manage certificates -- requires CertManager to be installed
  40.     # dev: certificate is generated and wired into resources
  41.     # manual: no certificate is generated or wired into resources
  42.     type: "dev"
  44.     # options for a dev certificate -- requires "dev" as the type
  45.     devCertificate:
  46.       duration: 1h
  1. operator-sdk alpha config-gen PROJECT_FILE [RESOURCE_PATCHES...] [flags]

Examples

  1. #
  2. # As command
  3. #
  4. # create the kubebuilderconfiggen.yaml at project root
  5. cat > kubebuilderconfiggen.yaml <<EOF
  6. apiVersion: kubebuilder.sigs.k8s.io/v1alpha1
  7.   kind: KubebuilderConfigGen
  8.   metadata:
  9.     name: project
  10.   spec:
  11.     controllerManager
  12.       image: org/project:v0.1.0
  13. EOF
  15. # run the config generator
  16. kubebuilder alpha config-gen kubebuilderconfiggen.yaml
  18. # run the config generator and apply
  19. kubebuilder alpha config-gen kubebuilderconfiggen.yaml | kubectl apply -f -
  21. # generate configuration from a file with patches
  22. kubebuilder alpha config-gen kubebuilderconfiggen.yaml patch1.yaml patch2.yaml
  24. #
  25. # As Kustomize plugin
  26. # this allows using config-gen with kustomize features such as patches, commonLabels,
  27. # commonAnnotations, resources, configMapGenerator and other transformer plugins.
  28. #
  30. # install the latest kustomize
  31. GO111MODULE=on go get sigs.k8s.io/kustomize/kustomize/v4
  33. # install the command as a kustomize plugin
  34. kubebuilder alpha config-gen install-as-plugin
  36. # create the kustomization.yaml containing the KubebuilderConfigGen resource
  37. cat > kustomization.yaml <<EOF
  38. apiVersion: kustomize.config.k8s.io/v1beta1
  39. kind: Kustomization
  40. transformers:
  41. - |-
  42.   apiVersion: kubebuilder.sigs.k8s.io
  43.   kind: KubebuilderConfigGen
  44.   metadata:
  45.     name: my-project
  46.   spec:
  47.     controllerManager:
  48.       image: my-org/my-project:v0.1.0
  49. EOF
  51. # generate configuration from kustomize > v4.0.0
  52. kustomize build --enable-alpha-plugins .
  54. # generate configuration from kustomize <= v4.0.0
  55. kustomize build --enable_alpha_plugins .

Options

  1.   -h, --help    help for config-gen
  2.       --stack   print the stack trace on failure

Options inherited from parent commands

  1.       --plugins strings   plugin keys to be used for this subcommand execution
  2.       --verbose           Enable verbose logging

SEE ALSO

Last modified March 24, 2021: deps: bump kubebuilder to v3.0.0-beta.1 (#4581) (1e014367)