[docs] Missing documentation for fuel client configuration file

Bug #1557443 reported by Oleg S. Gelbukh
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Committed
High
Maria Zlatkova
Mitaka
Fix Released
High
Maria Zlatkova

Bug Description

Detailed bug description:

Fuel client uses $HOME/.config/fuel/fuel_client.yaml file as a source for default settings. These settings include user name and password for Keystone. However, this file is not mentioned in Fuel documentation or in interactive help in fuel-client app.

Steps to reproduce:

1. Install the Fuel Master node.
2. Change password for 'admin' user:

  fuel change-password --new-pass=123123

3. Run 'fuel' command without --password argument.

4. Look up in documentation, how to make the password change known to the client permanently.

Expected results:

User guide contains description of how to update password in config file to make it permanently known to client.

Actual result:

User guide only tells about --password command line option. No mention about fuel_client.yaml file.

Reproducibility:

Always reproduces

Workaround:

Read the source code of Fuel client application.

Impact:

Documentation missing.

Tags: area-docs
Changed in fuel:
assignee: nobody → Fuel Documentation Team (fuel-docs)
milestone: none → 9.0
importance: Undecided → High
status: New → Confirmed
tags: added: area-docs
Changed in fuel:
milestone: 9.0 → 10.0
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (master)

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

Changed in fuel:
assignee: Fuel Documentation Team (fuel-docs) → Maria Zlatkova (mzlatkova)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (master)

Reviewed: https://review.openstack.org/320480
Committed: https://git.openstack.org/cgit/openstack/fuel-docs/commit/?id=d56fc3b92da1e112dba53b6bb52c8c2715f2daae
Submitter: Jenkins
Branch: master

commit d56fc3b92da1e112dba53b6bb52c8c2715f2daae
Author: Maria Zlatkova <email address hidden>
Date: Tue May 24 17:19:11 2016 +0300

    [UG] Client configuration file

    Adds information about Fuel client configuration file to
    the CLI section of the User Guide.

    Change-Id: I14a38650bc2a1fac808f3da5da7e9b282ca226b5
    Closes-Bug: #1557443

Changed in fuel:
status: In Progress → Fix Committed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (stable/mitaka)

Fix proposed to branch: stable/mitaka
Review: https://review.openstack.org/328282

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (stable/mitaka)

Reviewed: https://review.openstack.org/328282
Committed: https://git.openstack.org/cgit/openstack/fuel-docs/commit/?id=f79a3c8ee42c50fcd0402ccaee078f4a8afc6aba
Submitter: Jenkins
Branch: stable/mitaka

commit f79a3c8ee42c50fcd0402ccaee078f4a8afc6aba
Author: Maria Zlatkova <email address hidden>
Date: Tue May 24 17:19:11 2016 +0300

    [UG] Client configuration file

    Adds information about Fuel client configuration file to
    the CLI section of the User Guide.

    Change-Id: I14a38650bc2a1fac808f3da5da7e9b282ca226b5
    Closes-Bug: #1557443
    (cherry picked from commit d56fc3b92da1e112dba53b6bb52c8c2715f2daae)

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.