From eab6b0bd73402df41f2225646f77e842f168cd9b Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sun, 3 Aug 2014 15:34:16 +0200 Subject: [PATCH] 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 --- doc/hot-guide/source/advanced_topics.rst | 41 +++++++++++ doc/hot-guide/source/basic_resources.rst | 76 ++++++++++++++++++++ doc/hot-guide/source/functions.rst | 37 ++++++++++ doc/hot-guide/source/index.rst | 4 ++ doc/hot-guide/source/software_deployment.rst | 26 +++++++ 5 files changed, 184 insertions(+) create mode 100644 doc/hot-guide/source/advanced_topics.rst create mode 100644 doc/hot-guide/source/basic_resources.rst create mode 100644 doc/hot-guide/source/functions.rst create mode 100644 doc/hot-guide/source/software_deployment.rst diff --git a/doc/hot-guide/source/advanced_topics.rst b/doc/hot-guide/source/advanced_topics.rst new file mode 100644 index 0000000000..2038d42170 --- /dev/null +++ b/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 diff --git a/doc/hot-guide/source/basic_resources.rst b/doc/hot-guide/source/basic_resources.rst new file mode 100644 index 0000000000..9da572294e --- /dev/null +++ b/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 diff --git a/doc/hot-guide/source/functions.rst b/doc/hot-guide/source/functions.rst new file mode 100644 index 0000000000..3a6820c53d --- /dev/null +++ b/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 diff --git a/doc/hot-guide/source/index.rst b/doc/hot-guide/source/index.rst index 50565c81b8..1a076b2b51 100644 --- a/doc/hot-guide/source/index.rst +++ b/doc/hot-guide/source/index.rst @@ -6,3 +6,7 @@ HOT guide hot_guide hot_spec + basic_resources + software_deployment + advanced_topics + functions diff --git a/doc/hot-guide/source/software_deployment.rst b/doc/hot-guide/source/software_deployment.rst new file mode 100644 index 0000000000..3c3599272a --- /dev/null +++ b/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