You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/book/src/quick-start.md
+73-9Lines changed: 73 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ This Quick Start guide will cover:
9
9
10
10
## Prerequisites
11
11
12
-
-[go](https://go.dev/dl/) version v1.23.0+
12
+
-[go](https://go.dev/dl/) version v1.24.5+
13
13
-[docker](https://docs.docker.com/install/) version 17.03+.
14
14
-[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) version v1.11.3+.
15
15
- Access to a Kubernetes v1.11.3+ cluster.
@@ -144,10 +144,20 @@ type Guestbook struct {
144
144
</p>
145
145
</details>
146
146
147
+
148
+
<asideclass="note">
149
+
<h1> `+kubebuilder` markers </h1>
150
+
151
+
`+kubebuilder` are [markers][markers] processed by [controller-gen][controller-gen]
152
+
to generate CRDs and RBAC. Kubebuilder also provides [scaffolding markers][scaffolding-markers]
153
+
to inject code into existing files and simplify common tasks. See `cmd/main.go` for examples.
154
+
155
+
</aside>
156
+
147
157
## Test It Out
148
158
149
159
You'll need a Kubernetes cluster to run against. You can use
150
-
[KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or
160
+
[KinD][kind] to get a local cluster for testing, or
151
161
run against a remote cluster.
152
162
153
163
<asideclass="note">
@@ -202,14 +212,15 @@ make deploy IMG=<some-registry>/<project-name>:tag
202
212
This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment.
203
213
Make sure you have the proper permission to the registry if the above commands don't work.
204
214
205
-
Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
206
-
Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
207
-
You can directly load your local image into your specified Kind cluster:
215
+
Consider incorporating [Kind][kind] into your workflow for a faster, more efficient local development and CI experience.
216
+
Note that, if you're using a [Kind][kind] cluster, there's no need to push your image to a remote container registry.
217
+
You can directly load your local image into your specified [Kind][kind] cluster:
0 commit comments