📖 Note on Manager#GetClient about delegating clients #522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: DirectXMan12 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 |
k8s-ci-robot
added
approved
While the concrete Options struct documents delegating behavior, and the main overview documents it as well, this adds a note to manager#GetClient that it may return a non-live client, just to avoid confusion.
DirectXMan12
force-pushed
the
docs/extra-manager-client-docs
branch
from
9f7f351
to
19ac705
Compare
alenkacz
approved these changes
Jul 17, 2019
k8s-ci-robot
added
the
lgtm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While the concrete Options struct documents delegating behavior, and the
main overview documents it as well, this adds a note to
manager#GetClientthat it may return a non-live client, just to avoid confusion.
For reference, it's also documented @ https://godoc.org/sigs.k8s.io/controller-runtime#hdr-Clients_and_Caches and https://godoc.org/sigs.k8s.io/controller-runtime/pkg/manager#Options, but it may not always be obvious that you need to look in either of those places.
We don't concretely say what the client will be, since it's an interface, just that it may be non-direct. Concrete documentation is left to the referenced Options func.