From 5ac9e6b1893de05cf470fc18bf0c4d0acb830905 Mon Sep 17 00:00:00 2001
From: Alexis Lee <alexisl@hp.com>
Date: Thu, 29 May 2014 12:46:11 +0100
Subject: [PATCH] Add an overview diagram to the userguide

The diagram covers the tools used to configure the base image for use as
a TripleO instance, both pre and post build time. It mentions
diskimage-builder, tripleo-image-elements, os-collect-config,
os-refresh-config, os-apply-config and Heat.

Change-Id: I68b8f90efd0f92a8a35baa53733bbc2a7145cefc
---
 doc/source/overview.svg  | 1 +
 doc/source/userguide.rst | 5 +++++
 2 files changed, 6 insertions(+)
 create mode 100644 doc/source/overview.svg

diff --git a/doc/source/overview.svg b/doc/source/overview.svg
new file mode 100644
index 00000000..140ca2dc
--- /dev/null
+++ b/doc/source/overview.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="803px" height="628px" version="1.1"><defs/><g transform="translate(0.5,0.5)"><rect x="36" y="352" width="475" height="274" rx="41" ry="41" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="38" y="354" width="471" height="270" rx="41" ry="41" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="1" y="1" width="415" height="275" rx="41" ry="41" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="3" y="3" width="411" height="271" rx="41" ry="41" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="26" y="16" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(28,39)"><switch><foreignObject pointer-events="all" width="116" height="15" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">Base image</div></foreignObject><text x="58" y="14" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="186" y="372" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(188,387)"><switch><foreignObject pointer-events="all" width="116" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">os-collect-config<br />(o-c-c)</div></foreignObject><text x="58" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 556 76 L 636 76 L 636 136 L 526 136 L 526 106 L 556 76 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(528,91)"><switch><foreignObject pointer-events="all" width="106" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 106px; white-space: normal; text-align: center;">TE_DATAFILE<br />(testenv.json)</div></foreignObject><text x="53" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 711 296 L 791 296 L 791 356 L 681 356 L 681 326 L 711 296 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(683,311)"><switch><foreignObject pointer-events="all" width="106" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 106px; white-space: normal; text-align: center;">source<br />templates</div></foreignObject><text x="53" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 711 196 L 791 196 L 791 256 L 681 256 L 681 226 L 711 196 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(683,211)"><switch><foreignObject pointer-events="all" width="106" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 106px; white-space: normal; text-align: center;">merged<br />templates</div></foreignObject><text x="53" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="26" y="191" width="130" height="69" fill="none" stroke="none" pointer-events="none"/><rect x="26" y="191" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="36" y="200" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(38,208)"><switch><foreignObject pointer-events="all" width="116" height="45" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">Deployment flavor images<br />(compute, control)</div></foreignObject><text x="58" y="29" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 86 76 L 86 185" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 86 190 L 83 183 L 86 185 L 90 183 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 736 296 L 736 262" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 736 257 L 740 264 L 736 262 L 733 264 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 156 126 L 92 126" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 87 126 L 94 123 L 92 126 L 94 130 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 96 260 L 96 350" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 96 355 L 93 348 L 96 350 L 100 348 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><rect x="76" y="296" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="116" y="320">Boot</text></g><rect x="441" y="276" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="481" y="293">stack-create</text><text x="481" y="307"> or stack-update</text></g><rect x="721" y="256" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="761" y="280">Make</text></g><rect x="156" y="81" width="240" height="90" fill="none" stroke="none" pointer-events="none"/><rect x="276" y="131" width="120" height="40" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(278,136)"><switch><foreignObject pointer-events="all" width="116" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">os-apply-config templates</div></foreignObject><text x="58" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="156" y="81" width="120" height="90" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(158,104)"><switch><foreignObject pointer-events="all" width="116" height="45" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">TripleO-image-elements<br />(t-i-e)</div></foreignObject><text x="58" y="29" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="276" y="81" width="120" height="50" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(278,84)"><switch><foreignObject pointer-events="all" width="116" height="45" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">pre-install.d<br />install.d<br />post-install.d</div></foreignObject><text x="58" y="29" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 681 76 L 771 76 L 771 136 L 651 136 L 651 106 L 681 76 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(653,84)"><switch><foreignObject pointer-events="all" width="116" height="45" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">HEAT_ENV<br />(under/<br />overcloud-env.json)</div></foreignObject><text x="58" y="29" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="231" y="206" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="18px"><text x="271" y="233">Image building</text></g><rect x="434" y="106" width="65" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="467" y="123">os-apply-config</text><text x="467" y="137">utility</text></g><path d="M 526 106 L 402 106" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 397 106 L 404 103 L 402 106 L 404 110 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 306 402 L 431 402 Q 441 402 441 412 L 441 457" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 441 462 L 438 455 L 441 457 L 445 455 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 186 583 L 176 583 Q 166 583 166 573 L 166 553 Q 166 543 156 543 L 122 543" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 117 543 L 124 540 L 122 543 L 124 547 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 186 503 L 176 503 Q 166 503 166 513 L 166 533 Q 166 543 156 543 L 122 543" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 117 543 L 124 540 L 122 543 L 124 547 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><rect x="6" y="106" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="46" y="116">diskimage-</text><text x="46" y="130">builder</text><text x="46" y="144">(d-i-b)</text></g><path d="M 246 432 L 246 477" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 246 482 L 243 475 L 246 477 L 250 475 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><rect x="361" y="362" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="401" y="379">os-refresh-config</text><text x="401" y="393">(o-r-c)</text></g><path d="M 416 463 L 496 463 L 496 523 L 386 523 L 386 493 L 416 463 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(388,478)"><switch><foreignObject pointer-events="all" width="106" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 106px; white-space: normal; text-align: center;">metadata<br />(cfn.json)</div></foreignObject><text x="53" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="186" y="483" width="120" height="120" fill="none" stroke="none" pointer-events="none"/><rect x="186" y="523" width="120" height="40" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(188,528)"><switch><foreignObject pointer-events="all" width="116" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">os-apply-config element (o-a-c)</div></foreignObject><text x="58" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="186" y="563" width="120" height="40" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(188,568)"><switch><foreignObject pointer-events="all" width="116" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">os-refresh-config<br />scripts, L51-99</div></foreignObject><text x="58" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="186" y="483" width="120" height="40" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(188,488)"><switch><foreignObject pointer-events="all" width="116" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">os-refresh-config<br />scripts, L0-49</div></foreignObject><text x="58" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="316" y="453" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="356" y="470">os-apply-config</text><text x="356" y="484">utility</text></g><path d="M 416 543 L 496 543 L 496 603 L 386 603 L 386 573 L 416 543 Z" fill="#ffffff" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(388,558)"><switch><foreignObject pointer-events="all" width="106" height="30" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 106px; white-space: normal; text-align: center;">os-apply-config templates</div></foreignObject><text x="53" y="21" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 386 493 L 356 493 Q 346 493 346 503 L 346 533 Q 346 543 336 543 L 312 543" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 307 543 L 314 540 L 312 543 L 314 547 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 386 573 L 356 573 Q 346 573 346 563 L 346 553 Q 346 543 336 543 L 312 543" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 307 543 L 314 540 L 312 543 L 314 547 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><rect x="71" y="406" width="80" height="40" fill="none" stroke="none" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="18px"><text x="111" y="422">Running</text><text x="111" y="444">instances</text></g><path d="M 56 563 L 56 523 C 56 517 69 513 86 513 C 103 513 116 517 116 523 L 116 563 C 116 569 103 573 86 573 C 69 573 56 569 56 563 Z" fill="#ffffff" stroke="#000000" stroke-width="2" stroke-miterlimit="10" pointer-events="none"/><path d="M 56 523 C 56 529 69 533 86 533 C 103 533 116 529 116 523" fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="86" y="554">FS</text></g><rect x="521" y="196" width="120" height="60" rx="9" ry="9" fill="#ffffff" stroke="#000000" pointer-events="none"/><rect x="523" y="198" width="116" height="56" rx="8" ry="8" fill="#ffffff" stroke="#000000" pointer-events="none"/><g transform="translate(523,215)"><switch><foreignObject pointer-events="all" width="116" height="22" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 18px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.26; vertical-align: top; width: 116px; white-space: normal; text-align: center;">Heat</div></foreignObject><text x="58" y="20" fill="#000000" text-anchor="middle" font-size="18px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><path d="M 711 136 L 711 156 Q 711 166 701 166 L 621 166 Q 611 166 611 176 L 611 190" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 611 195 L 608 188 L 611 190 L 615 188 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 681 226 L 647 226" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 642 226 L 649 223 L 647 226 L 649 230 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 581 256 L 581 304 Q 581 314 571 314 L 256 314 Q 246 314 246 324 L 246 366" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 246 371 L 243 364 L 246 366 L 250 364 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 581 136 L 581 190" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><path d="M 581 195 L 578 188 L 581 190 L 585 188 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/></g></svg>
diff --git a/doc/source/userguide.rst b/doc/source/userguide.rst
index 8fa987cf..48c612cd 100644
--- a/doc/source/userguide.rst
+++ b/doc/source/userguide.rst
@@ -7,6 +7,11 @@ Learning
 Learning how TripleO all works is essential. Working through :doc:`devtest` is
 highly recommended.
 
+Overview
+--------
+
+.. image:: overview.svg
+
 Setup
 -----