1 # Copyright 2020 Canonical Ltd.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
18 The maximum file size, in megabytes.
20 If there is a reverse proxy in front of Keystone, it may
21 need to be configured to handle the requested size.
23 ingress_whitelist_source_range:
26 A comma-separated list of CIDRs to store in the
27 ingress.kubernetes.io/whitelist-source-range annotation.
29 This can be used to lock down access to
30 Keystone based on source IP address.
34 description: TLS Secret name
38 description: Ingress URL
42 description: Region ID to be created when starting the service
46 description: Keystone DB Password
50 description: Admin username to be created when starting the service
54 description: Admin password to be created when starting the service
58 description: Admin project to be created when starting the service
62 description: Service Username to be created when starting the service
66 description: Service Password to be created when starting the service
70 description: Service Project to be created when starting the service
74 description: User domain name (Hardcoded in the container start.sh script)
79 Project domain name (Hardcoded in the container start.sh script)
83 description: Token keys expiration in seconds
87 description: Boolean to enable/disable LDAP authentication
89 ldap_authentication_domain_name:
91 description: Name of the domain which use LDAP authentication
95 description: URL of the LDAP server
96 default: "ldap://localhost"
99 description: User to bind and search for users
103 description: Password to bind and search for users
105 ldap_chase_referrals:
108 Sets keystone’s referral chasing behavior across directory partitions.
109 If left unset, the system’s default behavior will be used.
114 Defines the maximum number of results per page that keystone should
115 request from the LDAP server when listing objects. A value of zero (0)
121 Root of the tree in LDAP server in which Keystone will search for users
123 ldap_user_objectclass:
126 LDAP object class that Keystone will filter on within user_tree_dn to
127 find user objects. Any objects of other classes will be ignored.
128 default: inetOrgPerson
129 ldap_user_id_attribute:
132 This set of options define the mapping to LDAP attributes for the three
133 key user attributes supported by Keystone. The LDAP attribute chosen for
134 user_id must be something that is immutable for a user and no more than
135 64 characters in length. Notice that Distinguished Name (DN) may be
136 longer than 64 characters and thus is not suitable. An uid, or mail may
139 ldap_user_name_attribute:
142 This set of options define the mapping to LDAP attributes for the three
143 key user attributes supported by Keystone. The LDAP attribute chosen for
144 user_id must be something that is immutable for a user and no more than
145 64 characters in length. Notice that Distinguished Name (DN) may be
146 longer than 64 characters and thus is not suitable. An uid, or mail may
149 ldap_user_pass_attribute:
152 This set of options define the mapping to LDAP attributes for the three
153 key user attributes supported by Keystone. The LDAP attribute chosen for
154 user_id must be something that is immutable for a user and no more than
155 64 characters in length. Notice that Distinguished Name (DN) may be
156 longer than 64 characters and thus is not suitable. An uid, or mail may
158 default: userPassword
162 This filter option allow additional filter (over and above
163 user_objectclass) to be included into the search of user. One common use
164 of this is to provide more efficient searching, where the recommended
165 search for user objects is (&(objectCategory=person)(objectClass=user)).
166 By specifying user_objectclass as user and user_filter as
167 objectCategory=person in the Keystone configuration file, this can be
170 ldap_user_enabled_attribute:
173 In Keystone, a user entity can be either enabled or disabled. Setting
174 the above option will give a mapping to an equivalent attribute in LDAP,
175 allowing your LDAP management tools to disable a user.
177 ldap_user_enabled_mask:
180 Some LDAP schemas, rather than having a dedicated attribute for user
181 enablement, use a bit within a general control attribute (such as
182 userAccountControl) to indicate this. Setting user_enabled_mask will
183 cause Keystone to look at only the status of this bit in the attribute
184 specified by user_enabled_attribute, with the bit set indicating the
187 ldap_user_enabled_default:
190 Most LDAP servers use a boolean or bit in a control field to indicate
191 enablement. However, some schemas might use an integer value in an
192 attribute. In this situation, set user_enabled_default to the integer
193 value that represents a user being enabled.
195 ldap_user_enabled_invert:
198 Some LDAP schemas have an “account locked” attribute, which is the
199 equivalent to account being “disabled.” In order to map this to the
200 Keystone enabled attribute, you can utilize the user_enabled_invert
201 setting in conjunction with user_enabled_attribute to map the lock
202 status to disabled in Keystone.
204 ldap_group_objectclass:
206 description: The LDAP object class to use for groups.
207 default: groupOfNames
210 description: The search base to use for groups.
215 Enable Transport Layer Security (TLS) for providing a secure connection
216 from Keystone to LDAP (StartTLS, not LDAPS).
218 ldap_tls_cacert_base64:
221 CA certificate in Base64 format (if you have the PEM file, text inside
222 "-----BEGIN CERTIFICATE-----"/"-----END CERTIFICATE-----" tags).
227 Defines how the certificates are checked for validity in the client
228 (i.e., Keystone end) of the secure connection (this doesn’t affect what
229 level of checking the server is doing on the certificates it receives
230 from Keystone). Possible values are "demand", "never", and "allow". The
231 default of demand means the client always checks the certificate and
232 will drop the connection if it is not provided or invalid. never is the
233 opposite—it never checks it, nor requires it to be provided. allow means
234 that if it is not provided then the connection is allowed to continue,
235 but if it is provided it will be checked—and if invalid, the connection