Browse Source

Restructure federation guide

Having everything on a single page is nice for ctrl-F-ability but it
makes the flow very confusing. This change breaks the guide into three
logical parts: the introduction, the configuration steps, and the
advanced mapping rules guide. Keeping all the configuration steps within
one page means it can still be searched easily, but removing the prose
of the introduction and breaking out the deep-dive mapping rules guide
reduces clutter and enhances readability.

Partial-bug: #1793374

Change-Id: Id2fd59d62a2675691d545e4cd0404558f00cf481
tags/15.0.0.0rc1
Colleen Murphy 6 months ago
parent
commit
131acaccaf

+ 6
- 0
doc/source/admin/federation/configure_federation.rst View File

@@ -538,3 +538,9 @@ scoped token from the SP.
538 538
     --os-remote-project-name federated_project \
539 539
     --os-remote-project-domain-name federated_domain \
540 540
     token issue
541
+
542
+
543
+.. include:: openidc.rst
544
+.. include:: mellon.rst
545
+.. include:: shibboleth.rst
546
+.. include:: websso.rst

+ 5
- 8
doc/source/admin/federation/federated_identity.rst View File

@@ -2,12 +2,9 @@
2 2
 Federated Identity
3 3
 ==================
4 4
 
5
-Keystone's one-stop-shop for all federated identity documentation.
5
+.. toctree::
6
+    :maxdepth: 2
6 7
 
7
-.. include:: introduction.rst
8
-.. include:: configure_federation.rst
9
-.. include:: mapping_combinations.rst
10
-.. include:: openidc.rst
11
-.. include:: mellon.rst
12
-.. include:: shibboleth.rst
13
-.. include:: websso.rst
8
+    introduction.rst
9
+    configure_federation.rst
10
+    mapping_combinations.rst

+ 2
- 3
doc/source/admin/federation/mellon.rst View File

@@ -11,10 +11,10 @@
11 11
       License for the specific language governing permissions and limitations
12 12
       under the License.
13 13
 
14
+------------
14 15
 Setup Mellon
15
-============
16
+------------
16 17
 
17
-------------------------------------------
18 18
 Configure Apache HTTPD for mod_auth_mellon
19 19
 ------------------------------------------
20 20
 
@@ -73,7 +73,6 @@ Enable the ``auth_mellon`` module, for example:
73 73
 
74 74
     $ a2enmod auth_mellon
75 75
 
76
-----------------------------------
77 76
 Configuring the Mellon SP Metadata
78 77
 ----------------------------------
79 78
 

+ 2
- 3
doc/source/admin/federation/openidc.rst View File

@@ -11,10 +11,10 @@
11 11
       License for the specific language governing permissions and limitations
12 12
       under the License.
13 13
 
14
+--------------------
14 15
 Setup OpenID Connect
15
-====================
16
+--------------------
16 17
 
17
-----------------------------
18 18
 Configuring mod_auth_openidc
19 19
 ----------------------------
20 20
 
@@ -79,7 +79,6 @@ Once you are done, restart your Apache daemon:
79 79
 
80 80
     $ sudo service apache2 restart
81 81
 
82
-----
83 82
 Tips
84 83
 ----
85 84
 

+ 2
- 3
doc/source/admin/federation/shibboleth.rst View File

@@ -11,10 +11,10 @@
11 11
       License for the specific language governing permissions and limitations
12 12
       under the License.
13 13
 
14
+----------------
14 15
 Setup Shibboleth
15
-================
16
+----------------
16 17
 
17
------------------------------------------
18 18
 Configure Apache HTTPD for mod_shibboleth
19 19
 -----------------------------------------
20 20
 
@@ -78,7 +78,6 @@ Restart Apache, for example:
78 78
 
79 79
     $ service apache2 restart
80 80
 
81
----------------------------
82 81
 Configuring shibboleth2.xml
83 82
 ---------------------------
84 83
 

+ 2
- 3
doc/source/admin/federation/websso.rst View File

@@ -11,10 +11,10 @@
11 11
       License for the specific language governing permissions and limitations
12 12
       under the License.
13 13
 
14
+------------------------------
14 15
 Setup Web Single Sign-On (SSO)
15
-==============================
16
+------------------------------
16 17
 
17
-----------------
18 18
 Keystone Changes
19 19
 ----------------
20 20
 
@@ -171,7 +171,6 @@ Alternatively, a generic option may be set at the `[federation]` level.
171 171
 <https://git.openstack.org/cgit/openstack/keystone/plain/etc/sso_callback_template.html>`__
172 172
 template into the location specified by `[federation]/sso_callback_template`.
173 173
 
174
----------------
175 174
 Horizon Changes
176 175
 ---------------
177 176
 

Loading…
Cancel
Save