Irrelevant text on "Logical architecture" page in Cloud Admin Guide - current

[Bernd Bausch]

Related to https://bugs.launchpad.net/openstack-manuals/+bug/1364635

The text on this page seems to be copied directly from a developer guide and is largely irrelevant for admins.

Quote start -------------------------------
OpenStack modules are one of the following types:
Daemon: Runs as a background process. On Linux platforms, a daemon is usually installed as a service.
Script: Installs a virtual environment and runs tests. For example, the run_tests.sh script installs a virtual environment and runs unit tests on a service.
Command-line interface (CLI): Enables users to submit API calls to OpenStack services through easy-to-use commands.
Quote end---------------------------------

What's a "module"? How are "scripts" and virtual environments relevant to a cloud admin? Why are unit tests mentioned in the admin guide?

Perhaps what's needed here is a description of the diagram on the page, something like: "each of the OpenStack services such as Compute, Block Storage, Image is implemented as several processes that communicate with each other via a message queue. Each service has its own RESTful API <hyperlink to what that means> and communicates with other services via their API. Human users or applications can access the services via CLI programs, the Horizon GUI and programming language bindings".

-----------------------------------
Built: 2015-03-11T07:57:02 00:00
git SHA: 4e3c1816fd0b1c826e6705370a07fafbe58e7a56
URL: http://docs.openstack.org/admin-guide-cloud/content/logical-architecture.html
source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/common/section_getstart_logical_arch.xml
xml:id: logical-architecture

[Lana (loquacity)]

I'd love to see this redone. Also: I hate that diagram so much. Is there any chance we could update it while we're doing the content?

[Bernd Bausch (berndbausch)]

I can rewrite this if Rajesh doesn't insist to keep the bug. Also, the courseware I use has better diagrams IMO. In a few days I should know whether I am allowed to use them.

[Bernd Bausch (berndbausch)]

The Ops guide has an equivalent page at http://docs.openstack.org/openstack-ops/content/architecture.html. The text is the same as in the admin guide (and seems equally irrelevant if not wrong to me), but the diagram is much nicer.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/180503
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=57fadeb3aae14be2ef99ba4a2472b2ba4a80cf05
Submitter: Jenkins
Branch: master

commit 57fadeb3aae14be2ef99ba4a2472b2ba4a80cf05
Author: Bernd Bausch <email address hidden>
Date: Wed May 6 11:14:16 2015 +0900

    New "logical architecture" page in cloud admin guide

    The text on this page seems to be copied directly from a
    developer guide and is largely irrelevant for admins.
    Text must be rewritten, and the diagram, which depicts
    the situation at Havana time, must be redrawn.

    Change-Id: I8f0a9538661292619bd8375ae03d20fe3cee2b5e
    Closes-Bug: #1431079

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.