Bug 1311462 - URL is required but missing out for KeystonePasswordIdentityProvider from doc, need to add "optional" for "keyFile"
Summary: URL is required but missing out for KeystonePasswordIdentityProvider from doc...
Keywords:
Status: NEW
Alias: None
Product: OKD
Classification: Red Hat
Component: Documentation
Version: 3.x
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: Nobody
QA Contact: Ronaldo Rivera
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-02-24 10:09 UTC by XiaochuanWang
Modified: 2023-05-15 19:01 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description XiaochuanWang 2016-02-24 10:09:24 UTC
Document URL: 
https://docs.openshift.org/latest/install_config/configuring_authentication.html#KeystonePasswordIdentityProvider

Section Number and Name: 
#KeystonePasswordIdentityProvider

Describe the issue: 
A url is required but missing out under "provider", please refer to as below.
Need to add "optional" for "keyFile: keystonekey.pem"

    provider:
      url: https://keystone.example.com:5000/v3 # Keystone auth endpoint URL

Suggestions for improvement: 

  identityProviders:
  - challenge: true     # When true, unauthenticated token requests from non-web clients (like the CLI) are sent a WWW-Authenticate challenge header for this provider.
    login: true         # When true, unauthenticated token requests from web clients (like the web console) are redirected to a login page backed by this provider.
    name: keystone_auth # This provider name is prefixed to the returned user ID to form an identity name.
    provider:
      apiVersion: v1
      url: https://keystone.example.com:5000/v3 # Keystone auth endpoint URL
      domainName: default      # Keystone domain name. In Keystone, usernames are domain-specific. Currently this IdP only supports a single domain at a time.
      kind: KeystonePasswordIdentityProvider
      ca: ca.pem               # Optional: Certificate bundle to use to validate server certificates for the configured URL.
      certFile: keystone.pem   # Optional: Client certificate to present when making requests to the configured URL.
      keyFile: keystonekey.pem # Key for the client certificate. Required if certFile is specified.


Note You need to log in before you can comment on or make changes to this bug.