Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/229.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Documented `design_mode` and how to enable deployment mode
7 changes: 7 additions & 0 deletions docs/user/design_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading