Doc - Write documentation to allow the utils and how Kubebuilder LIB consumers can test their own plugins

[camilamacedo86]

trafficstars

What do you want to happen?

The goal of this issue is we have a new section under : https://book.kubebuilder.io/plugins/plugins.html such as "Written tests for your own plugin".

Kubebuilder can be used as lib to allow its consumers to create their own plugins. Also, Kubebuilder provides so utils to allow developers to build their e2e tests or samples to check their plugins.

• You can check the lib: https://github.com/kubernetes-sigs/kubebuilder/tree/master/test/e2e/utils

Then, you can check some examples:

• In SDK: https://github.com/operator-framework/operator-sdk/tree/master/test/e2e/go
• In KB: https://github.com/kubernetes-sigs/kubebuilder/tree/master/test/e2e/v3

(For the plugins phase 2): Any external plugins should have a way to be executed by themselves, which means using the Kubebuilder lib and doing the CLI implementation. Therefore, the external plugin should have it's binary and can indeed have a test data dir with samples such as we build in both projects.

Suggestion (Acceptence Criteria):

• a new section "Written tests for your own plugin" under https://book.kubebuilder.io/plugins/plugins.html such as "Written tests for your own plugin".
• under this section, we could have 2 subsections with examples to describe how to write e2e tests and how to generate the samples under the testdata.

Extra Labels

/kind documentation

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[Kavinjsir]

I can try for this if the task is currently not scheduled.

[camilamacedo86]

That would be great @Kavinjsir , please feel free to work on this one.

[Kavinjsir]

/assign