Overhaul of the current OSA install guide

Registered by Alexandra Settle

After the 2016 Austin summit, there was a discussion and a consensus surrounding the current state of the OSA install guide.
As it stands, the OSA install guide has minimal installation information, and a lot of configuration information.
The aim over the next few months is to separate this information and ensure the install guide is solely an install guide.
Further discussion will be had surrounding the where and what to do with the configuration information.

Blueprint information

Status:
Complete
Approver:
Jesse Pretorius
Priority:
Medium
Drafter:
Alexandra Settle
Direction:
Needs approval
Assignee:
Alexandra Settle
Definition:
Approved
Series goal:
Accepted for trunk
Implementation:
Implemented
Milestone target:
milestone icon newton-rc1
Started by
Jesse Pretorius
Completed by
Jesse Pretorius

Related branches

Sprints

Whiteboard

Summit discussion summary: https://etherpad.openstack.org/p/openstack-ansible-newton-role-docs

OSA documentation mission statement: http://docs.openstack.org/developer/openstack-ansible/developer-docs/contribute.html#documentation

Planning: https://docs.google.com/document/d/1WdcA7jIp8w1C52pJu4JmympFe8cOvcxi1I2E19Y6XYE/edit?ts=5743fe3f#

Associated bug: https://bugs.launchpad.net/openstack-ansible/+bug/1587417

Spec: https://review.openstack.org/#/c/323471/ (MERGED)

Gerrit topic: https://review.openstack.org/#q,topic:bp/osa-install-guide-overhaul,n,z

Addressed by: https://review.openstack.org/327467
    [docs] Add draft install guide directory

Addressed by: https://review.openstack.org/328056
    [docs] Move minor upgrade content

Addressed by: https://review.openstack.org/328074
    [docs] Migrate ops and use case content

Addressed by: https://review.openstack.org/328095
    [doc] Migrate deployment configuration options

Addressed by: https://review.openstack.org/331966
    [docs] Revise overview chapter in OSA install guide

Addressed by: https://review.openstack.org/338272
    Docs: Implement Manuals Theme and doc8 checks

Addressed by: https://review.openstack.org/339994
    Fix 'D002 Trailing whitespace' doc errors

Addressed by: https://review.openstack.org/341437
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341442
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341447
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341448
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341449
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341450
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341451
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341452
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341453
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341454
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341455
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341457
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341458
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341459
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341460
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341461
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341462
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341463
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341464
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341465
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341466
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341467
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341468
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341469
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341470
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341471
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341472
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341473
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341474
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341475
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341476
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341477
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341478
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341479
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341480
    Implement doc8 checks for docs

Addressed by: https://review.openstack.org/341481
    Remove doc8 check ignores

Addressed by: https://review.openstack.org/341415
    Fix 'D001 Line too long' documentation lint failures

Addressed by: https://review.openstack.org/342159
    [DOCS] Fix remaining validity errors

Addressed by: https://review.openstack.org/342728
    Resolve 'E501 line too long' linters error

Addressed by: https://review.openstack.org/342910
    [DOCS] Adding storage arch to install guide draft

Gerrit topic: https://review.openstack.org/#q,topic:bp/install-guide-overhaul,n,z

Addressed by: https://review.openstack.org/348737
    [docs] Remove duplicated content

Addressed by: https://review.openstack.org/349325
    [docs] Modify host layout diagrams

Addressed by: https://review.openstack.org/349404
    [docs] Edit the installation chapter

Addressed by: https://review.openstack.org/349799
    [docs] Revise deployment configuration chapter

Addressed by: https://review.openstack.org/350874
    [docs] Revise deployment host and target hosts chapter

Addressed by: https://review.openstack.org/353683
    [DOCS] Fix the appendix order

Addressed by: https://review.openstack.org/353743
    [docs] Added new storage architecture information to the storage doc.

Addressed by: https://review.openstack.org/354158
    [DOCS] Move keystone federation role docs

Addressed by: https://review.openstack.org/354145
    [DOCS] Remove and move keystone federation documentation

Addressed by: https://review.openstack.org/353751
    [DOCS] Refactor of nova role docs

Addressed by: https://review.openstack.org/354197
    [DOCS] Move ironic docs to roles

Addressed by: https://review.openstack.org/354292
    [DOCS] Move ceilometer configs from developer docs

Addressed by: https://review.openstack.org/354207
    [DOCS] Move cinder role docs

Addressed by: https://review.openstack.org/354180
    [DOCS] Move glance role docs

Addressed by: https://review.openstack.org/353691
    [DOCS] Move over the Neutron Plugins docs

Addressed by: https://review.openstack.org/354360
    [DOCS] Move horizon docs to roles

Addressed by: https://review.openstack.org/354107
    Cleanup/standardize usage of tags

Addressed by: https://review.openstack.org/354386
    [DOCS] Updating plugin role docs

Addressed by: https://review.openstack.org/354369
    [DOCS] Move playbook example to separate file

Addressed by: https://review.openstack.org/354331
    [DOCS] Move aodh configs from developer docs

Addressed by: https://review.openstack.org/354346
    [DOCS] Use new documenation tree structure

Addressed by: https://review.openstack.org/354334
    [DOCS] Move gnocchi configs from developer docs

Addressed by: https://review.openstack.org/354166
    Relocate Swift configuration docs to os_swift role

Addressed by: https://review.openstack.org/354800
    [DOCS] Delete ceilometer and aodh dev docs

Addressed by: https://review.openstack.org/354361
    [DOCS] Delete horizon docs

Addressed by: https://review.openstack.org/354366
    [DOCS] Update repo server role docs

Addressed by: https://review.openstack.org/354377
    [DOCS] Update repo-build to new structure

Addressed by: https://review.openstack.org/356630
    [DOCS] - Use new documentation tree structure

Addressed by: https://review.openstack.org/356633
    [DOCS] - Use new documentation tree structure

Addressed by: https://review.openstack.org/356655
    [DOCS] - Use new documentation tree structure

Addressed by: https://review.openstack.org/357171
    [DOCS] Moving networking content to neutron role docs

Addressed by: https://review.openstack.org/357178
    [DOCS] Moving networking content to nova role docs

Addressed by: https://review.openstack.org/357851
    [DOCS] Update gate job names

Addressed by: https://review.openstack.org/357860
    [DOCS] Updates to deploy config

Addressed by: https://review.openstack.org/357909
    [DOCS] Clean up of draft install guide

Addressed by: https://review.openstack.org/358611
    [DOCS] Moving ceph config content to ceph client role docs

Addressed by: https://review.openstack.org/358615
    [DOCS] Moving haproxy content to haproxy role docs

Addressed by: https://review.openstack.org/358619
    [DOCS] Remove ceph and HAProxy from dev docs

Addressed by: https://review.openstack.org/357524
    [DOCS] Add interface configuration content

Addressed by: https://review.openstack.org/360548
    [DOCS} Further edits, corrects to draft install

Addressed by: https://review.openstack.org/352247
    [docs] Add storage diagrams

Addressed by: https://review.openstack.org/363594
    [DOCS] Moving the draft install guide to the install-guide folder

Addressed by: https://review.openstack.org/365427
    Move storage diagrams

Addressed by: https://review.openstack.org/365454
    [docs] Minor edits to the overview chapters

Addressed by: https://review.openstack.org/365711
    [WIP] Revise Storage Architecture Overview

Addressed by: https://review.openstack.org/366088
    [DOCS] IA movement of the install guide

Addressed by: https://review.openstack.org/366100
    [DOCS] Renaming sections for install guide

Addressed by: https://review.openstack.org/366271
    [WIP][docs] Revise host layout and example configurations

Addressed by: https://review.openstack.org/366543
    [docs] Replace 'Host Layout' with 'Service Architecture'

Addressed by: https://review.openstack.org/366679
    [docs] Split Network Architecture page

Gerrit topic: https://review.openstack.org/#q,topic:bug/1624242,n,z

Addressed by: https://review.openstack.org/371573
    [DOCS] Update to installation guide

Addressed by: https://review.openstack.org/372898
    [docs] Add watermark for Newton versioned documentation

Addressed by: https://review.openstack.org/372954
    [docs] Add links to advanced configuration

Addressed by: https://review.openstack.org/375167
    [docs] Minor edit to the install guide

Addressed by: https://review.openstack.org/385496
    [WIP] Provide example configurations

Addressed by: https://review.openstack.org/386091
    [docs] Provide example configurations

Addressed by: https://review.openstack.org/387016
    [docs] Clarify the 'Network configuration' section

Addressed by: https://review.openstack.org/387578
    [docs] Clarify the 'Network configuration' section

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.