Skip to content

Commit

Permalink
Clarify the necessity of custom authentication
Browse files Browse the repository at this point in the history
Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
  • Loading branch information
nolar committed May 13, 2021
1 parent 0873136 commit 2f95acd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/authentication.rst
Expand Up @@ -14,6 +14,12 @@ authentication methods and piggybacks the existing Kubernetes clients.
Custom authentication
=====================

In most setups, the normal authentication from one of the API client libraries
is enough --- it works out of the box if those clients are installed
(see :ref:`auth-piggybacking` below). Custom authentication is only needed
if the normal authentication methods do not work for some reason, such as if
you have a specific and unusual cluster setup (e.g. your own auth tokens).

To implement a custom authentication method, one or a few login-handlers
can be added. The login handlers should either return nothing (``None``)
or an instance of `kopf.ConnectionInfo`::
Expand Down

0 comments on commit 2f95acd

Please sign in to comment.