Skip to content

Commit

Permalink
Add documentation on workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
9seconds committed Nov 23, 2016
1 parent 13b6c51 commit 765289e
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/data_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ playbooks like purging cluster or removing OSD hosts.



.. _data-model-server:

Cluster
+++++++

Expand Down Expand Up @@ -96,6 +98,8 @@ ignoring `ohai <https://docs.chef.io/ohai.html>`_ and `facter
discovered by discovery protocol.


.. _data-model-server-discovery:

Server Discovery
----------------

Expand Down Expand Up @@ -136,6 +140,8 @@ Server discovery process is done in 6 steps:
be performed.


.. _data-model-playbook-configuration:

Playbook Configuration
++++++++++++++++++++++

Expand Down Expand Up @@ -200,6 +206,9 @@ of `Server`_ models. After that you can modify it as you want.
machines.



.. _data-model-execution:

Execution
+++++++++

Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Contents
installation/index.rst
deploy/index.rst
data_model
workflows
cli
ceph_node
api/index.rst
Expand Down
41 changes: 41 additions & 0 deletions docs/source/workflows.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Workflows
=========

This chapter describes different workflows for Decapod. These workflows
should help user to understand how to work with Decapod and perform
required actions.



Server discovery
++++++++++++++++

As mentioned in :ref:`data-model-server-discovery`, it has to be done in
several steps.

1. Choose OS image with cloud-init support
2. Generate user-data config with :program:`decapod cloud-config` CLI
3. Deploy OS with such config

After that, if everything is correct, eventually server will be listed
in Decapod. Server discovery takes time because of cloud-init execution
therefore it might be listed in 5 minutes after deployment. If server
appears in Decapod, it means that tool can use it.



Cluster Deployment
++++++++++++++++++

As mentioned in :doc:`data_model` several models are required.

1. First, we need to create empty :ref:`data-model-server` model.
This model is a holder for configuration of cluster, also it defines
Ceph FSID and the name.
2. We need to create :ref:`data-model-playbook-configuration` model for
``deploy_cluster`` playbook. This and playbook will allow user to
deploy cluster. Also, keep in mind that cluster deployment is
idempotent operation and you may execute it several times.
3. Execute that playbook configuration, creating new
:ref:`data-model-execution`. If something went wrong, examine
execution steps or log.

0 comments on commit 765289e

Please sign in to comment.