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

📖 Add clusterClass operations guide to the book #5444

Merged
merged 1 commit into from
Oct 28, 2021
Merged

📖 Add clusterClass operations guide to the book #5444

merged 1 commit into from
Oct 28, 2021

Conversation

killianmuldoon
Copy link
Contributor

@killianmuldoon killianmuldoon commented Oct 19, 2021 •
edited
Loading

What this PR does / why we need it:
This PR adds a ClusterClass operations guide to the book . To start the guide only describes a single operation - counting what changes will be rolled out to descended clusters when a ClusterClass is changed. Future additions to the page will include more operations made possible with Clusterclass and managed topologies.

Fixes: #5195

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 19, 2021
killianmuldoon
killianmuldoon commented Oct 19, 2021
View reviewed changes
Copy link
Contributor Author

@killianmuldoon killianmuldoon left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Does the current table add anything over a structured bullet list or similar? The formatting looks alright to me, but it might be difficult to change in future as it's using "<br/>" to have multi-line entries in the table

sbueringer
sbueringer reviewed Oct 20, 2021
View reviewed changes
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Sounds good to me!

docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
@sbueringer
Copy link
Member

sbueringer commented Oct 20, 2021 •
edited
Loading

@killianmuldoon Could it be that this PR also fixes #5195? (or at least a big part of it)

@killianmuldoon
Copy link
Contributor Author

killianmuldoon commented Oct 20, 2021 •
edited
Loading

@killianmuldoon Could it be that this PR also fixes #5195? (or at least a big part of it)

I think I'll add a little more detail in place of the warning at the end.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2021
@killianmuldoon killianmuldoon force-pushed the docs/add-clusterclass-operations branch 3 times, most recently from 4ee9cd5 to d66a95c Compare October 20, 2021 11:46
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2021
@killianmuldoon
Copy link
Contributor Author

Rebased and added info on template rotation vs template mutation.

fabriziopandini
fabriziopandini reviewed Oct 20, 2021
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

@killianmuldoon thanks for taking on this effort!
A couple of nits, but overall lgtm

docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
@fabriziopandini
Copy link
Member

lgtm pending squash

@killianmuldoon killianmuldoon force-pushed the docs/add-clusterclass-operations branch from 5456a93 to e46aedd Compare October 21, 2021 11:04
sbueringer
sbueringer reviewed Oct 21, 2021
View reviewed changes
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Last nits, otherwise lgtm

docs/book/src/tasks/experimental-features/clusterclass-operations.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/cluster-class-operations.md Outdated Show resolved Hide resolved
@killianmuldoon killianmuldoon force-pushed the docs/add-clusterclass-operations branch 3 times, most recently from 137625a to 8777ac7 Compare October 21, 2021 12:51
@killianmuldoon
Copy link
Contributor Author

killianmuldoon commented Oct 21, 2021 •
edited
Loading

/retest

@killianmuldoon killianmuldoon force-pushed the docs/add-clusterclass-operations branch from 8777ac7 to 59eee7a Compare October 21, 2021 13:29
@sbueringer
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 Oct 21, 2021
@fabriziopandini fabriziopandini mentioned this pull request Oct 26, 2021
Merged
@killianmuldoon killianmuldoon force-pushed the docs/add-clusterclass-operations branch from 59eee7a to c08dd1b Compare October 26, 2021 15:07
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 26, 2021
fabriziopandini
fabriziopandini reviewed Oct 27, 2021
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 27, 2021
@fabriziopandini
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 Oct 28, 2021
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot merged commit c3f0af7 into kubernetes-sigs:main Oct 28, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Oct 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabriziopandini fabriziopandini fabriziopandini left review comments

@sbueringer sbueringer sbueringer left review comments

@enxebre enxebre enxebre left review comments

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

@vincepri vincepri Awaiting requested review from vincepri

Assignees

@sbueringer sbueringer

@fabriziopandini fabriziopandini

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.1
Development

Successfully merging this pull request may close these issues.

Document operational practices for changing referenced templates in a ClusterClass
5 participants
@killianmuldoon @sbueringer @fabriziopandini @k8s-ci-robot @enxebre