Skip to content

Commit 12ba671

Browse files
📖 improve plugin available doc
1 parent 9e51954 commit 12ba671

File tree

5 files changed

+22
-17
lines changed

5 files changed

+22
-17
lines changed

docs/book/src/plugins/available-plugins.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,22 @@
22

33
This section describes the plugins supported and shipped in with the Kubebuilder project.
44

5-
- [Declarative V1](declarative-v1.md)
6-
- [Kustomize V1](kustomize-v1.md)
5+
| Plugin | Key | Description |
6+
|---|---|---|
7+
| [go.kubebuilder.io/v3](go-v3-plugin.md) | `go/v3` | Default scaffold to create the projects when none plugin(s) are informed. Responsible for scaffold the Golang project and its configurations. |
8+
| [go.kubebuilder.io/v2](go-v2-plugin.md) | `go/v2` | Golang plugin responsible for scaffold the legacy layout provided with Kubebuilder CLI >= `2.0.0` and < `3.0.0`. |
9+
| [declarative.go.kubebuilder.io/v1](declarative-v1.md) | `declarative/v1` | Optional plugin used to scaffold APIs/controllers using the [kubebuilder-declarative-pattern][kubebuilder-declarative-pattern] project. |
10+
| [kustomize.common.kubebuilder.io/v1](kustomize-v1.md) | `kustomize/v1` | Responsible for scaffold all manifests to configure the projects with [kustomize(v3)][kustomize]. (create and update the the `config/` directory). This plugin is used in the composition to create the plugin (`go/v3`). |
11+
| `base.go.kubebuilder.io/v3` | `base/v3` | Responsible for scaffold all files which specific requires Golang. This plugin is used in the composition to create the plugin (`go/v3`) |
712

813
<aside class="note">
914

10-
<h1>But you can create your own plugins, see:</h1>
15+
<h1>You can also create your own plugins, see:</h1>
1116

1217
- [Creating your own plugins][create-plugins].
13-
- [Plugins Phase 2][plugins-phase-2] - will allow users to use these external options as helpers to perform the scaffolds with the tool.
1418

1519
</aside>
1620

1721
[create-plugins]: creating-plugins.md
18-
[plugins-phase-2]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-2.md
22+
[kubebuilder-declarative-pattern]: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern
23+
[kustomize]: https://kustomize.io/

docs/book/src/plugins/declarative-v1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ You can check samples using this plugin by looking at the "addon" samples inside
1111
</aside>
1212

1313

14-
## When to use it
14+
## When to use it ?
1515

1616
- If you are looking to scaffold one or more [controllers][controller-runtime] following [the pattern][kubebuilder-declarative-pattern] ( See an e.g. of the reconcile method implemented [here][addon-v3-controller])
1717
- If you want to have manifests shipped inside your Manager container. The declarative plugin works with channels, which allow you to push manifests. [More info][addon-channels-info]
1818

19-
## How to use it
19+
## How to use it ?
2020

2121
The declarative plugin requires to be used with one of the available Golang plugins
2222
If you want that any API(s) and its respective controller(s) generate to reconcile them of your project adopt this partner then:

docs/book/src/plugins/go-v2-plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# go/v2 plugin
1+
# go/v2 (go.kubebuilder.io/v2)
22

33
The `go/v2` plugin has the purpose to scaffold Golang projects to help users to build projects with [controllers][controller-runtime] and keep the backwards compatibility with the default scaffold made using Kubebuilder CLI `2.x.z` releases.
44

@@ -8,7 +8,7 @@ You can check samples using this plugin by looking at the `project-v2-<options>`
88

99
</node>
1010

11-
## When should I use this plugin
11+
## When should I use this plugin ?
1212

1313
Only if you are looking to scaffold a project with the legacy layout. Otherwise, it is recommended you to use the default Golang version plugin.
1414

@@ -35,7 +35,7 @@ By creating a project with this plugin, the PROJECT file scaffold will be using
3535

3636
</aside>
3737

38-
## Subcommands supported by the plugin
38+
## Subcommands supported by the plugin ?
3939

4040
- Init - `kubebuilder init [OPTIONS]`
4141
- Edit - `kubebuilder edit [OPTIONS]`

docs/book/src/plugins/go-v3-plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# go/v3
1+
# go/v3 (go.kubebuilder.io/v3)
22

33
Kubebuilder tool will scaffold the go/v3 plugin by default. This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v1` and `base.go.kubebuilder.io/v3`. By using you can scaffold the default project which is a helper to construct sets of [controllers][controller-runtime].
44

@@ -12,9 +12,9 @@ Samples are provided under the [testdata][testdata] directory of the Kubebuilder
1212

1313
</aside>
1414

15-
## When to use it
15+
## When to use it ?
1616

17-
- If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]
17+
If you are looking to scaffold Golang projects to develop projects using [controllers][controller-runtime]
1818

1919
## How to use it ?
2020

docs/book/src/plugins/kustomize-v1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Kustomize Plugin
1+
# Kustomize (kustomize/v1)
22

33
The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language plugins such as `go/v2` and `go/v3`.
44
By using the kustomize plugin, you can create your own language plugins and ensure that you will have the same configurations
@@ -20,11 +20,11 @@ directory of the Kubebuilder project.
2020
</aside>
2121

2222

23-
## When to use it
23+
## When to use it ?
2424

25-
- If you are looking to scaffold the kustomize configuration manifests for your own language plugin
25+
If you are looking to scaffold the kustomize configuration manifests for your own language plugin
2626

27-
## How to use it
27+
## How to use it ?
2828

2929
If you are looking to define that your language plugin should use kustomize use the [Bundle Plugin][bundle]
3030
to specify that your language plugin is a composition with your plugin responsable for scaffold

0 commit comments

Comments
 (0)