Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖clusterctl: more docs #2266

Merged
merged 3 commits into from
Feb 12, 2020
Merged

📖clusterctl: more docs #2266

merged 3 commits into from
Feb 12, 2020

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
More clusterctl docs (also for things still in flight)

Which issue(s) this PR fixes
Rif #1729

/area clusterctl
/assign @ncdc
/assign @vincepri

@k8s-ci-robot k8s-ci-robot added area/clusterctl Issues or PRs related to clusterctl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 5, 2020
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 5, 2020
randomvariable
randomvariable reviewed Feb 6, 2020
View reviewed changes
docs/book/src/clusterctl/commands/move.md Outdated
In former versions of clusterctl the pivot process was bounded with the creation of a temporary bootstrap cluster
used to provision a target Management cluster.

This can now achieved with the following procedure:
Copy link
Member

Choose a reason for hiding this comment

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

Maybe remove the section on the old clusterctl behaviour as far as this doc goes.

Copy link
Member Author

Choose a reason for hiding this comment

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

@randomvariable I have changed the sentence so there is no more reference to old versions

@fabriziopandini
Copy link
Member Author

@randomvariable thanks for the feedback! everything should be addressed now

@randomvariable
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 6, 2020
@randomvariable
Copy link
Member

ah, let me see if i have perms

/approve

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 6, 2020
@wfernandes
Copy link
Contributor

I'll take a look at this one.
/assign

wfernandes
wfernandes reviewed Feb 6, 2020
View reviewed changes
docs/book/src/clusterctl/commands/config-cluster.md

```
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
--from ~/my-template.yaml > my-cluster.yaml
Copy link
Contributor

@wfernandes wfernandes Feb 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

--from is currently not a flag. Is there another PR adding this functionality in?

Copy link
Member Author

Choose a reason for hiding this comment

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

😄 #2265

wfernandes
wfernandes reviewed Feb 6, 2020
View reviewed changes
docs/book/src/clusterctl/commands/config-cluster.md

#### ConfigMaps

Use the `--from-config-map` flag to read cluster templates stored in a Kubernetes ConfigMap; e.g.
Copy link
Contributor

Choose a reason for hiding this comment

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

--from-config-map is currently not a supported flag. Is there another PR adding this functionality in?

Copy link
Member Author

Choose a reason for hiding this comment

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

😄 #2265

Copy link
Contributor

Choose a reason for hiding this comment

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

We should document the other flags --from-config-map-key and --from-config-map-namespace. I was testing this out and was about to open issues for those scenarios but then I saw the other flags in the help output. 😄

@ncdc ncdc added this to the v0.3.0 milestone Feb 7, 2020
@wfernandes
Copy link
Contributor

Other than documenting the availability of the flags --from-config-map-key and --from-config-map-namespace, this lgtm.

@fabriziopandini
Copy link
Member Author

@wfernandes done!

@wfernandes
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 10, 2020
@vincepri
Copy link
Member

Reviewing

@vincepri
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini, randomvariable, vincepri

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 Feb 12, 2020
@k8s-ci-robot k8s-ci-robot merged commit 1f1db9c into kubernetes-sigs:master Feb 12, 2020
@fabriziopandini fabriziopandini deleted the clusterctl-more-docs branch February 12, 2020 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wfernandes wfernandes wfernandes left review comments

@randomvariable randomvariable randomvariable left review comments

@ncdc ncdc ncdc left review comments

@vincepri vincepri vincepri approved these changes

@moshloop moshloop Awaiting requested review from moshloop

Assignees

@ncdc ncdc

@randomvariable randomvariable

@wfernandes wfernandes

@vincepri vincepri

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/clusterctl Issues or PRs related to clusterctl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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
Milestone
v0.3.0
Development

Successfully merging this pull request may close these issues.
6 participants
@fabriziopandini @randomvariable @wfernandes @vincepri @k8s-ci-robot @ncdc