Skip to content

Commit b6a0bf1

Browse files
authored
Merge pull request #1794 from camilamacedo86/cleanup-docs
📖 cleanup / remove hello world
2 parents 7868757 + d5ee1e4 commit b6a0bf1

File tree

6 files changed

+31
-253
lines changed

6 files changed

+31
-253
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,21 @@
55

66
Kubebuilder is a framework for building Kubernetes APIs using [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions).
77

8+
Similar to web development frameworks such as *Ruby on Rails* and *SpringBoot*,
9+
Kubebuilder increases velocity and reduces the complexity managed by
10+
developers for rapidly building and publishing Kubernetes APIs in Go.
11+
It builds on top of the canonical techniques used to build the core Kubernetes APIs to provide simple abstractions that reduce boilerplate and toil.
12+
813
**Note:** kubebuilder does not exist as an example to *copy-paste*, but instead provides powerful libraries and tools
914
to simplify building and publishing Kubernetes APIs from scratch.
1015

16+
Kubebuilder is developed on top of the controller-runtime and controller-tools libraries.
17+
1118
### Installation
1219

1320
It is strongly recommended that you use a released version. Release binaries are available on the [releases](https://github.com/kubernetes-sigs/kubebuilder/releases) page.
1421
Follow the [instructions](https://book.kubebuilder.io/quick-start.html#installation) to install Kubebuilder.
1522

16-
1723
## Getting Started
1824

1925
See the [Getting Started](https://book.kubebuilder.io/quick-start.html) documentation.

docs/book/getting_started/hello_world.md

Lines changed: 0 additions & 114 deletions
This file was deleted.

docs/book/getting_started/installation_and_setup.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

docs/book/getting_started/what_is_kubebuilder.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/book/getting_started/why_kubernetes.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs/book/src/introduction.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,30 @@ Including:
3939
- How to use Declarative vs Webhook Validation
4040
- How to implement API versioning
4141

42+
## Why Kubernetes APIs
43+
44+
Kubernetes APIs provide consistent and well defined endpoints for
45+
objects adhering to a consistent and rich structure.
46+
47+
This approach has fostered a rich ecosystem of tools and libraries for working
48+
with Kubernetes APIs.
49+
50+
Users work with the APIs through declaring objects as *yaml* or *json* config, and using
51+
common tooling to manage the objects.
52+
53+
Building services as Kubernetes APIs provides many advantages to plain old REST, including:
54+
55+
* Hosted API endpoints, storage, and validation.
56+
* Rich tooling and clis such as `kubectl` and `kustomize`.
57+
* Support for Authn and granular Authz.
58+
* Support for API evolution through API versioning and conversion.
59+
* Facilitation of adaptive / self-healing APIs that continuously respond to changes
60+
in the system state without user intervention.
61+
* Kubernetes as a hosting environment
62+
63+
Developers may build and publish their own Kubernetes APIs for installation into
64+
running Kubernetes clusters.
65+
4266
## Contribution
4367

4468
If you like to contribute to either this book or the code, please be so kind

0 commit comments

Comments
 (0)