Controller-runtime: Document controller health probes

[GrigoriyMikhalkin]

Was mentioned in comments to https://github.com/kubernetes-sigs/controller-runtime/pull/419, that it's not quite clear how to set health probes for controller.

Would be nice to add minimal example of manager with health/readiness checks.

P.S. I would gladly do that

[alexeldeib]

I really like the examples provided by controller runtime, for example the package level one: https://github.com/kubernetes-sigs/controller-runtime/blob/master/example_test.go

and the webhook specific one: https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/webhook/example_test.go

perhaps we could had a runnable main.go example with healthz?

[alexeldeib]

If that's already what you meant, i'd go for it!

[GrigoriyMikhalkin]

@alexeldeib Was thinking more about adding example to https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/manager/example_test.go (please check PR).

But adding runnable example(in addition), also a good idea. Maybe we can add health probes to examples in https://github.com/kubernetes-sigs/controller-runtime/tree/master/examples, what you think?

[vincepri]

/kind documentation
/help

[k8s-ci-robot]

@vincepri:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/kind documentation
/help

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.

[LeoLiuYan]

Maybe I can work for it?

[LeoLiuYan]

/assign

[LeoLiuYan]

/assign

[GrigoriyMikhalkin]

@LeoLiuYan There's already PR: https://github.com/kubernetes-sigs/controller-runtime/pull/856

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.

[stevekuznetsov]

/reopen

This is not fixed and it's still entirely unclear how this works for a newcomer to this framework. Why do health and readiness probes have names? When do they start running? How do multiple interact?

[k8s-ci-robot]

@stevekuznetsov: Reopened this issue.

In response to this:

/reopen

This is not fixed and it's still entirely unclear how this works for a newcomer to this framework. Why do health and readiness probes have names? When do they start running? How do multiple interact?

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.

[GrigoriyMikhalkin]

@stevekuznetsov There's [now] [closed PR](https://github.com/kubernetes-sigs/controller-runtime/pull/856/files) with simple probes example. Also, i could write chapter in kubebuilder book on health probes if that would be helpful.

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/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.