Reference - The Kubebuilder Book (original) (raw)

  1. Introduction
  2. Architecture
  3. Quick Start
  4. Getting Started
  5. Versions Compatibility and Supportability
  6. 1. Tutorial: Building CronJob
    1. 1.1. What's in a basic project?
    2. 1.2. Every journey needs a start, every program a main
    3. 1.3. Groups and Versions and Kinds, oh my!
    4. 1.4. Adding a new API
    5. 1.5. Designing an API
      1. 1.5.1. A Brief Aside: What's the rest of this stuff?
    7. 1.6. What's in a controller?
    8. 1.7. Implementing a controller
      1. 1.7.1. You said something about main?
    10. 1.8. Implementing defaulting/validating webhooks
    11. 1.9. Running and deploying the controller
      1. 1.9.1. Deploying cert-manager
      2. 1.9.2. Deploying webhooks
    13. 1.10. Writing tests
    14. 1.11. Epilogue
  8. 2. Tutorial: Multi-Version API
    1. 2.1. Changing things up
    2. 2.2. Hubs, spokes, and other wheel metaphors
    3. 2.3. Implementing conversion
      1. 2.3.1. and setting up the webhooks
    5. 2.4. Deployment and Testing
  10. 3. Migrations
    1. 3.1. Legacy (before <= v3.0.0)
    1. 3.1.1. Kubebuilder v1 vs v2
        1. 3.1.1.1. Migration Guide
      2. 3.1.2. Kubebuilder v2 vs v3
        1. 3.1.2.1. Migration Guide
          1. 3.1.2.2. Migration by updating the files
  13. 3.2. From v3.0.0 with plugins
    1. 3.2.1. go/v3 vs go/v4
        1. 3.2.1.1. Migration Guide
          1. 3.2.1.2. Migration by updating the files
  15. 3.3. Single Group to Multi-Group
  16. 4. Project Upgrade Assistant
  17. 5. Reference
    1. 5.1. Generating CRDs
  19. 5.2. Using Finalizers
  20. 5.3. Good Practices
  21. 5.4. Raising Events
  22. 5.5. Watching Resources
    1. 5.5.1. Owned Resources
      1. 5.5.2. Not Owned Resources
      2. 5.5.3. Using Predicates
  24. 5.6. Kind for Dev & CI
  25. 5.7. What's a webhook?
    1. 5.7.1. Admission webhook
  27. 5.8. Markers for Config/Code Generation
    1. 5.8.1. CRD Generation
    2. 5.8.2. CRD Validation
    3. 5.8.3. CRD Processing
    4. 5.8.4. Webhook
    5. 5.8.5. Object/DeepCopy
    6. 5.8.6. RBAC
    7. 5.8.7. Scaffold
  29. 5.9. controller-gen CLI
  30. 5.10. completion
  31. 5.11. Artifacts
  32. 5.12. Platform Support
  33. 5.13. Monitoring with Pprof
  34. 5.14. Manager and CRDs Scope
  35. 5.15. Sub-Module Layouts
  36. 5.16. Using an external Resource / API
  37. 5.17. Configuring EnvTest
  38. 5.18. Metrics
    1. 5.18.1. Reference
  40. 5.19. Project config
  41. 6. Plugins
    1. 6.1. Available Plugins
    1. 6.1.1. go/v4
      1. 6.1.2. grafana/v1-alpha
      2. 6.1.3. deploy-image/v1-alpha
      3. 6.1.4. helm/v1-alpha
      4. 6.1.5. kustomize/v2
  44. 6.2. Extending
    1. 6.2.1. CLI and Plugins
      1. 6.2.2. External Plugins
      2. 6.2.3. E2E Tests
  46. 6.3. Plugins Versioning
  47. FAQ

The Kubebuilder Book