OpenStack Identity (keystone)

Missing linked topic

Bug #1786594 reported by Egor Panfilov
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Low
Colleen Murphy
OpenStack Identity (keystone) stein-2

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [x] This doc is inaccurate in this way:

On page https://docs.openstack.org/keystone/latest/advanced-topics/federation/shibboleth.html presents next line: 'Follow the steps outlined at: Running Keystone in HTTPD for SUSE, RedHat or Ubuntu.'

The main problem is that "Running Keystone in HTTPD" was removed several releases ago, thus we have incomplete tutorial on using federation with Shibboleth.

- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: on 2018-08-07 23:41
SHA: a2b510c17638d31d2983317a4261f9dc27507d24
Source: https://git.openstack.org/cgit/openstack/keystone/tree/doc/source/advanced-topics/federation/shibboleth.rst
URL: https://docs.openstack.org/keystone/latest/advanced-topics/federation/shibboleth.html

Revision history for this message
Colleen Murphy (krinkle) wrote :

In https://review.openstack.org/516813 we updated the doc to point to the apache-related parts of the various install guides, e.g.

https://docs.openstack.org/keystone/latest/install/keystone-install-obs.html#configure-the-apache-http-server
https://docs.openstack.org/keystone/latest/install/keystone-install-rdo.html#configure-the-apache-http-server
https://docs.openstack.org/keystone/latest/install/keystone-install-ubuntu.html#configure-the-apache-http-server

Those links look correct to me, can you explain why you think those are incomplete?

Changed in keystone:
status: New → Incomplete
Revision history for this message
Egor Panfilov (erakli) wrote :

Hi, Coleen. I mentioned inconsistency of the name of linked section in https://docs.openstack.org/keystone/latest/advanced-topics/federation/shibboleth.html. The text points to the section "Running Keystone in HTTPD", while there is no such section in the pages you presented.

This section was last pointed in Mitaka release (https://docs.openstack.org/keystone/mitaka/federation/shibboleth.html) and there was one (https://docs.openstack.org/keystone/mitaka/apache-httpd.html).

Then the name of section was changed in Newton (https://docs.openstack.org/newton/install-guide-obs/keystone-install.html) and main article pointed to correct name (https://docs.openstack.org/newton/config-reference/identity/federated-identity.html).

Revision history for this message
Colleen Murphy (krinkle) wrote :

I understand now, thanks!

Changed in keystone:
status: Incomplete → Triaged
importance: Undecided → Low
tags: added: low-hanging-fruit
Revision history for this message
Colleen Murphy (krinkle) wrote :

So the line should probably be "Configure keystone under Apache, following the steps in the install guide for SUSE, RedHat or Ubuntu." or something like that

Revision history for this message
Egor Panfilov (erakli) wrote :

Yeah, it would be fine.

Revision history for this message
Maria N. (narnt) wrote :

Hi, can I take this task? If I understood right, I should replace phrase "Running Keystone in HTTPD" to something relevant?

Maria N. (narnt)
Changed in keystone:
assignee: nobody → Maria N. (narnt)
Maria N. (narnt)
Changed in keystone:
status: Triaged → In Progress
Revision history for this message
Maria N. (narnt) wrote :

I maked a new branch to this task, maked a commit, but when I tried to push it I got this error: "fatal: remote error: access denied or repository not exported: /openstack/keystone". It is problem with permission, and I must be first confirmed by someone?

Revision history for this message
Colleen Murphy (krinkle) wrote :

Maria, you need to set up a Gerrit account with an SSH key, see the instructions here https://docs.openstack.org/contributors/common/setup-gerrit.html

Revision history for this message
Maria N. (narnt) wrote :

Colleen, thank you!

OpenStack Infra (hudson-openstack)
Changed in keystone:
assignee: Maria N. (narnt) → Colleen Murphy (krinkle)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/613670
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=e2df5e0631056316a39e412d010268ac2ea26c31
Submitter: Zuul
Branch: master

commit e2df5e0631056316a39e412d010268ac2ea26c31
Author: narnt <email address hidden>
Date: Fri Oct 26 19:44:14 2018 +0200

    Clarify location for HTTPD instructions

    Closes-bug: #1786594

    Change-Id: I2c4030281146d8d374df79bb25a259964ac64a63

Changed in keystone:
status: In Progress → Fix Released
Lance Bragstad (lbragstad)
Changed in keystone:
milestone: none → stein-2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/keystone 15.0.0.0rc1

This issue was fixed in the openstack/keystone 15.0.0.0rc1 release candidate.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.