Skip to content

Commit ccd6554

Browse files
authored
Merge pull request #2945 from camilamacedo86/docs-new-plugins
📖 supplement info about the new plugins
2 parents 36dd1d3 + d55b87c commit ccd6554

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ See the [Getting Started](https://book.kubebuilder.io/quick-start.html) document
3838

3939
![Quick Start](docs/gif/kb-demo.v2.0.1.svg)
4040

41+
Also, ensure that you check out the [Deploy Image](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html)
42+
Plugin. This plugin allows users to scaffold API/Controllers to deploy and manage an
43+
Operand (image) on the cluster following the guidelines and best practices. It abstracts the
44+
complexities of achieving this goal while allowing users to customize the generated code.
45+
4146
## Documentation
4247

4348
Check out the Kubebuilder [book](https://book.kubebuilder.io).

docs/book/src/plugins/deploy-image-plugin-v1-alpha.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ See the "project-v3-with-deploy-image" directory under the [testdata][testdata]
1717

1818
</aside>
1919

20+
2021
## When to use it ?
2122

2223
- This plugin is helpful for those who are getting started.
@@ -64,6 +65,11 @@ With the `create api` command of this plugin, in addition to the existing scaffo
6465
- `main.go` (update to add controller setup)
6566
- `config/manager/manager.yaml` (update with envvar to store the image)
6667

68+
## Further Resources:
69+
70+
- Check out [video to show how it works](https://youtu.be/UwPuRjjnMjY)
71+
- See the [desing proposal documentation](../../../../designs/code-generate-image-plugin.md)
72+
6773
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
6874
[testdata]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/testdata/
6975
[envtest]: ../reference/envtest.md

docs/book/src/plugins/grafana-v1-alpha.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ The following scaffolds will be created or updated by this plugin:
190190

191191
## Further resources
192192

193+
- Check out [video to show how it works](https://youtu.be/-w_JjcV8jXc)
194+
- Checkout the [video to show how the custom metrics feature works](https://youtu.be/x_0FHta2HXc)
193195
- Refer to a sample of `servicemonitor` provided by [kustomize plugin][kustomize-plugin]
194196
- Check the [plugin implementation][plugin-implementation]
195197
- [Grafana Docs][grafana-docs] of importing JSON file

docs/book/src/quick-start.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,19 @@ make undeploy
242242

243243
## Next Step
244244

245-
Now, see the [architecture concept diagram][architecture-concept-diagram] for a better overview and follow up the [CronJob tutorial][cronjob-tutorial] to better understand how it works by developing a demo example project.
245+
Now, see the [architecture concept diagram][architecture-concept-diagram] for a better overview and follow up the
246+
[CronJob tutorial][cronjob-tutorial] to better understand how it works by developing a
247+
demo example project.
248+
249+
<aside class="note">
250+
<h1> Using Deploy Image plugin to generate APIs and controllers code </h1>
251+
252+
Ensure that you check out the [Deploy Image](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html)
253+
Plugin. This plugin allows users to scaffold API/Controllers to deploy and manage an
254+
Operand (image) on the cluster following the guidelines and best practices. It abstracts the
255+
complexities of achieving this goal while allowing users to customize the generated code.
256+
257+
</aside>
246258

247259
[pre-rbc-gke]: https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#iam-rolebinding-bootstrap
248260
[cronjob-tutorial]: https://book.kubebuilder.io/cronjob-tutorial/cronjob-tutorial.html

0 commit comments

Comments
 (0)