Skeleton for User Guide
Initial empty framework to fill in. Following up on the discussion at the Tokyo Summit, we are putting together a User Guide for Magnum. The initial list of sections is from the brainstorming session, organized into a particular sequence that seems reasonable, but this can be reorganized and extended as the team sees fit. The intention is to allow contributors to work on all sections in parallel. Partially implements: blueprint user-guide Change-Id: I17ba09f833581bd7fcae9c8a328fc89140b704d2
This commit is contained in:
parent
2e7a5f8c15
commit
50764ed1b2
|
@ -0,0 +1,128 @@
|
|||
=================
|
||||
Magnum User Guide
|
||||
=================
|
||||
|
||||
This guide is intended for users who use Magnum to deploy and manage clusters
|
||||
of hosts for a Container Orchestration Engine. It describes the infrastructure
|
||||
that Magnum creates and how to work with them.
|
||||
|
||||
Section 1-3 describe Magnum itself, including an overview, the CLI and Horizon
|
||||
interface. Section 4-8 describe the Container Orchestration Engine's supported
|
||||
along with a guide on how to select one that best meets your needs. Section
|
||||
9-14 describe the low level OpenStack infrastructure that is created and
|
||||
managed by Magnum to support the Container Orchestration Engine's.
|
||||
|
||||
========
|
||||
Contents
|
||||
========
|
||||
|
||||
#. `Overview`_
|
||||
#. `Python Client`_
|
||||
#. `Horizon Interface`_
|
||||
#. `Choosing COE`_
|
||||
#. `Native clients`_
|
||||
#. `Kubernetes`_
|
||||
#. `Swarm`_
|
||||
#. `Mesos`_
|
||||
#. `Transport Layer Security`_
|
||||
#. `Networking`_
|
||||
#. `High Availability`_
|
||||
#. `Scaling`_
|
||||
#. `Storage`_
|
||||
#. `Image Management`_
|
||||
|
||||
===========
|
||||
Terminology
|
||||
===========
|
||||
*To be filled in*
|
||||
|
||||
Baymodel, bay, ...
|
||||
|
||||
========
|
||||
Overview
|
||||
========
|
||||
*To be filled in*
|
||||
|
||||
Magnum rationale, concept, compelling features
|
||||
|
||||
Bay Model
|
||||
---------
|
||||
*To be filled in*
|
||||
|
||||
Bay
|
||||
---
|
||||
*To be filled in*
|
||||
|
||||
=============
|
||||
Python Client
|
||||
=============
|
||||
*To be filled in*
|
||||
|
||||
=================
|
||||
Horizon Interface
|
||||
=================
|
||||
*To be filled in with screenshots*
|
||||
|
||||
============
|
||||
Choosing COE
|
||||
============
|
||||
*To be filled in*
|
||||
|
||||
Buyer's guide with example use case, can use this as model:
|
||||
|
||||
http://www.openstack.org/software/project-navigator
|
||||
|
||||
==============
|
||||
Native clients
|
||||
==============
|
||||
*To be filled in*
|
||||
|
||||
==========
|
||||
Kubernetes
|
||||
==========
|
||||
*To be filled in*
|
||||
|
||||
=====
|
||||
Swarm
|
||||
=====
|
||||
*To be filled in*
|
||||
|
||||
=====
|
||||
Mesos
|
||||
=====
|
||||
*To be filled in*
|
||||
|
||||
========================
|
||||
Transport Layer Security
|
||||
========================
|
||||
*To be filled in*
|
||||
|
||||
Native Client Configuration guide for each COE
|
||||
|
||||
==========
|
||||
Networking
|
||||
==========
|
||||
*To be filled in*
|
||||
|
||||
=================
|
||||
High Availability
|
||||
=================
|
||||
*To be filled in*
|
||||
|
||||
=======
|
||||
Scaling
|
||||
=======
|
||||
*To be filled in*
|
||||
|
||||
Include Autoscaling
|
||||
|
||||
=======
|
||||
Storage
|
||||
=======
|
||||
*To be filled in*
|
||||
|
||||
================
|
||||
Image Management
|
||||
================
|
||||
*To be filled in*
|
||||
|
Loading…
Reference in New Issue