-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Bug 1442252 - Reorg of the Configuring Authentication and User Agent page #4196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
141 changes: 141 additions & 0 deletions
141
install_config/authentication/configuring_authentication_allow_all.adoc
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| [[install-config-configuring-authentication-allow]] | ||
| = Configuring Allow All Authentication | ||
| {product-author} | ||
| {product-version} | ||
| :data-uri: | ||
| :icons: | ||
| :experimental: | ||
| :toc: macro | ||
| :toc-title: | ||
| :prewrap!: | ||
|
|
||
| {nbsp} + | ||
|
|
||
|
|
||
| You can configure the {product-title} master configuration file to use Allow All authentication in your cluster. | ||
|
|
||
| [[install-config-configuring-authentication-allow-intro]] | ||
| == Configuring the Allow All Identity Provider | ||
|
|
||
| Setting the `AllowAllPasswordIdentityProvider` in the `identityProviders` stanza allows any non-empty user name and password to log in. This is the default | ||
| identity provider when running {product-title} without a | ||
| xref:../../install_config/master_node_configuration.adoc#install-config-master-node-configuration[master configuration file]. | ||
|
|
||
| To configure the Allow All identity provider: | ||
|
|
||
| //tag::configuring_authentication_common_steps1[] | ||
|
|
||
| . Edit the master configuration file: | ||
| + | ||
| ---- | ||
| /etc/origin/master/master-config.yaml | ||
| ---- | ||
|
|
||
| . Set the following parameters, as needed, or use the default values: | ||
| + | ||
| ---- | ||
| oauthConfig: | ||
| ... | ||
| identityProviders: | ||
| - challenge: true | ||
| login: true | ||
| ---- | ||
| + | ||
| [cols="2a,8a",options="header"] | ||
| |=== | ||
| |Parameter | Description | ||
| |`challenge` | When `true`, unauthenticated token requests from non-web | ||
| clients (like the CLI) are sent a `WWW-Authenticate` challenge header. Not | ||
| supported by all identity providers. | ||
|
|
||
| To prevent cross-site request forgery (CSRF) attacks against browser clients | ||
| Basic authentication challenges are only sent if a `X-CSRF-Token` header is | ||
| present on the request. Clients that expect to receive Basic `WWW-Authenticate` | ||
| challenges should set this header to a non-empty value. | ||
|
|
||
| |`login` | When `true`, unauthenticated token requests from web clients | ||
| (like the web console) are redirected to a login page backed by this provider. | ||
| Not supported by all identity providers. | ||
|
|
||
| If you want users to be sent to a branded page before being redirected to | ||
| the identity provider's login, then set `oauthConfig -> alwaysShowProviderSelection: true`. This provider selection page can be | ||
| xref:../../install_config/web_console_customization.adoc#customizing-the-login-page[customized]. | ||
| |=== | ||
| //end::configuring_authentication_common_steps1[] | ||
|
|
||
| . Specify the `mappingMethod` parameter to determine how identities are mapped to users. | ||
| //tag::configuring_authentication_common_steps2[] | ||
| + | ||
| ---- | ||
| oauthConfig: | ||
| ... | ||
| identityProviders: | ||
| - mappingMethod: claim | ||
| ---- | ||
| + | ||
| [cols="2,8"] | ||
| |=== | ||
| |Parameter | Description | ||
|
|
||
| |`claim` | The default value. Provisions a user with the identity's preferred | ||
| user name. Fails if a user with that user name is already mapped to another | ||
| identity. | ||
|
|
||
| |`lookup` | Looks up an existing identity, user identity mapping, and user, | ||
| but does not automatically provision users or identities. This allows cluster | ||
| administrators to set up identities and users manually, or using an external | ||
| process. For more information on provisioning users with the `lookup` method, | ||
| see xref:../../install_config/authentication/configuring_authentication_mapping_method.adoc#install-config-configuring-authentication-lookup[Manually Provisioning a User When Using the Lookup Mapping Method]. | ||
|
|
||
| |`generate` | Provisions a user with the identity's preferred user name. If a | ||
| user with the preferred user name is already mapped to an existing identity, a | ||
| unique user name is generated. For example, `myuser2`. This method should not be | ||
| used in combination with external processes that require exact matches between | ||
| {product-title} user names and identity provider user names, such as LDAP group | ||
| sync. | ||
|
|
||
| |`add` | Provisions a user with the identity's preferred user name. If a user | ||
| with that user name already exists, the identity is mapped to the existing user, | ||
| adding to any existing identity mappings for the user. Required when multiple | ||
| identity providers are configured that identify the same set of users and map to | ||
| the same user names. | ||
| |=== | ||
| //end::configuring_authentication_common_steps2[] | ||
|
|
||
| . Specify the following values to configure the Allow All provider: | ||
| + | ||
| .Master Configuration Using `AllowAllPasswordIdentityProvider` | ||
| ==== | ||
|
|
||
| ---- | ||
| oauthConfig: | ||
| ... | ||
| identityProviders: | ||
| - challenge: true | ||
| login: true | ||
| mappingMethod: claim | ||
| name: my_allow_provider <1> | ||
| provider: | ||
| apiVersion: v1 | ||
| kind: AllowAllPasswordIdentityProvider <2> | ||
| ---- | ||
| <1> This provider name is prefixed to provider user names to form an identity | ||
| name. | ||
| <2> Specify *_AllowAllPasswordIdentityProvider_* as the provider kind. | ||
| ==== | ||
| //tag::restart-after-config-master[] | ||
| . Restart the {product-title} service. | ||
| + | ||
| ifdef::openshift-enterprise[] | ||
| ---- | ||
| # systemctl restart atomic-openshift-master | ||
| ---- | ||
| endif::[] | ||
| ifdef::openshift-origin[] | ||
| ---- | ||
| # systemctl restart origin-master | ||
| ---- | ||
| endif::[] | ||
| //end::restart-after-config-master[] | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍