diff --git a/changes/229.documentation b/changes/229.documentation new file mode 100644 index 00000000..2cfc1c48 --- /dev/null +++ b/changes/229.documentation @@ -0,0 +1 @@ +Documented `design_mode` and how to enable deployment mode \ No newline at end of file diff --git a/docs/user/design_development.md b/docs/user/design_development.md index e820cd6c..f689cdd7 100644 --- a/docs/user/design_development.md +++ b/docs/user/design_development.md @@ -176,6 +176,13 @@ Design file specifies the Jinja template that should be used to produce the inpu Design files specifies a list of Jinja template that should be used to produce the input for the design builder. The builder will resolve the files' locations relative to the location of the design job class. Exactly one of `design_file` or `design_files` must be present in the design's Metadata. If `design_files` is used for a list of design templates, each one is evaluated in order. The same context and builder are used for all files. Since a single builder instance is used, references can be created in one design file and then accessed in a later design file. +### `design_mode` + +Design mode specifies the design lifecycle methodology to be used when a design is executed. The choices are: + +- **Classic**: Adhoc design execution. Objects created are **NOT** associated to a particular deployment. +- **Deployment**: Objects are associated with an instance of a design deployment and lifecycle of the objects created is controlled by the deployment instance. + ### `context_class` The value of the `context_class` metadata attribute should be any Python class that inherits from the `nautobot_design_builder.Context` base class. Design builder will create an instance of this class and use it for the Jinja rendering environment in the first stage of implementation.