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

📖 Runtime SDK: extend documentation & update proposals accordingly #6756

Merged
merged 1 commit into from
Jul 5, 2022
Merged

📖 Runtime SDK: extend documentation & update proposals accordingly #6756

merged 1 commit into from
Jul 5, 2022

Conversation

sbueringer
Copy link
Member

What this PR does / why we need it:
WIP => under construction please don't review yet

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Part of #6330
Part of #6545
Part of #6546

@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 28, 2022
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 28, 2022
This was referenced Jun 28, 2022
Closed
Closed
Closed
@sbueringer sbueringer force-pushed the pr-runtime-sdk-documentation branch from ae34481 to dd08168 Compare June 28, 2022 13:45
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 28, 2022
@sbueringer sbueringer force-pushed the pr-runtime-sdk-documentation branch 2 times, most recently from cf6c01d to 6b857c8 Compare June 28, 2022 16:29
killianmuldoon
killianmuldoon reviewed Jun 29, 2022
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

Just a few nits from an early pass.

docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Outdated Show resolved Hide resolved
@sbueringer sbueringer mentioned this pull request Jun 30, 2022
Closed
@sbueringer sbueringer changed the title [WIP] 📖 extend Runtime SDK documentation & update proposal 📖 Runtime SDK: extend documentation & update proposals accordingly Jun 30, 2022
@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 30, 2022
@sbueringer
Copy link
Member Author

@killianmuldoon @ykakarap @chrischdi Ready for review :)

chrischdi
chrischdi reviewed Jul 1, 2022
View reviewed changes
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/index.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
killianmuldoon
killianmuldoon approved these changes Jul 1, 2022
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon 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 Jul 1, 2022
ykakarap
ykakarap suggested changes Jul 1, 2022
View reviewed changes
Copy link
Contributor

@ykakarap ykakarap left a comment

Choose a reason for hiding this comment

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

Only a few comments. Looks good overall.

docs/book/src/tasks/experimental-features/runtime-sdk/index.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/index.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/deploy-runtime-extension.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 4, 2022
@sbueringer sbueringer force-pushed the pr-runtime-sdk-documentation branch from e9a518b to 4677ddc Compare July 4, 2022 08:29
fabriziopandini
fabriziopandini reviewed Jul 4, 2022
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.

That's a great start!
just a couple of nits/suggestions

docs/book/src/tasks/experimental-features/runtime-sdk/index.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md Show resolved Hide resolved
docs/book/src/tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md Show resolved Hide resolved
@sbueringer sbueringer force-pushed the pr-runtime-sdk-documentation branch from cb08229 to 0645be8 Compare July 5, 2022 05:12
@sbueringer
Copy link
Member Author

@chrischdi @fabriziopandini @killianmuldoon @ykakarap
Thx for the reviews. Findings should be fixed or answered. Please take another look

fabriziopandini
fabriziopandini reviewed Jul 5, 2022
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 pending squash

@sbueringer sbueringer force-pushed the pr-runtime-sdk-documentation branch from f1d70c7 to 8615d34 Compare July 5, 2022 10:25
@sbueringer
Copy link
Member Author

Rebased & squashed

killianmuldoon
killianmuldoon reviewed Jul 5, 2022
View reviewed changes
docs/book/src/tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md
* With a single extension it is still possible to implement multiple logical features using different variables.
* When implementing multiple logical features in one extension it's recommended that they can be conditionally
enabled/disabled via variables (either via certain values or by their existence).
* [Conway's law](https://en.wikipedia.org/wiki/Conway%27s_law) might make it not feasible in large organizations
Copy link
Contributor

Choose a reason for hiding this comment

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

😆

Copy link
Member Author

@sbueringer sbueringer Jul 5, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Fabrizio challenged me if I'm able to quote Conway's law here :)

I think it fits relatively well

killianmuldoon
killianmuldoon reviewed Jul 5, 2022
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

+1 for Conway's law reference

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

/lgtm
/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 Jul 5, 2022
@k8s-ci-robot k8s-ci-robot merged commit e53cab0 into kubernetes-sigs:main Jul 5, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jul 5, 2022
@fabriziopandini
Copy link
Member

/cherry-pick release-1.2

@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Jul 5, 2022
Merged
@k8s-infra-cherrypick-robot
Copy link

@fabriziopandini: new pull request created: #6822

In response to this:

/cherry-pick release-1.2

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@sbueringer sbueringer deleted the pr-runtime-sdk-documentation branch July 5, 2022 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@killianmuldoon killianmuldoon killianmuldoon approved these changes

@fabriziopandini fabriziopandini fabriziopandini left review comments

@chrischdi chrischdi chrischdi left review comments

@ykakarap ykakarap ykakarap requested changes

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@fabriziopandini fabriziopandini

@killianmuldoon killianmuldoon

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
v1.3
Development

Successfully merging this pull request may close these issues.
7 participants
@sbueringer @fabriziopandini @k8s-ci-robot @k8s-infra-cherrypick-robot @chrischdi @ykakarap @killianmuldoon