developer docs still have mention of bin/keystone-all

Bug #1462242 reported by Rushi Agrawal
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Low
Chloe Jensen

Bug Description

Looks like there is no keystone-all file any more, but still, developer docs (installing.rst and developing.rst) talk about keystone-all file. The docs should be updated. Not sure if I should include documentation team as well, as these are developer docs.

Revision history for this message
Dolph Mathews (dolph) wrote :

This bug is specific to keystone, unless there are specific mentions of our bin/ in other docs (which *should* not be the case).

tags: added: documentation
Changed in keystone:
status: New → Triaged
importance: Undecided → Low
tags: added: low-hanging-fruit
Changed in keystone:
assignee: nobody → Nao Nishijima (nao-nishijima-xt)
Revision history for this message
Nao Nishijima (nao-nishijima-xt) wrote :

Certainly, using keystone-all has not been recommended, but it still
exists. Actually, keystone-all is automatically made from source when
installing.
Would you suggest to add recommended way (via httpd/keystone) to
document, or just remove keystone-all from it?

Changed in keystone:
assignee: Nao Nishijima (nao-nishijima-xt) → nobody
Changed in keystone:
assignee: nobody → Jason (jjasonobrien)
Revision history for this message
Jason O'Brien (jason10258) wrote :

We (@cjensen17 and I) are going to just add the recommended way which apparently is the httpd or Apache2 way. Any other suggestions on what to do next?

Chloe Jensen (cjens)
Changed in keystone:
assignee: Jason O'Brien (jason10258) → Chloe Jensen (cjensen17)
Changed in keystone:
assignee: Chloe Jensen (cjens) → Jason O'Brien (jason10258)
status: Triaged → In Progress
Revision history for this message
David Stanek (dstanek) wrote :

I don't think I would recommend using Apache in a dev environment. IME it's much easier when you are just firing up the server to do work.

What has been recommended and I totally agree with is that keystone-all should not be used for production.

Revision history for this message
David Stanek (dstanek) wrote :

This bug is not correct at all. It says that there is not keystone-all file anymore. The file no longer exists in bin/, but is automatically created when installed into a venv (like when running tox). If it is not created in the venv created using tools/with_venv.sh then we should make sure 'python setup.py develop' gets called. Then we can adjust the docs to show the new command.

Just an FYI I almost always run .tox/py27/bin/keyston-all when I am testing a running server.

Revision history for this message
yong sheng gong (gongysh) wrote :

setup.cfg:
[entry_points]
console_scripts =
    keystone-all = keystone.cmd.all:main
    keystone-manage = keystone.cmd.manage:main

when setup, the keystone-all will be generated.

Revision history for this message
Chloe Jensen (cjens) wrote :

David, to clarify - do you suggest we keep the instructions on how to run keystone with Eventlet, etc, or should we only change the doc to reflect the need to call 'python setup.py develop' if the keystone-all file is not automatically created when installed into the venv?

Revision history for this message
David Stanek (dstanek) wrote :

Yes. IMO this is developer documentation (developing.rst) and running keystone-all is my preferred way to do that. Even with the Flask work that I am doing I am providing a standalone dev server to run the application.

Chloe Jensen (cjens)
Changed in keystone:
assignee: Jason O'Brien (jason10258) → Chloe Jensen (cjens)
Changed in keystone:
assignee: Chloe Jensen (cjens) → David Stanek (dstanek)
Changed in keystone:
status: In Progress → Fix Committed
Chloe Jensen (cjens)
Changed in keystone:
assignee: David Stanek (dstanek) → Chloe Jensen (cjens)
Changed in keystone:
milestone: none → liberty-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in keystone:
milestone: liberty-2 → 8.0.0
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on keystone (master)

Change abandoned by David Stanek (<email address hidden>) on branch: master
Review: https://review.openstack.org/197225
Reason: Abandoned due to inactivity

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.