Skip to content

Commit cd2db04

Browse files
📖 provide better info about usage of kind (#4091)
doc: provide better info about usage of kind
1 parent ffd01b4 commit cd2db04

File tree

4 files changed

+31
-15
lines changed

4 files changed

+31
-15
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
- [Watching Resources](./reference/watching-resources.md)
7979
- [Resources Managed by the Operator](./reference/watching-resources/operator-managed.md)
8080
- [Externally Managed Resources](./reference/watching-resources/externally-managed.md)
81-
- [Kind cluster](reference/kind.md)
81+
- [Kind for Dev & CI](reference/kind.md)
8282
- [What's a webhook?](reference/webhook-overview.md)
8383
- [Admission webhook](reference/admission-webhook.md)
8484
- [Webhooks for Core Types](reference/webhook-for-core-types.md)

docs/book/src/cronjob-tutorial/running-webhook.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
# Deploying Admission Webhooks
22

3-
## Kind Cluster
4-
5-
It is recommended to develop your webhook with a
6-
[kind](../reference/kind.md) cluster for faster iteration.
7-
Why?
8-
9-
- You can bring up a multi-node cluster locally within 1 minute.
10-
- You can tear it down in seconds.
11-
- You don't need to push your images to remote registry.
12-
133
## cert-manager
144

155
You need to follow [this](./cert-manager.md) to install the cert-manager bundle.
@@ -22,13 +12,22 @@ Run the following command to build your image locally.
2212
make docker-build docker-push IMG=<some-registry>/<project-name>:tag
2313
```
2414

25-
You don't need to push the image to a remote container registry if you are using
26-
a kind cluster. You can directly load your local image to your specified kind cluster:
15+
<aside class="note">
16+
<h1> Using Kind </h1>
17+
18+
Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
19+
Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
20+
You can directly load your local image into your specified Kind cluster:
2721

2822
```bash
2923
kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
3024
```
3125

26+
To now more see: [Kind for Dev & CI](./../reference/kind.md)
27+
28+
</aside>
29+
30+
3231
## Deploy Webhooks
3332

3433
You need to enable the webhook and cert manager configuration through kustomize.

docs/book/src/quick-start.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,21 @@ make deploy IMG=<some-registry>/<project-name>:tag
220220
```
221221

222222
<aside class="note">
223-
<h1>registry permission</h1>
223+
<h1>Registry permission</h1>
224224

225225
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.
226226
Make sure you have the proper permission to the registry if the above commands don't work.
227227

228+
Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
229+
Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
230+
You can directly load your local image into your specified Kind cluster:
231+
232+
```bash
233+
kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
234+
```
235+
236+
To now more see: [Kind for Dev & CI](./reference/kind.md)
237+
228238
<h1>RBAC errors</h1>
229239

230240
If you encounter RBAC errors, you may need to grant yourself cluster-admin

docs/book/src/reference/kind.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Kind Cluster
1+
# Using Kind For Development Purposes and CI
2+
3+
## Why Use Kind
4+
5+
- **Fast Setup:** Launch a multi-node Kubernetes cluster locally in under a minute.
6+
- **Quick Teardown:** Dismantle the cluster in just a few seconds, streamlining your development workflow.
7+
- **Local Image Usage:** Deploy your container images directly without the need to push to a remote registry.
8+
- **Lightweight and Efficient:** Kind is a minimalistic Kubernetes distribution, making it perfect for local development and CI/CD pipelines.
29

310
This only cover the basics to use a kind cluster. You can find more details at
411
[kind documentation](https://kind.sigs.k8s.io/).

0 commit comments

Comments
 (0)