Developing KubeBlocks

This document covers basic needs to work with KubeBlocks codebase.

• Developing KubeBlocks
  • Setup development environment
    • Bring your own toolbox
      • Install Go
      • Install Make
      • Build KubeBlocks
    • Use VSCode and development container
      • Setup the development container
      • Customize your dev container
        • Use a custom dev container image
        • Connect existing Kubernetes cluster
    • Setup a Kubernetes development environment
      • Docker environment
      • Kubernetes environment
  • Test
    • Envtest
    • Use existing Kubernetes cluster
    • Check test code coverage
  • Debug
    • Install Delve
    • Start a delve debug server
      • Debug specific package
      • Pass arguments
      • Debug envtest
      • Change debug server port
    • Connect the debug server with a frontend client
      • Delve CLI
      • JetBrains GoLand / IntelliJ IDEA with go plugin
      • VSCode
  • Basics
    • Kubebuilder
    • Makefile
    • kbcli
    • Code style