search

kubernetes-sigs / kwok

Kubernetes WithOut Kubelet - Simulates thousands of Nodes and Clusters.
https://kwok.sigs.k8s.io
Apache License 2.0
2.54k stars 200 forks source link

[doc] Unclear what local refers to in installation docs #333

Closed ahmetb closed 1 year ago

ahmetb commented 1 year ago

What would you like to be added?

https://kwok.sigs.k8s.io/docs/user/kwok-in-local/ this doc doesn't make it clear what "in the local" means. For example, can it work on a Mac or Windows WSL where Docker is installed and running? Or does it need a Kubernetes cluster?

e.g. If I run the command specified directly, it tries to talk to a local kind cluster (my current-context set on kubectl) but it fails because it's down

$ kwok --kubeconfig=~/.kube/config  ... # the command in the docs

  ERROR Failed to list nodes                                    err="Get \"https://127.0.0.1:45679/api/v1/nodes?limit=1\": dial tcp 127.0.0.1:45679: connect: connection refused"
  ERROR Failed to list nodes                                    err="Get \"https://127.0.0.1:45679/api/v1/nodes?limit=1\": dial tcp 127.0.0.1:45679: connect: connection refused"
  ...

Why is this needed?

User experience.

This output makes me think this tool clearly needs a local Kubernetes cluster to be able to run, because it's trying to use the local Kubernetes cluster.

Long story short, I think I should be using kwokctl create cluster command, but why is the "Kwok on local" page telling me to install it to my Mac via Homebrew and use kwok executable instead?

wzshiming commented 1 year ago

/kind documentation /remove-kind feature /triage accepted

ahmetb commented 1 year ago

Added more details to the original issue description.

wzshiming commented 1 year ago

It makes sense, we will improve the documentation. 😄

ahmetb commented 1 year ago

I don't think #336 fixes this. Please read the comment above.

wzshiming commented 1 year ago

Ohh, sorry I didn't notice that PR was linked to this issue. 😓

/reopen

k8s-ci-robot commented 1 year ago

@wzshiming: Reopened this issue.

In response to [this](https://github.com/kubernetes-sigs/kwok/issues/333#issuecomment-1456503306): >Ohh, sorry I didn't notice that PR was linked to this issue. 😓 > >/reopen > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
windsonsea commented 1 year ago

Hi @ahmetb , could you help to review #356? More comments can improve the doc, thanks.