Skip to content

Commit

Permalink
doc: provide better info about usage of kind
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 committed Aug 23, 2024
1 parent 89f4cd8 commit 200b6be
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
- [Watching Resources](./reference/watching-resources.md)
- [Resources Managed by the Operator](./reference/watching-resources/operator-managed.md)
- [Externally Managed Resources](./reference/watching-resources/externally-managed.md)
- [Kind cluster](reference/kind.md)
- [Kind for Dev & CI](reference/kind.md)
- [What's a webhook?](reference/webhook-overview.md)
- [Admission webhook](reference/admission-webhook.md)
- [Webhooks for Core Types](reference/webhook-for-core-types.md)
Expand Down
23 changes: 11 additions & 12 deletions docs/book/src/cronjob-tutorial/running-webhook.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# Deploying Admission Webhooks

## Kind Cluster

It is recommended to develop your webhook with a
[kind](../reference/kind.md) cluster for faster iteration.
Why?

- You can bring up a multi-node cluster locally within 1 minute.
- You can tear it down in seconds.
- You don't need to push your images to remote registry.

## cert-manager

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

You don't need to push the image to a remote container registry if you are using
a kind cluster. You can directly load your local image to your specified kind cluster:
<aside class="note">
<h1> Using Kind </h1>

Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
You can directly load your local image into your specified Kind cluster:

```bash
kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
```

To now more see: [Kind for Dev & CI](./../reference/kind.md)

</aside>


## Deploy Webhooks

You need to enable the webhook and cert manager configuration through kustomize.
Expand Down
12 changes: 11 additions & 1 deletion docs/book/src/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,11 +220,21 @@ make deploy IMG=<some-registry>/<project-name>:tag
```

<aside class="note">
<h1>registry permission</h1>
<h1>Registry permission</h1>

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

Consider incorporating Kind into your workflow for a faster, more efficient local development and CI experience.
Note that, if you're using a Kind cluster, there's no need to push your image to a remote container registry.
You can directly load your local image into your specified Kind cluster:

```bash
kind load docker-image <your-image-name>:tag --name <your-kind-cluster-name>
```

To now more see: [Kind for Dev & CI](./reference/kind.md)

<h1>RBAC errors</h1>

If you encounter RBAC errors, you may need to grant yourself cluster-admin
Expand Down
9 changes: 8 additions & 1 deletion docs/book/src/reference/kind.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Kind Cluster
# Using Kind For Development Purposes and CI

## Why Use Kind

- **Fast Setup:** Launch a multi-node Kubernetes cluster locally in under a minute.
- **Quick Teardown:** Dismantle the cluster in just a few seconds, streamlining your development workflow.
- **Local Image Usage:** Deploy your container images directly without the need to push to a remote registry.
- **Lightweight and Efficient:** Kind is a minimalistic Kubernetes distribution, making it perfect for local development and CI/CD pipelines.

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

0 comments on commit 200b6be

Please sign in to comment.