HOT guide structure

This patch provides a structure for the HOT guide, without content. The
intent is to provide an overview of what needs to be documented.

The organization will probably change once we turn this book into a
chapter in the user guide.

Change-Id: I640c519e2c0d1f1b6ba974f37aa4cb2abcfd59c1
Implements: blueprint heat-templates
This commit is contained in:
Gauvain Pocentek 2014-08-03 15:34:16 +02:00
parent d38917d673
commit eab6b0bd73
5 changed files with 184 additions and 0 deletions

@ -0,0 +1,41 @@
.. _hot_advanced_topics:
###############
Advanced topics
###############
Networking
==========
Load balancer
-------------
TODO
Firewall
--------
TODO
VPN
---
TODO
Auto scaling
============
Alarming
--------
TODO
Up scaling and down scaling
---------------------------
TODO
Nested stacks
=============
AWS::CloudFormation::Stack

@ -0,0 +1,76 @@
.. _hot_basic_resources:
#########
Instances
#########
Manage images
=============
Create an image
---------------
TODO
Manage volumes
==============
Create a volume
---------------
TODO
Manage networks
===============
Create a network and a subnet
-----------------------------
TODO
Create a router
---------------
TODO
Define a gateway and interfaces for a router
--------------------------------------------
TODO
Manage instances
================
Create an instance
------------------
TODO
Connect an instance to a network
--------------------------------
- using the networks attribute only (nova-network)
- using a NeutronPort
TODO
Create and associate a floating IP to an instance
-------------------------------------------------
TODO
Attach a volume to an instance
------------------------------
TODO
..
A few elements that probably belong here:
- OS::Neutron::SecurityGroup
- OS::Nova::Flavor
- OS::Nova::KeyPair
- OS::Swift::Container
- OS::Trove::Instance

@ -0,0 +1,37 @@
.. _hot_functions:
#############
HOT functions
#############
Link between resources
======================
* get_param
* get_resource
* Ref
* Fn::GetAtt / get_attr
String manipulations
====================
* get_file
* list_join
* str_replace
* Fn::Base64
* Fn::Join
* Fn::Split
* Fn::Replace
Lookup structured data
======================
* Fn::FindInMap
* Fn::MemberListToMap
* Fn::Select
Misc
====
* Fn::ResourceFacade / resource_facade
* Fn::GetAZs

@ -6,3 +6,7 @@ HOT guide
hot_guide
hot_spec
basic_resources
software_deployment
advanced_topics
functions

@ -0,0 +1,26 @@
.. _hot_software_deployment:
###################
Software deployment
###################
Instance boot scripts
=====================
* OS::Heat::CloudConfig
* OS::Heat::MultipartMime
* OS::Heat::SoftwareConfig
* OS::Heat::StructuredConfig
Scripts execution
=================
* OS::Nova::Server user_data
* OS::Heat::SoftwareDeployment
* OS::Heat::StructuredDeployment
..
NOTE(gpocentek): maybe in this section:
* OS::Heat::RandomString