Commit Graph

9 Commits

Author SHA1 Message Date
Andreas Jaeger f10f95b455 Docs: Make robust with using real links
Our tools noticed that keystone links to
https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html
which does not exist anymore.

The page was removed but the link to it was not changed. Replace this
and similar links with internal links that will work even if files are
moved - and can be verified, thus sphinx will error in case of broken
targets.

These changes include a few other fixes for broken keystone links, e.g.
to renamed anchors.

For the include files in admin/configuration.rst and
admin/federation/configure_federation.rst: Rename them to *inc.
The files were
published twice (as separate files and on this page) and thus
referencing failed. Renaming avoids this.

Also, put doctree outside of html tree so that it does not get
published.

Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549
2019-08-09 20:15:14 +02:00
Colleen Murphy dcb9d8d084 Enhance the mellon guide
Update, reorganize and clean up the mellon guide. Use the systemctl
command to modernize the service management commands. Add examples of
configuring all required endpoints in Apache to mirror the new section
on configuring protected endpoints in the main guide and replace the
lost examples from the consolidated WebSSO guide. Remove use of
``a2enmod`` since the Mellon module is automatically enabled by the
package on all supported distros.

Partial-bug: #1793374

Change-Id: If17d8e73688775b8aeae88f5d0907273bc8de193
2019-01-07 16:56:28 +01:00
Colleen Murphy 5cc61bb644 Use samltest.id as an example sandbox IdP
The federation documentation inconsistently references samltest.id
(formerly testshib.org, which is not well maintained) or a keystone IdP
(before keystone-to-keystone is introduced). This change switches the
examples to use samltest.id[1] and renames 'myidp' to 'samltest' where
appropriate. In the case of the WebSSO horizon configuration examples,
it's not appropriate to switch the openid examples to samltest because
samltest.id does not support OpenIDC. The examples are meant to show
that you can pair different protocols to a single IdP, so use 'acme' as
the example.

[1] https://samltest.id

Partial-bug: #1793374

Change-Id: I2633ba460182ed8ed5195a10cdaae663add8b1aa
2019-01-02 13:50:11 +01:00
Colleen Murphy 9bc2b8875d Fix nits in code blocks in federation guide
Fix inconsistent indentation of code-blocks, ensure shell samples
correctly differentiate betweeen root-required commands and non-root
commands in accordance with the openstack-manuals recommendations[1],
and use proper markup for interactive shell examples.

[1] http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/common/conventions.rst

Partial-bug: #1793374

Change-Id: Ia9e5280d131e1aa50af41aff6155eb07954b7d15
2019-01-02 13:49:33 +01:00
Colleen Murphy 40e0f5d976 Bring SP/IdP URLs closer to style guide guidance
The documentation style guide recommends using example URLs for
OpenStack services that look like
`http://<service>.openstack.example.org`. This patch changes the URLs
for hypothetical keystone Service Providers to use HTTPS endpoints to
set a good example of security, to use the example.org domain instead of
localhost or example.com, to include keystone in the name for clarity of
what the service is, and to use a consistent URL path and port. It
doesn't include 'openstack' in the domain name because that becomes a
bit long.

[1] https://docs.openstack.org/doc-contrib-guide/writing-style/urls.html

Partial-bug: #1793374

Change-Id: I8e12edaa589be3c8e71b10d0609c057fd2bfb247
2018-12-30 11:48:50 -08:00
Colleen Murphy 131acaccaf 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
2018-12-30 11:32:43 -08:00
Vishakha Agarwal 67ecc72a05 Update doc with samltest.id
testshib.org is no longer maintained. Now keystone
uses samltest.id for federation.

This patch updates the configuration doc for user
to configure SP with samltest.id.

Change-Id: I88fc0b115614c237a527f83b8ad742fe5238cae1
2018-12-26 10:28:38 +00:00
narnt e2df5e0631 Clarify location for HTTPD instructions
Closes-bug: #1786594

Change-Id: I2c4030281146d8d374df79bb25a259964ac64a63
2018-12-21 15:55:23 -08:00
Suramya Shah fdf7a5b66d Consolidate Keystone docs: federated-identity.rst
Consolidate advanced-topics/federation into the admin guide.

Change-Id: I35c3d261ecf7c042c30c1272d4af85a0916515e2
2018-12-08 19:09:21 +01:00