[WIP] Add controller reference pages #16885

sftim · 2019-10-14T07:53:55Z

Relevant to issue #4135. Rework of PR #15374. Preview.

Add a reference section that lists the built-in controllers and explains what each of them does.

This change fits in with an idea I have to restructure https://kubernetes.io/docs/concepts/workloads/

People developing things to deploy on Kubernetes need to understand that there is (eg) a Deployment resource; it doesn't matter as much how the Deployment resource gets translated into API actions like creating or removing ReplicaSet objects. Some resources happen to involve more than one controller (eg Job with the Job controller and the TTL-after-finished controller).

If you are interested in looking behind the scenes, I think it helps to have all kube-controller-manager controllers listed in one place, no matter what kind of resource they interact with (Endpoint? ReplicaSet? Namespace?)

/sig apps

Credit to @lavalamp for the excellent Kubecon talk that helped me a lot with drafting these documents.

netlify · 2019-10-14T08:03:09Z

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

Built with commit 1b006ad

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

zparnold · 2019-10-14T23:21:35Z

@kubernetes/sig-apps-pr-reviews
@kubernetes/sig-api-machinery-pr-reviews
Could you folks take a look at the technical aspects of this?

sftim · 2019-10-15T12:35:44Z

Thinking about this one, I might change the storage pages to better reflect how the code really works. At the moment this make it sound like you can separate out the volume controllers, and according to pv_controller.go you can't easily do that:

// ==================================================================
// PLEASE DO NOT ATTEMPT TO SIMPLIFY THIS CODE.
// KEEP THE SPACE SHUTTLE FLYING.
// ==================================================================

sftim · 2019-11-10T10:44:08Z

/retitle [WIP] Add controller reference pages

christophercarney

Leaving some general feedback on DaemonSet controller page

content/en/docs/reference/controllers/daemonset.md

christophercarney · 2019-11-12T17:09:48Z

content/en/docs/reference/controllers/daemonset.md

+
+{{% capture body %}}
+
+The DaemonSet controller is built in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.


Suggested change

The DaemonSet controller is built in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.

The DaemonSet controller is built-in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.

I'll see if I can reword to avoid having to pick a side (dash vs. no dash).

How's this?

christophercarney · 2019-11-12T17:12:52Z

content/en/docs/reference/controllers/daemonset.md

+If a DaemonSet's Pods fail the controller recreates them, applying a rate
+limit to avoid a hot loop of killing and then recreating broken Pods.
+
+## How DaemonSet Pods are scheduled


For this section maybe you'll want to take from #17476 restructuring to make sure the default behavior is clear. Or we can tag that issue and move it into here after this PR is merged, depends really how you see this restructure progressing

k8s-ci-robot · 2019-12-10T04:12:38Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign xiangpengzhao
You can assign the PR to them by writing /assign @xiangpengzhao in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

(partial tidying)

sftim · 2020-02-04T22:09:43Z

Some good detail in https://github.com/kubernetes/enhancements/blob/299448d3d066d1e24054b6aa8fd8f494aad1c3c5/keps/sig-auth/20190607-certificates-api.md#signers

I hope I can add a commit that includes these details.

kbhawkey · 2020-02-11T14:29:11Z

Hello @sftim ,
Just checking if you are actively working on this pull request or if this pull request is
a placeholder for future changes?

sftim · 2020-02-11T15:48:11Z

I'm wondering if this would work better as a series of PRs to a long-lived branch. That way, I can get each PR reviewed individually.

Maybe that'd be a better idea? In which case, I should arrange for that new branch.

sftim · 2020-02-11T15:48:44Z

Alternative: I could do lots of small PRs to add disabled pages, and then enable them once the set of changes are ready.

kbhawkey · 2020-02-12T15:50:38Z

@sftim, It may be helpful to create an issue outlining your proposed work items and then you can check off the items with individual pull requests (the issue can manage the state of the collective PRs).
Otherwise this pull request becomes too large and I think it scares off reviewers. Also, people may want to collaborate with you.

sftim · 2020-02-19T00:34:22Z

/close

k8s-ci-robot · 2020-02-19T00:34:24Z

@sftim: Closed this PR.

In response to this:

/close

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.

sftim changed the title ~~20190711 add controller reference pages~~ Add controller reference pages Oct 14, 2019

k8s-ci-robot requested review from Rajakavitha1 and stewart-yu October 14, 2019 07:54

k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Oct 14, 2019

This was referenced Nov 5, 2019

Updating EndpointSlice documentation for beta release in 1.17 #17411

Merged

Add documentation for VolumeSnapshot Beta #17233

Merged

k8s-ci-robot changed the title ~~Add controller reference pages~~ [WIP] Add controller reference pages Nov 10, 2019

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 10, 2019

christophercarney reviewed Nov 12, 2019

View reviewed changes

sftim force-pushed the 20190711_add_controller_reference_pages branch from c21ae0b to 089e449 Compare December 10, 2019 04:12

sftim force-pushed the 20190711_add_controller_reference_pages branch from 089e449 to 02b6c65 Compare December 10, 2019 04:49

sftim added 3 commits December 10, 2019 04:57

Add reference documentation for built-in controllers

f090baf

Note clock skew impact on TTL-after-finished

21c92f7

Tidy garbage collection concept

1b006ad

(partial tidying)

sftim force-pushed the 20190711_add_controller_reference_pages branch from 02b6c65 to 1b006ad Compare December 10, 2019 04:57

sftim mentioned this pull request Dec 28, 2019

Providing more detail on EndpointSlice implementation #18343

Merged

sftim mentioned this pull request Jan 30, 2020

Docs do not explain purpose of serviceAccount.secrets field #4410

Closed

k8s-ci-robot closed this Feb 19, 2020

sftim mentioned this pull request Jul 15, 2020

Tidy EndpointSlice concept #22529

Merged

sftim mentioned this pull request Dec 16, 2020

Improvement for k8s.io/docs/concepts/overview/components/ #25658

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add controller reference pages #16885

[WIP] Add controller reference pages #16885

sftim commented Oct 14, 2019 •

edited

Loading

netlify bot commented Oct 14, 2019 •

edited

Loading

zparnold commented Oct 14, 2019 •

edited

Loading

sftim commented Oct 15, 2019

sftim commented Nov 10, 2019

christophercarney left a comment

christophercarney Nov 12, 2019

sftim Nov 29, 2019

sftim Dec 10, 2019

christophercarney Nov 12, 2019

k8s-ci-robot commented Dec 10, 2019

sftim commented Feb 4, 2020

kbhawkey commented Feb 11, 2020

sftim commented Feb 11, 2020

sftim commented Feb 11, 2020

kbhawkey commented Feb 12, 2020

sftim commented Feb 19, 2020

k8s-ci-robot commented Feb 19, 2020


		{{% capture body %}}

		The DaemonSet controller is built in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.

	The DaemonSet controller is built in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.
	The DaemonSet controller is built-in to the {{< glossary_tooltip term_id="kube-controller-manager" >}}.

[WIP] Add controller reference pages #16885

[WIP] Add controller reference pages #16885

Conversation

sftim commented Oct 14, 2019 • edited Loading

netlify bot commented Oct 14, 2019 • edited Loading

zparnold commented Oct 14, 2019 • edited Loading

sftim commented Oct 15, 2019

sftim commented Nov 10, 2019

christophercarney left a comment

Choose a reason for hiding this comment

christophercarney Nov 12, 2019

Choose a reason for hiding this comment

sftim Nov 29, 2019

Choose a reason for hiding this comment

sftim Dec 10, 2019

Choose a reason for hiding this comment

christophercarney Nov 12, 2019

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 10, 2019

sftim commented Feb 4, 2020

kbhawkey commented Feb 11, 2020

sftim commented Feb 11, 2020

sftim commented Feb 11, 2020

kbhawkey commented Feb 12, 2020

sftim commented Feb 19, 2020

k8s-ci-robot commented Feb 19, 2020

sftim commented Oct 14, 2019 •

edited

Loading

netlify bot commented Oct 14, 2019 •

edited

Loading

zparnold commented Oct 14, 2019 •

edited

Loading