[WIP] Update docs of snapshot #1100
Conversation
k8s-ci-robot
added
release-note-none
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: wzshiming The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
added
the
size/M
✅ Deploy Preview for k8s-kwok ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
wzshiming
force-pushed
the
doc/record-and-replay
branch
from
621a74e
to
466a82a
Compare
k8s-ci-robot
added
do-not-merge/work-in-progress
| # Create an nodes. | ||
| kwokctl scale node --replicas 2 | ||
|
|
||
| # Apply a deployment. |
There was a problem hiding this comment.
The demo looks great. However, the user needs to switch contexts before applying a deployment. For beginners new to Kubernetes, this can be confusing, especially if they have been working with a cluster that has a different name beforehand.
Suggestion
# Use context
kubectl cluster-info --context kwok-kwok
# Apply a deployment.
There was a problem hiding this comment.
But that doesn't switch context, it needs uses:
kubectl config use-context kwok-kwokand I feel it is enough to add to the demo of the home page
https://kwok.sigs.k8s.io/#getting-started
WDYT?
There was a problem hiding this comment.
Oh, it's true. I just realized that it only shows details about the DNS name the control plane is running at.
For example:
kubectl cluster-info --context kwok-kwok
Kubernetes control plane is running at https://127.0.0.1:32766
To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
There was a problem hiding this comment.
I also noticed that after creating a cluster using kwokctl, it automatically switches the context.
For example:
$ kubectl config current-context
error: current-context is not set
$ kwokctl create cluster
Cluster is creating cluster=kwok
Cluster is created elapsed=0.9s cluster=kwok
Cluster is starting cluster=kwok
Cluster is started elapsed=1.9s cluster=kwok
You can now use your cluster with:
kubectl cluster-info --context kwok-kwok
Thanks for using kwok!
$ kubectl config current-context
kwok-kwok
There was a problem hiding this comment.
It means there is no point in adding this suggestion:
# Use context
kubectl cluster-info --context kwok-kwok
My sincere apologies. After executing kwokctl create cluster, this statement You can now use your cluster with: confused me.
There was a problem hiding this comment.
My sincere apologies. After executing kwokctl create cluster, this statement You can now use your cluster with: confused me.
It's modeled on kind.
https://github.com/kubernetes-sigs/kind/blob/bbcc02f84c8efd68d20c3a6585c2f282d7c1b8c9/pkg/cluster/internal/create/create.go#L187-L197
There was a problem hiding this comment.
True, I surprisingly saw it yesterday while creating a cluster using Kind.
Also, if no cluster name is specified when creating a Kind cluster, it switches to a default context after creating it. It's nice that the same applies to kwok too.
| @@ -0,0 +1,31 @@ | |||
| # Let's getting started with kwokctl! | |||
There was a problem hiding this comment.
See this review above.
| @@ -0,0 +1,29 @@ | |||
| # Let's getting started with kwokctl! | |||
There was a problem hiding this comment.
See this review above.
wzshiming
force-pushed
the
doc/record-and-replay
branch
4 times, most recently
from
5d65e94
to
0ef5a13
Compare
Co-authored-by: Charles Uneze <charlesniklaus@gmail.com>
wzshiming
force-pushed
the
doc/record-and-replay
branch
from
0ef5a13
to
acad636
Compare
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: