Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Add notes to distinguish between external plugin and using KB as a library #3572

Merged
merged 1 commit into from
Aug 28, 2023
Merged

📖 Add notes to distinguish between external plugin and using KB as a library #3572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/book/src/plugins/creating-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion testdata/project-v4-multigroup/api/example.com/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_busyboxes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion testdata/project-v4-multigroup/config/crd/bases/example.com.testproject.org_memcacheds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading