oidc: document oidc prefix flags and add note about Okta #5884
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
cncf-cla: yes
|
Deploy preview ready! Built with commit 13fae14 https://deploy-preview-5884--kubernetes-io-master-staging.netlify.com |
liggitt
reviewed
Oct 12, 2017
docs/admin/authentication.md
Outdated
| Kubernetes names (such as the `system:` users). For example, if the provider | ||
| URL is `https://accounts.google.com` and the username claim maps to `jane`, the | ||
| plugin will authenticate the user as: | ||
| If `--oidc-username-prefix` isn't provided and `--oidc-username-claim` is set to |
There was a problem hiding this comment.
can we hoist this into the table? I expected to see the default behavior and opt out info by the param there
ericchiang
force-pushed
the
oidc-new-flags
branch
2 times, most recently
from
41aafde to
c85b918
Compare
docs/admin/authentication.md
Outdated
| The first option is to use the `oidc` authenticator. This authenticator takes your `id_token`, `refresh_token` and your OIDC `client_secret` and will refresh your token automatically. Once you have authenticated to your identity provider: | ||
| The first option is to use the kubectl `oidc` authenticator, which set the `id_token` as a bearer token for all requests and refreshes the token once it expires. After you've logged into your provider, use kubectl to add your `id_token`, `refresh_token`, `client_id`, and `client_secret` to configure the plugin. | ||
|
|
||
| Providers that don't return an `id_token` as part of their refresh token response (e.g. [Okta](https://developer.okta.com/docs/api/resources/oidc.html#response-parameters-4)) aren't supported by this plugin and should use "Option 2" below. | ||
|
|
There was a problem hiding this comment.
which set -> which sets
There was a problem hiding this comment.
thanks for the review. updated
|
@ericchiang @liggitt One comment in the text. Otherwise, Docs LGTM. |
ericchiang
force-pushed
the
oidc-new-flags
branch
from
c85b918 to
13fae14
Compare
|
@liggitt Are you ready to give tech approval? Thanks. |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
tengqm
pushed a commit
to tengqm/website
that referenced
this pull request
Nov 6, 2017
bsteciuk
pushed a commit
to bsteciuk/kubernetes.github.io
that referenced
this pull request
Dec 1, 2017
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.
Document the new
--oidc-[group|username]-prefixflags and add a note about Okta's refreshing. Also remove the "extra-scopes" field since it's no longer used (kubernetes/kubernetes#45317).cc @kubernetes/sig-auth-pr-reviews
Docs for kubernetes/kubernetes#50875
Closes kubernetes/kubernetes#36847
This change is