Skip to content

Commit

Permalink
Update quick-start.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sajiyah-Salat committed May 7, 2023
1 parent b0a8084 commit 17ebc36
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/book/src/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ This Quick Start guide will cover:
- [Running locally](#test-it-out)
- [Running in-cluster](#run-it-on-the-cluster)

## Prerequisites
## Prerequisites

- [go](https://golang.org/dl/) version v1.19.0+
- [docker](https://docs.docker.com/install/) version 17.03+.
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) version v1.11.3+.
- [go][golang] version v1.19.0+
- [docker][dockerdownload] version 17.03+.
- [kubectl][kubectldownload] version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.

<aside class="note">
<h1>Versions and Supportability</h1>

Projects created by Kubebuilder contain a Makefile that will install tools at versions defined at creation time. Those tools are:
- [kustomize](https://github.com/kubernetes-sigs/kustomize)
- [controller-gen](https://github.com/kubernetes-sigs/controller-tools)
- [kustomize][kustomize]
- [controller-gen][controller-tools]

The versions which are defined in the `Makefile` and `go.mod` files are the versions tested and therefore is recommend to use the specified versions.

Expand Down Expand Up @@ -263,3 +263,6 @@ complexities of achieving this goal while allowing users to customize the genera
[envtest]: https://book.kubebuilder.io/reference/testing/envtest.html
[architecture-concept-diagram]: architecture.md
[kustomize]: https://github.com/kubernetes-sigs/kustomize
[golang]: https://golang.org/dl/
[dockerdownload]: https://docs.docker.com/install/
[kubectldownload]: https://kubernetes.io/docs/tasks/tools/install-kubectl/

0 comments on commit 17ebc36

Please sign in to comment.