Skip to content

Commit 75a7942

Browse files
committed
Add book sections for core only controllers and upgrading kubebuilder.
1 parent bf6870f commit 75a7942

File tree

4 files changed

+58
-0
lines changed

4 files changed

+58
-0
lines changed

docs/book/SUMMARY.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,13 @@
2828
* [What is the Controller-Manager](basics/what_is_the_controller_manager.md)
2929
* [Simple Controller-Manager](basics/simple_controller_manager.md)
3030

31+
### Beyond the Basics
32+
33+
* Development Workflow
34+
* [Updating Kubebuilder](beyond_basics/upgrading_kubebuilder.md)
35+
* Controllers
36+
* [Controllers For Core Resources](beyond_basics/controllers_for_core_resources.md)
37+
38+
3139
### Reference Docs
3240
* [GoDoc Links](go_docs.md)
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{% panel style="info", title="Under Development" %}
2+
This book is being actively developed.
3+
{% endpanel %}
4+
5+
## Controllers for Core Resources
6+
7+
{% method %}
8+
9+
It it possible to create Controllers for Core resources, or for resources defined outside your project.
10+
11+
{% sample lang="bash" %}
12+
```bash
13+
kubebuilder create controller --group apps --version v1beta2 --kind Deployment --core-type
14+
```
15+
{% endmethod %}
16+
17+
{% panel style="warning", title="Core Only Projects" %}
18+
If your project will *only* contain controllers for types defined outside your project,
19+
you must create the project with the `--controller-only` flag.
20+
{% endpanel %}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{% panel style="info", title="Under Development" %}
2+
This book is being actively developed.
3+
{% endpanel %}
4+
5+
# Update Kubebuilder
6+
7+
## Update the Kubebuilder install
8+
9+
Download the latest version of kubebuilder from [releases page](https://github.com/kubernetes-sigs/kubebuilder/releases)
10+
and install it.
11+
12+
## Update Existing Project's Dependencies
13+
14+
{% method %}
15+
16+
Update your project's dependencies to the latest version of the libraries used by kubebuilder. This
17+
will modify *Gopkg.toml* by rewriting the `[[override]]` elements beneath the
18+
`# DO NOT MODIFY BELOW THIS LINE.` line. Rules added by the user above this line will be retained.
19+
20+
{% sample lang="bash" %}
21+
```bash
22+
kubebuilder update vendor
23+
```
24+
{% endmethod %}
25+
26+

docs/book/quick_start.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
{% panel style="info", title="Under Development" %}
2+
This book is being actively developed.
3+
{% endpanel %}
4+
15
# Quick Start
26

37
This Quick Start guide will cover.

0 commit comments

Comments
 (0)