Merge "HOT guide structure"

doc/hot-guide/source/advanced_topics.rst

@@ -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

doc/hot-guide/source/basic_resources.rst

@@ -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

doc/hot-guide/source/functions.rst

@@ -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

doc/hot-guide/source/index.rst

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

doc/hot-guide/source/software_deployment.rst

@@ -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