docs(kind): add prerequisites and build/load commands clarity - #345
docs(kind): add prerequisites and build/load commands clarity#345hudazaan wants to merge 1 commit into
Conversation
Signed-off-by: hudazaan <naazhuda2000@gmail.com>
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds missing environment prerequisites and clarifies the intended build and Kind image-loading workflow to reduce setup friction when developing with Kind.
Changes:
- Add a “Prerequisites” section with required tooling and permissions
- Add explanatory notes for
make dockervsdocker build - Add a short note clarifying
kind load docker-imagebehavior and required tag/cluster name matching
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ### Prerequisites | ||
|
|
||
| Before you begin, make sure you have the following installed and available on your PATH, and that you have the required permissions: |
|
|
||
| - Docker (running): used to build images and run Kind nodes. You must be able to access the Docker daemon (e.g., your user is in the `docker` group or you run commands with `sudo`). | ||
| - kind: the `kind` binary used to create local Kubernetes clusters. See the [kind releases page](https://github.com/kubernetes-sigs/kind/releases) for downloads. | ||
| - kubectl: Kubernetes CLI to interact with the cluster. Follow the official install guide if needed. |
| - Docker (running): used to build images and run Kind nodes. You must be able to access the Docker daemon (e.g., your user is in the `docker` group or you run commands with `sudo`). | ||
| - kind: the `kind` binary used to create local Kubernetes clusters. See the [kind releases page](https://github.com/kubernetes-sigs/kind/releases) for downloads. | ||
| - kubectl: Kubernetes CLI to interact with the cluster. Follow the official install guide if needed. | ||
| - istioctl: for installing Istio into the kind cluster (required for Kmesh dataplane features). |
|
|
||
| Notes on the build commands: | ||
|
|
||
| - `make docker`: builds the code inside a reproducible container and produces a Docker image. Check the repo `Makefile` or `build/` scripts for the image tag variable (e.g. `IMAGE_NAME`). |
|
|
||
| Notes on loading images: | ||
|
|
||
| - `kind load docker-image <image> --name <cluster>` copies a locally-built image into all Kind nodes so Pods can use it without pulling from a registry. Ensure `<image>` matches the tag used when building and `<cluster>` matches the Kind cluster name (default: `kind`). |
make docker/docker buildandkind load docker-imagecommands.Fixes #282