Add book sections for core only controllers and upgrading kubebuilder.

kubernetes-sigs · May 15, 2018 · 75a7942 · 75a7942
1 parent bf6870f
commit 75a7942
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/docs/book/SUMMARY.md b/docs/book/SUMMARY.md
@@ -28,5 +28,13 @@
   * [What is the Controller-Manager](basics/what_is_the_controller_manager.md)
   * [Simple Controller-Manager](basics/simple_controller_manager.md)
 
+### Beyond the Basics
+
+* Development Workflow
+  * [Updating Kubebuilder](beyond_basics/upgrading_kubebuilder.md)
+* Controllers
+  * [Controllers For Core Resources](beyond_basics/controllers_for_core_resources.md)
+
+
 ### Reference Docs
 * [GoDoc Links](go_docs.md)
diff --git a/docs/book/beyond_basics/controllers_for_core_resources.md b/docs/book/beyond_basics/controllers_for_core_resources.md
@@ -0,0 +1,20 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
+## Controllers for Core Resources
+
+{% method %}
+
+It it possible to create Controllers for Core resources, or for resources defined outside your project.
+
+{% sample lang="bash" %}
+```bash
+kubebuilder create controller --group apps --version v1beta2 --kind Deployment --core-type
+```
+{% endmethod %}
+
+{% panel style="warning", title="Core Only Projects" %}
+If your project will *only* contain controllers for types defined outside your project,
+you must create the project with the `--controller-only` flag.
+{% endpanel %}
diff --git a/docs/book/beyond_basics/upgrading_kubebuilder.md b/docs/book/beyond_basics/upgrading_kubebuilder.md
@@ -0,0 +1,26 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
+# Update Kubebuilder
+
+## Update the Kubebuilder install
+
+Download the latest version of kubebuilder from [releases page](https://github.com/kubernetes-sigs/kubebuilder/releases)
+and install it.
+
+## Update Existing Project's Dependencies
+
+{% method %}
+
+Update your project's dependencies to the latest version of the libraries used by kubebuilder.  This
+will modify *Gopkg.toml* by rewriting the `[[override]]` elements beneath the
+`# DO NOT MODIFY BELOW THIS LINE.` line.  Rules added by the user above this line will be retained.
+
+{% sample lang="bash" %}
+```bash
+kubebuilder update vendor
+```
+{% endmethod %}
+
+
diff --git a/docs/book/quick_start.md b/docs/book/quick_start.md
@@ -1,3 +1,7 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
 # Quick Start
 
 This Quick Start guide will cover.