documented config options are deprecated

Bug #1679238 reported by Lance Bragstad on 2017-04-03
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
keystonemiddleware
Medium
Jaewoo Park

Bug Description

In our documentation, we're advertising the usage of deprecated configuration options [0] [1] (see the nova section of the linked configuration guide).

This is misleading to readers. The deprecation warnings supply the thing we want users to provide, which is `identity_uri`. We should update the documentation to accurately reflect the options we want deployers to use.

[0] https://github.com/openstack/keystonemiddleware/blob/a2e3d60644aadb4ecb3d49dadbcd5d4c1dec2176/doc/source/middlewarearchitecture.rst#configuration
[1] https://github.com/openstack/keystonemiddleware/blob/a2e3d60644aadb4ecb3d49dadbcd5d4c1dec2176/keystonemiddleware/auth_token/_auth.py#L143-L159

Changed in keystonemiddleware:
assignee: nobody → Kristi Nikolla (knikolla)
status: New → Confirmed
importance: Undecided → Medium
tags: added: documentation low-hanging-fruit
Lance Bragstad (lbragstad) wrote :

Automatically unassigning due to inactivity.

Changed in keystonemiddleware:
assignee: Kristi Nikolla (knikolla) → nobody
Jaewoo Park (aselius) on 2017-08-14
Changed in keystonemiddleware:
assignee: nobody → Jaewoo Park (aselius)

Fix proposed to branch: master
Review: https://review.openstack.org/502523

Changed in keystonemiddleware:
status: Confirmed → In Progress

Reviewed: https://review.openstack.org/502523
Committed: https://git.openstack.org/cgit/openstack/keystonemiddleware/commit/?id=a8616e97e064735a005f7f5d76fef3bed2460484
Submitter: Jenkins
Branch: master

commit a8616e97e064735a005f7f5d76fef3bed2460484
Author: Jaewoo Park <email address hidden>
Date: Mon Sep 11 10:55:53 2017 -0700

    Update config docs to reflect non-deprecated methods

    Changed the keystone_authtoken part of the config docs so that it
    advertises the use of identity_uri over the deprecated auth_protocol,
    auth_port, auth_host

    Change-Id: Ia1351a83abed30f2680c2ce3a074028bd95158fb
    Closes-Bug: 1679238

Changed in keystonemiddleware:
status: In Progress → Fix Released

This issue was fixed in the openstack/keystonemiddleware 4.18.0 release.

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

Other bug subscribers