README.md

Create Operator with Kubebuilder

Version

3.4.0 or later

You can check the tested versions in each example:

1. QuickStart#Versions
2. PasswordOperator#Versions

Contents

1. Install kubebuilder
2. QuickStart
3. PasswordOperator

Checklist

• How to create a project with kubebuilder?
  • What's inside api/<versions>/ directory?
  • What's inside internal/controller directory (controllers directory for project created with kubebuilder version 3.9 or earlier)?
  • What's inside config/ directory?
  • What's a Manager in cmd/main.go (main.go for project created with kubebuilder version 3.9 or earlier) ?
• How to add an API (e.g. Password)?
  • Resource
    • Where will the new type definition be stored?
    • What is Password, PasswordSpec, and PasswordStatus structs?
  • Controller
    • What's the input (arguments) and output (returned value) of Reconcile function of Reconciler interface?
• What's markers? (e.g. +kubebuilder:object:root)
  • If controller needs to manipulate Secret, which marker needs to be added?
• OwnerReferences