Heat Developer Guidelines

In the developer guide, you will find documented policies for developing heat. This includes the processes we use for stories (for bugs and features), contributor onboarding, core reviewer memberships, and other procedural items.

Note

This guideline also includes documentation for developers.

• Heat and DevStack
  • Configure DevStack to enable heat
  • Configure DevStack to enable ceilometer and aodh (if using alarms)
  • Configure DevStack to enable OSprofiler
  • Create a stack
• Blueprints and Specs
  • Spec from existing stories
• Heat architecture
  • Detailed description
  • Heat services
    • heat
    • heat-api
    • heat-api-cfn
    • heat-engine
• Heat Resource Plug-in Development Guide
  • Resource Plug-in Life Cycle
    • Heat Resource Base Class
    • Properties and Attributes
    • Life Cycle Handler Methods
    • Resource Dependencies
    • Registering Resource Plug-ins
  • Configuring the Engine
  • Testing
  • Putting It All Together
  • Resource Contributions
• Heat Stack Lifecycle Scheduler Hints
  • Enabling the scheduler hints
  • The hints
  • Purpose
• Guru Meditation Reports
  • Generating a GMR
  • Structure of a GMR
  • Adding support for GMRs to new executable
  • Extending the GMR
• Heat Support Status usage Guide
  • Support Status option and its parameters
  • Life cycle of resource, property, attribute
    • Creating process of object
    • Deprecating process of object
    • Removing process of object
  • Using Support Status during code writing
    • Using Support Status during creation
    • Using Support Status during deprecation and hiding
  • Translating mechanism for hidden properties
• Using Rally on Heat gates
  • How to run Rally for particular patch
  • Examples of using Rally
    • Check performance or how to detect regression
    • Compare output API performance
  • create_stack_and_show_output_old
  • create_stack_and_show_output_new
  • create_stack_and_list_output_old
  • create_stack_and_list_output_new