diff --git a/docs/book/SUMMARY.md b/docs/book/SUMMARY.md index 3b6240f586..912f14f09d 100644 --- 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) \ No newline at end of file diff --git a/docs/book/beyond_basics/controllers_for_core_resources.md b/docs/book/beyond_basics/controllers_for_core_resources.md new file mode 100644 index 0000000000..39fdd8159a --- /dev/null +++ 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 new file mode 100644 index 0000000000..5cc10b1dac --- /dev/null +++ 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 index 45d837e7ee..fc43ede41c 100644 --- 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.