Rework the Kolla Documentation
The kolla docs are unclear and incomplete. We need to work with all the new members in the community to help build better docs.
https:/
Blueprint information
- Status:
- Complete
- Approver:
- Ryan Hallisey
- Priority:
- Essential
- Drafter:
- Ryan Hallisey
- Direction:
- Approved
- Assignee:
- Ryan Hallisey
- Definition:
- Approved
- Series goal:
- Accepted for ocata
- Implementation:
-
Implemented
- Milestone target:
-
pike-3
- Started by
- Ryan Hallisey
- Completed by
- Jeffrey Zhang
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Doc rework for quickstart, multinode, and image-building
Addressed by: https:/
Update advanced configuration
Addressed by: https:/
Update Cinder guide
Addressed by: https:/
Update quickstart guide for formatting
Gerrit topic: https:/
Addressed by: https:/
Change the SELinux doc to a security doc
Addressed by: https:/
Document upgrading for operators
Addressed by: https:/
Simplify image building information in quickstart
Addressed by: https:/
Document using a custom config directory
Addressed by: https:/
Make configurable the location where config files are merged
Addressed by: https:/
Specify registry volume location
Addressed by: https:/
Cleanup Advanved Configuration doc
Addressed by: https:/
Update Documentation
Addressed by: https:/
Update the image-building documentation
Addressed by: https:/
Added test document
Addressed by: https:/
The quickstart guide still says to use Anisble 1.9.4 which no longer works with Kolla.
Gerrit topic: https:/
Midcycle discussion:
https:/
Addressed by: https:/
Add docs for host setup
Addressed by: https:/
Shrink the quickstart massively and break it into 2
Addressed by: https:/
Build a more organized doc structure
Addressed by: https:/
Add guide to auto mount /run as shared
Addressed by: https:/
Update documentation to reflect repo split
Addressed by: https:/
Remove `$` character for document consistency.
Addressed by: https:/
Update running-tests.rst file
Work Items
Work items:
(unassigned): Philosophy Document: TODO
(unassigned): Architecture overview: TODO
(sdake): setup host: centos: TODO
(inc0): setup host: ubuntu: TODO
(unassigned): Always setup registry: TODO
(unassigned): Kolla quickstart ( AIO ): TODO
(unassigned): I am operator ( on metal ): TODO
(unassigned): I am kolla developer: TODO
(unassigned): Kolla as devstack+1 (separate discussion): TODO
(unassigned): Kolla on vagrant: TODO
(unassigned): Kolla on OpenStack(fix the heat support?): TODO
(unassigned): Advanced Configuration: TODO
(unassigned): Document inventory file: TODO
(unassigned): Buliding custom container images: TODO
(unassigned): Configuration in globals.yml: TODO
(unassigned): deploying behind proxies: TODO
(unassigned): deploy in ip constrianed enviroment(no haproxy): TODO
(unassigned): advanced deployment: TODO
(unassigned): Multinode Deployment: TODO
(unassigned): (tangent) migrate from AIO to multinode: TODO
(unassigned): kolla-ansbile deploy with all options: TODO
(unassigned): Post deployment operations: TODO
(unassigned): upgrade with all options: TODO
