Bug 889481

Summary: [Docs] [Tracker] Add architecture diagrams for all sections
Product: Red Hat OpenStack Reporter: Zane Bitter <zbitter>
Component: documentationAssignee: Andrew Dahms <adahms>
Status: CLOSED ERRATA QA Contact: RHOS Documentation Team <rhos-docs>
Severity: high Docs Contact:
Priority: high    
Version: 2.0 (Folsom)CC: adahms, slong, yeylon
Target Milestone: gaKeywords: Documentation, Triaged
Target Release: 7.0 (Kilo)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1071070 1071071 1071073 1071075 1071076 (view as bug list) Environment:
Last Closed: 2015-08-05 13:10:26 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 975641, 993939, 1071070, 1071071, 1071073, 1071075, 1071076, 1224006    
Bug Blocks: 1250289    

Description Zane Bitter 2012-12-21 11:06:56 UTC
The Keystone and Glance sections of the guide conclude with a helpful architecture diagram. It would be great if this were extended through the whole guide, particularly after sections like Nova that introduce complex relationships (e.g. Qpid) between services.

Comment 2 Stephen Gordon 2013-01-04 21:32:31 UTC
(In reply to comment #0)
> The Keystone and Glance sections of the guide conclude with a helpful
> architecture diagram. It would be great if this were extended through the
> whole guide, particularly after sections like Nova that introduce complex
> relationships (e.g. Qpid) between services.

We also need to ensure we work to get all of these architecture diagrams redrawn using the Red Hat "brand" for consistency.

Comment 3 Bruce Reeler 2013-02-21 02:00:14 UTC
Requested existing (2.0) Keystone and Keystone-and-Glance diagrams to be redrawn in RH brand. Depending on timing these may be ready for 2.1 GA.
Other diagrams to be added later, post 2.1 release.

Comment 5 Bruce Reeler 2013-05-08 01:47:25 UTC
The two existing "installation" diagrams, as well as the OS overview diagram in GSG, have been Red Hat "branded".
Due to the two "installation" diagrams each being placed after a section of the manual install, not sure this bug belongs in GSG, may need to move to ICG.
Setting priority & severity to low for now.

Comment 10 Summer Long 2013-06-14 06:16:32 UTC
Tim gave me this bug for the Swift image creation. This is all I'm seeing for diagrams in the Install Guide:
1.2. Architecture - RT#184540
8.1. Block Storage Installation Overview - RT#204931
9.1.6. Recommended Networking Deployment - RT#201209

Still missing architecture diagrams-per service:
--Dashboard Service
--Identity Service
--OpenStack Networking Service
--Compute Service
--Image Service
--Object Storage Service

Is there some obvious piece I'm missing here? Is there a reason why the re-branded images for the Identity and Image services haven't been put in? Why is it just Swift that needs a diagram?  And didn't you already get a nifty Compute image put together? confusedly yours, s

Comment 11 Stephen Gordon 2013-06-18 15:28:24 UTC
(In reply to Summer Long from comment #10)
> Tim gave me this bug for the Swift image creation. This is all I'm seeing
> for diagrams in the Install Guide:
> 1.2. Architecture - RT#184540
> 8.1. Block Storage Installation Overview - RT#204931
> 9.1.6. Recommended Networking Deployment - RT#201209
> 
> Still missing architecture diagrams-per service:
> --Dashboard Service
> --Identity Service
> --OpenStack Networking Service
> --Compute Service
> --Image Service
> --Object Storage Service
> 
> Is there some obvious piece I'm missing here? Is there a reason why the
> re-branded images for the Identity and Image services haven't been put in?

Because nobody did it? ;).

> Why is it just Swift that needs a diagram?  And didn't you already get a
> nifty Compute image put together? 

Scott was working on one for compute, Tim got one done for swift, there is one in the guide for networking.

Comment 12 Summer Long 2013-06-19 02:21:16 UTC
Tim didn't get one done for Swift. We talked last week about it before the QE reworks came back. I just raised https://bugzilla.redhat.com/show_bug.cgi?id=975641 to deal with it (makes sense to track separately, will need separate tech reviewers).

Comment 13 Stephen Gordon 2013-06-20 19:31:57 UTC
As noted some of these are outstanding, pushing to 4.0.

Comment 15 Don Domingo 2014-02-28 04:28:09 UTC
as per today's meeting, we'll be farming out the work for developing diagrams of each component. as in, to each component author. 

So far, the following components seem to have diagrams already:

Object Storage, as per BZ#975641. refer to:
   https://svn.devel.redhat.com/repos/ecs/artwork/images/233213/23313-objectstorage_architecture.png

Image, as per BZ#888067. refer to:
   http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_OpenStack/2/html/Getting_Started_Guide/images/188537-keystone_glance_after_install.png

Block Storage (from old ICG, may need updating). refer to:
   https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/3/html/Installation_and_Configuration_Guide/chap-Installing_OpenStack_Block_Storage.html#Block_Storage_Installation_Overview

Networking also has one, though may need updating or refinement. refer to:
    https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/3/html/Installation_and_Configuration_Guide/chap-Installing_the_OpenStack_Networking_Service.html#Networking_Service_Requirements

so just Compute and Identity need new ones from scratch, the Block Storage and Networking will need to be re-verified.

Comment 16 Andrew Dahms 2015-04-24 00:17:40 UTC
Moving back to 'New' until reassigned.

This work to be targeted for the Kilo release.

Comment 19 Summer Long 2015-06-02 04:18:25 UTC
Have added Sahara as the last diagram for RHOS7 GA; and it is now on POST (waiting for tech review).

Comment 20 Summer Long 2015-06-03 05:11:27 UTC
Sahara has been passed and merged. This ticket can now be used for the merging of Jess' branded versions once we get them back.

Comment 23 Summer Long 2015-06-17 04:53:41 UTC
Assigning back to you Andrew, since the images will need to be switched out once Jess sends them back. Especially waiting for the Sahara diagram.

Comment 24 Andrew Dahms 2015-07-20 00:11:05 UTC
All component bugs have now been completed.

Moving to VERIFIED.

Comment 26 errata-xmlrpc 2015-08-05 13:10:26 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2015:1548