openstack/kayobe
Code Issues Proposed changes
c35f112a14
kayobe/doc/source/getting-started.rst
Mark Goddard f7628d30d7 docs: Move development section under contributor guide 
This makes the docs more consistent with other projects.

Change-Id: I75732859a67851df564dc472fa839f08be3367cc
2020-09-21 09:40:54 +00:00

1.3 KiB
Raw Blame History

Getting Started

We advise new users start by reading the Architecture <architecture> documentation first in order to understand Kayobe's various components.

For users wishing to learn interactively we recommend starting at either the all-in-one overcloud <contributor/automated> deployment or the 'A Universe From Nothing' <a-universe-from-nothing> deployment guide.

Once familiar with Kayobe's constituent parts, move on to the Installation <installation> section to prepare a baremetal environment and then Deployment <deployment> to deploy to it.

  • Architecture <architecture> - The function of Kayobe's host and networking components
  • Installation <installation> - The prerequisites and options for installing Kayobe
  • Usage <usage> - An introduction to the Kayobe CLI
  • Configuration <configuration/index> - How to configure Kayobe's various components
  • Deployment <deployment>- Using Kayobe to deploy OpenStack
  • Upgrading <upgrading> - Upgrading from one OpenStack release to another
  • Administration <administration/index> - Post-deploy administration tasks
  • Resources <resources> - External links to Kayobe resources
  • Contributor <contributor/index> - Contributing to Kayobe and deploying Kayobe development environments