Merge "Docs: Keystone AD/LDAP cleanup"

doc/source/install-guide/configure-keystone.rst

@@ -27,41 +27,80 @@ certificates and keys to use with Keystone.
 
 .. _Securing services with SSL certificates: configure-sslcertificates.html
 
-Implementing LDAP (or AD) Back-Ends
+Implementing LDAP (or Active Directory) Back ends
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In many environments there may already be a LDAP (or Active Directory) service
+Deployers that already have LDAP or Active Directory (AD) infrastructure
-available which already has Users, Groups and User-Group assignment data.
+deployed can use the built-in Keystone support for those identity services.
-Keystone can be configured to make use of the LDAP service using
+Keystone can use the existing users, groups and user-group relationships to
-Domain-specific Back-End configuration.
+handle authentication and access control in an OpenStack deployment.
 
-While it is possible to set the Keystone Identity Back-End to use LDAP for
+.. note::
-the Default domain, this is not recommended. It is a better practice to use
-the Default domain for service accounts and to configure additional Domains
-for LDAP services which provide general User/Group data.
 
-Example implementation in user_variables.yml:
+   Although deployers can configure the default domain in Keystone to use LDAP
+   or AD identity back ends, **this is not recommended**. Deployers should
+   create an additional domain in Keystone and configure an LDAP/AD back end
+   for that domain.
 
-keystone_ldap:
+   This is critical in situations where the identity back end cannot
-  Users:
+   be reached due to network issues or other problems. In those situations,
-    url: "ldap://10.10.10.10"
+   the administrative users in the default domain would still be able to
-    user: "root"
+   authenticate to keystone using the default domain which is not backed by
-    password: "secrete"
+   LDAP or AD.
-    ...
-  Admins:
-    url: "ldap://20.20.20.20"
-    user: "root"
-    password: "secrete"
-    ...
 
-This will place two configuration files into /etc/keystone/domains/, both of
+Deployers can add domains with LDAP back ends by adding variables in
-which will be configured to use the LDAP driver.
+``/etc/openstack_deploy/user_variables.yml``. For example, this dictionary will
+add a new Keystone domain called ``Users`` that is backed by an LDAP server:
 
- - keystone.Users.conf
+.. code-block:: yaml
- - keystone.Admins.conf
 
-Each first level key entry is a domain name. Each entry below that are
+    keystone_ldap:
-key-value pairs for the 'ldap' section in the configuration file.
+      Users:
+        url: "ldap://10.10.10.10"
+        user: "root"
+        password: "secrete"
+
+Adding the YAML block above will cause the Keystone playbook to create a
+``/etc/keystone/domains/keystone.Users.conf`` file within each Keystone service
+container that configures the LDAP-backed domain called ``Users``.
+
+Deployers can create more complex configurations that use LDAP filtering and
+consume LDAP as a read-only resource. The following example shows how to apply
+these configurations:
+
+.. code-block:: yaml
+
+    keystone_ldap:
+      MyCorporation:
+          url: "ldaps://ldap.example.com"
+          user_tree_dn: "ou=Users,o=MyCorporation"
+          group_tree_dn: "cn=openstack-users,ou=Users,o=MyCorporation"
+          user_objectclass: "inetOrgPerson"
+          user_allow_create: "False"
+          user_allow_update: "False"
+          user_allow_delete: "False"
+          group_allow_create: "False"
+          group_allow_update: "False"
+          group_allow_delete: "False"
+          user_id_attribute: "cn"
+          user_name_attribute: "uid"
+          user_filter: "(groupMembership=cn=openstack-users,ou=Users,o=MyCorporation)"
+
+In the *MyCorporation* example above, Keystone will use the LDAP server as a
+read-only resource. The configuration also ensures that Keystone filters the
+list of possible users to the ones that exist in the
+``cn=openstack-users,ou=Users,o=MyCorporation`` group.
+
+Horizon offers multi-domain support that can be enabled with an Ansible
+variable during deployment:
+
+.. code-block:: yaml
+
+    horizon_keystone_multidomain_support: True
+
+Enabling multi-domain support in Horizon will add the ``Domain`` input field on
+the Horizon login page and it will add other domain-specific features in the
+*Identity* section.
 
 More details regarding valid configuration for the LDAP Identity Back-End can
 be found in the `Keystone Developer Documentation`_ and the