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

Move the Job controller example #20032

Merged
merged 1 commit into from
Apr 1, 2020
Merged

Move the Job controller example #20032

merged 1 commit into from
Apr 1, 2020

Conversation

prasadkatti
Copy link
Contributor

Move the job controller example so that the example of Job controller follows
immediately after the concept of what a job controller does in introduced.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 1, 2020
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Apr 1, 2020
@netlify
Copy link

netlify bot commented Apr 1, 2020 •
edited
Loading

Deploy preview for kubernetes-io-master-staging ready!

Built with commit e871972

https://deploy-preview-20032--kubernetes-io-master-staging.netlify.com

@prasadkatti
Copy link
Contributor Author

/assign @bradtopol

@sftim
Copy link
Contributor

sftim commented Apr 1, 2020

@prasadkatti I wasn't sure that I understood how this change helps readers. Can you explain a bit more?

@prasadkatti
Copy link
Contributor Author

prasadkatti commented Apr 1, 2020 •
edited
Loading

Hi @sftim. Consider the following 3 statements -

  1. Most commonly, a particular control loop
    (controller) uses one kind of resource as its desired state, and has a different
    kind of resource that it manages to make that desired state happen.

  2. For example, a controller for Jobs tracks Job objects (to discover new work) and Pod object
    (to run the Jobs, and then to see when the work is finished). In this case
    something else creates the Jobs, whereas the Job controller creates Pods.

  3. It's useful to have simple controllers rather than one, monolithic set of control
    loops that are interlinked. Controllers can fail, so Kubernetes is designed to
    allow for that.

The stmt 2 is an example of stmt 1. Stmt 3 is slightly unrelated (to 1 and 2) advice about how to design controllers.

The original order of the text was [1, 3, 2]. The change I am proposing is to make it [1, 2, 3].

sftim
sftim approved these changes Apr 1, 2020
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Makes sense to me.
/approve

[OK to /lgtm this either with or without the typo fix]

content/en/docs/concepts/architecture/controller.md Outdated Show resolved Hide resolved
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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 Apr 1, 2020
@prasadkatti
Copy link
Contributor Author

Do the changes get squashed before being merged?

@sftim
Copy link
Contributor

sftim commented Apr 1, 2020

Do the changes get squashed before being merged?

Please squash any extraneous commits. k/website very recently changed to merging by default rather than squashing by default.

@prasadkatti
Copy link
Contributor Author

Okay. So for this one, do you want me to squash and force-push? Or is it good as-is?

@sftim
Copy link
Contributor

sftim commented Apr 1, 2020

Please squash and force push @prasadkatti.

@prasadkatti
Move the Job controller example
e871972 
Move the job controller example so that the example of Job controller follows
immediately after the concept of what a job controller does in introduced.
@prasadkatti
Copy link
Contributor Author

@sftim done

sftim
sftim reviewed Apr 1, 2020
View reviewed changes
Copy link
Contributor

@sftim sftim 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 Apr 1, 2020
@k8s-ci-robot k8s-ci-robot merged commit 2930a57 into kubernetes:master Apr 1, 2020
@prasadkatti prasadkatti deleted the patch-6 branch April 1, 2020 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim approved these changes

@xiangpengzhao xiangpengzhao Awaiting requested review from xiangpengzhao

@zparnold zparnold Awaiting requested review from zparnold

Assignees

@bradtopol bradtopol

@sftim sftim

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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@prasadkatti @sftim @k8s-ci-robot @bradtopol