Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Update README to reflect latest code and way for init #127

Merged
merged 1 commit into from
Jun 17, 2021

Conversation

jichenjc
Copy link
Contributor

@jichenjc jichenjc commented Jun 15, 2021

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #105

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 15, 2021
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 15, 2021
Copy link
Contributor

@christopherhein christopherhein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good so far only a couple of comments.

docs/README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated
Comment on lines 113 to 129
Note you might see following error, wait for a while and retry
```
Error: "cluster-sample-kubeconfig" not found in namespace "default": secrets "cluster-sample-kubeconfig" not found
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe above this section, we can add a note saying to run kubectl get cluster -w and wait for the Status to say Ready.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just say:

This error means that the status of the cluster is not ready. Please wait until the cluster is ready and try again.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kubectl get cluster -w

the status stuck at

NAME             PHASE
cluster-sample   Provisioned

for long time..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be running per cluster-api project
I guess some pre-requirement not complete so status of cluster is not running ...need find reason later on

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, there was a bug with the published version actually :/ so that object doesn't get updated properly, I fixed it in #136 maybe we can use kubectl get nestedcluster -w instead since that updates properly and then when that other PR is merged we can switch this back to the cluster resource.

@christopherhein
Copy link
Contributor

/kind documentation
/milestone v0.1.x

@k8s-ci-robot k8s-ci-robot added this to the v0.1.x milestone Jun 15, 2021
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 15, 2021
@jichenjc jichenjc changed the title WIP: Update README to reflect latest code and way for init Update README to reflect latest code and way for init Jun 16, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 16, 2021
@jichenjc jichenjc force-pushed the bug/105 branch 2 times, most recently from 42e0cc3 to 3485de7 Compare June 16, 2021 02:55
Copy link
Contributor

@christopherhein christopherhein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job on the updates, if you could just get a couple more pieces in place this will be good to go.
👍

My concern about the # is a lot of people copy and paste and this is commonly a comment character.

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@christopherhein
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 17, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christopherhein, jichenjc

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 17, 2021
@christopherhein
Copy link
Contributor

Thank you so much @jichenjc !

@k8s-ci-robot k8s-ci-robot merged commit 395ab3e into kubernetes-retired:main Jun 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📖 Update docs/README.md with beta clusterctl setup
4 participants