Merge pull request #3572 from Eileen-Yu/docs/extending-instructions

📖 Add notes to distinguish between external plugin and using KB as a library
kubernetes-sigs · Aug 28, 2023 · 230e710 · 230e710
2 parents 8824c0a + f801a25
commit 230e710
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/docs/book/src/plugins/creating-plugins.md b/docs/book/src/plugins/creating-plugins.md
@@ -2,12 +2,34 @@
 
 [extending-cli]: extending-cli.md
 [controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
+[creating-external-plugins]: external-plugins.md
 [operator-pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator
 [sdk-ansible]: https://sdk.operatorframework.io/docs/building-operators/ansible/
 [sdk-cli-pkg]: https://pkg.go.dev/github.com/operator-framework/operator-sdk/internal/cmd/operator-sdk/cli
 [sdk-helm]: https://sdk.operatorframework.io/docs/building-operators/helm/
 [sdk]: https://github.com/operator-framework/operator-sdk
 
+<aside class="note warning">
+
+<h1>Note</h1>
+
+Extending Kubebuilder can be accomplished in two primary ways:
+
+`By re-using the existing plugins`: In this approach, you use Kubebuilder as a library.
+
+This enables you to import existing Kubebuilder plugins and extend them, leveraging their features to build upon.
+
+It is particularly useful if you want to add functionalities that are closely tied with the existing Kubebuilder features.
+
+
+`By Creating an External Plugin`: This method allows you to create an independent, standalone plugin as a binary.
+
+The plugin can be written in any language and should implement an execution pattern that Kubebuilder knows how to interact with.
+
+You can see [Creating external plugins][creating-external-plugins] for more info.
+
+</aside>
+
 ## Overview
 
 You can extend the Kubebuilder API to create your own plugins. If [extending the CLI][extending-cli], your plugin will be implemented in your project and registered to the CLI as has been done by the [SDK][sdk] project. See its [CLI code][sdk-cli-pkg] as an example.

diff --git a/testdata/project-v4-multigroup/api/example.com/v1alpha1/zz_generated.deepcopy.go b/testdata/project-v4-multigroup/api/example.com/v1alpha1/zz_generated.deepcopy.go
diff --git a/testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_busyboxes.yaml b/testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_busyboxes.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.12.0
+    controller-gen.kubebuilder.io/version: v0.13.0
   name: busyboxes.example.com.testproject.org
 spec:
   group: example.com.testproject.org

diff --git a/testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_memcacheds.yaml b/testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_memcacheds.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.12.0
+    controller-gen.kubebuilder.io/version: v0.13.0
   name: memcacheds.example.com.testproject.org
 spec:
   group: example.com.testproject.org