diff options
| author |   spisarski <s.pisarski@cablelabs.com> | 2017-11-17 11:52:01 -0700 |
|---|---|---|
| committer | spisarski <s.pisarski@cablelabs.com> | 2017-11-20 08:54:21 -0700 |
| commit | 0812d4eca28734872a5565afe9288e002721794b (patch) | |
| tree | ccaf3a0e2e8a389ab95025b7a4a19e9f4bd8980d /docs | |
| parent | 3482f6e28e26025043f61efb90892d886f5909cc (diff) | |
Refactoring of StackSettings to extend StackConfig
StackSettings and heat_utils have a runtime cyclical
dependency. This patch reduces this dependency and
deprecates the StackSettings class.
JIRA: SNAPS-225
Change-Id: I8dc7a4d80efce93452908563730babf14c17e615
Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use/LibraryUsage.rst | 7 | ||||
| -rw-r--r-- | docs/how-to-use/UnitTests.rst | 8 |
2 files changed, 11 insertions, 4 deletions
diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst index b7ac644..7c82387 100644 --- a/docs/how-to-use/LibraryUsage.rst +++ b/docs/how-to-use/LibraryUsage.rst @@ -508,7 +508,7 @@ Create Heat Stack - Heat Stack - snaps.openstack.create\_stack.OpenStackHeatStack - - snaps.openstack.create\_stack.StackSettings + - snaps.config.stack.StackConfig - name - the stack's name (required) - template - the heat template in dict() format (required when @@ -520,9 +520,10 @@ Create Heat Stack .. code:: python - from snaps.openstack.create_stack import StackSettings, OpenStackHeatStack + from snaps.config.stack import StackConfig + from snaps.openstack.create_stack import OpenStackHeatStack - stack_settings = StackSettings(name='stack-name', template_path='/tmp/template.yaml') + stack_settings = StackConfig(name='stack-name', template_path='/tmp/template.yaml') stack_creator = OpenStackHeatStack(os_creds, stack_settings) stack_creator.create() diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst index 8ba65fe..f46d9ee 100644 --- a/docs/how-to-use/UnitTests.rst +++ b/docs/how-to-use/UnitTests.rst @@ -234,11 +234,17 @@ InterfaceRouterDomainObjectTests Ensures that all required members are included when constructing a InterfaceRouter domain object +StackConfigUnitTests +-------------------- + +Ensures that all required members are included when constructing a +StackConfig object + StackSettingsUnitTests ---------------------- Ensures that all required members are included when constructing a -StackSettings object +deprecated StackSettings object StackDomainObjectTests ---------------------- |