From ea7a9820fd59131e0d875d39a41a2c74828c4cef Mon Sep 17 00:00:00 2001
From: John Griffith <john.griffith8@gmail.com>
Date: Wed, 2 Mar 2016 04:49:49 +0000
Subject: [PATCH] Add attach/detach doc to index
Doesn't do much good to add a doc if you never add it
to the index and remove spurious headers that cause it
to not publish.
This patch fixes those problems.
Change-Id: I5c1906a30539e7223f5cee8ce14a013005fe004d
---
doc/source/devref/attach_detach_conventions.rst | 3 ++-
doc/source/devref/index.rst | 1 +
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/source/devref/attach_detach_conventions.rst b/doc/source/devref/attach_detach_conventions.rst
index 1f10e07f6..0f4dab862 100644
--- a/doc/source/devref/attach_detach_conventions.rst
+++ b/doc/source/devref/attach_detach_conventions.rst
@@ -1,5 +1,4 @@
..
-
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
@@ -12,6 +11,7 @@
License for the specific language governing permissions and limitations
under the License.
+=============================
Volume Attach/Detach workflow
=============================
@@ -25,6 +25,7 @@ Attach/Detach Operations are mulit-part commands
================================================
There are three things that happen in the workflow for an attach or detach call.
+
1. Update the status of the volume in the DB (ie attaching/detaching)
- For Attach, this is the cinder.volume.api.reserve method
- For Detach, the analagous call is cinder.volume.api.begin_detaching
diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst
index a0fe37d61..0b5948c58 100644
--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -43,6 +43,7 @@ Background Concepts for Cinder
:maxdepth: 3
architecture
+ attach_detach_conventions
threading
i18n
rpc
--
2.45.2