[DOCS] Example endpoints cause problems on some systems

Bug #1324195 reported by Michael McCune
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Sahara
Fix Released
Low
mandar

Bug Description

While testing the Icehouse release on a RHEL6 system with Python 2.6 installed, the backslash character present in the endpoint examples is being reproduced in the endoint. (http://docs.openstack.org/developer/sahara/horizon/installation.guide.html)

For example, typing the following in the console:

# keystone endpoint-create --service sahara --region RegionOne \
    --publicurl "http://10.0.0.2:8386/v1.1/\$(tenant_id)s" \
    --adminurl "http://10.0.0.2:8386/v1.1/\$(tenant_id)s" \
    --internalurl "http://10.0.0.2:8386/v1.1/\$(tenant_id)s"

will produce an endpoint that appears as following:

http://10.0.0.2:8386/v1.1/\$(tenant_id)s

The backslash is present in the keystone endpoint which causes any application using that endpoint to fail as the backslash is replicated into the GET query.

This only appears to happen with Python 2.6.

According to the nova-compute documentation (http://docs.openstack.org/icehouse/install-guide/install/yum/content/nova-controller.html) there is another method using the % character without escaping instead of the $.

Changing the previous example to:

# keystone endpoint-create --service sahara --region RegionOne \
    --publicurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \
    --adminurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \
    --internalurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s"

works on the target system. This method also appears in other project's endpoints.

Assuming there are no side-effects, the documentation should be upgraded to use the "%()s" substitution instead of "$()s".

description: updated
Changed in sahara:
status: New → Opinion
Changed in sahara:
status: Opinion → Confirmed
importance: Undecided → Low
milestone: none → juno-2
mandar (mandar-sherikar)
Changed in sahara:
assignee: nobody → mandar (mandar-sherikar)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to sahara (master)

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

Changed in sahara:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to sahara (master)

Reviewed: https://review.openstack.org/99922
Committed: https://git.openstack.org/cgit/openstack/sahara/commit/?id=d943a609108160ba33c894e3511478cb9f186a03
Submitter: Jenkins
Branch: master

commit d943a609108160ba33c894e3511478cb9f186a03
Author: mandar <email address hidden>
Date: Fri Jun 13 17:37:13 2014 +0530

    Installation guide updated

    While testing the Icehouse release on a RHEL6 system with Python 2.6 installed,
    the backslash character present in the endpoint examples was being reproduced in the endpoint.
    fixed by using %() instead of \$().

    Change-Id: I634dd979a6f7de231d4bf8cbe7c5376dc70f1be2
    Closes-Bug: #1324195

Changed in sahara:
status: In Progress → Fix Committed
Changed in sahara:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in sahara:
milestone: juno-2 → 2014.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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