Folder Structure Patterns

[itdependsnetworks]

Environment

• Nautobot version: latest
• design-builder version: current

Proposed Functionality

I believe anything can be done, since it is just Python, but I am suggesting to create a documented standard of what should be done.

Currently you may end up with a folder structure like this

├── __init__.py
├── backbone.py
├── branch.py
├── datacenter.py
├── design_files
│   ├── __init__.py
│   ├── backbone_context.py
│   ├── backbone_context.yml
│   ├── branch_context.py
│   ├── branch_context.yml
│   ├── device_profiles.yaml
│   └── templates
│       ├── backbone
│       │   ├── 100_backbone_base_elements.yaml.j2
│       │   ├── 200_backbone_cables.yaml.j2
│       │   └── pops_report.md.j2
│       └── branch
│           ├── 100_branch_base_elements.yaml.j2
│           ├── 200_branch.yaml.j2
│           └── 300_branch_access_switch.yaml.j2

It would be cleaner imho to have a folder with all designs, here are two options

.
├── __init__.py
├── backbone
│   ├── 100_base_elements.yaml.j2
│   ├── 200_cables.yaml.j2
│   ├── __init__.py
│   ├── context.py
│   ├── context.yml
│   └── pops_report.md.j2
└── branch
    ├── 100_branch_base_elements.yaml.j2
    ├── 200_branch.yaml.j2
    ├── 300_branch_access_switch.yaml.j2
    ├── __init__.py
    ├── branch_context.py
    └── branch_context.yml

You can still import the Jobs in a central location

# _init__.py output

from .branch import BranchJob
from .backbone import BackboneJob

So one of:

{design}/{file}
{design}/{design}_{file}

Use Case

A folder structure that reenforces the design.

[abates]

Is this just a documentation task, or does some coding need to take place? I think that it should already work, but haven't tried it.

[itdependsnetworks]

I believe it is just a documentation task.

[abates]

Related to #14

[mzbroch]

How about this pattern ?

root@mia:/opt/src/nautobot-data-generation/external_repos# tree nautobot-validated-network-designs/
nautobot-validated-network-designs/
|-- dc
|   |-- contexts
|   |   |-- contexts.py
|   |   `-- contexts.yml
|   |-- designs
|   |   `-- 100_base_elements.yaml.j2
|   `-- jobs.py
|-- enterprise_branch
|   |-- contexts
|   |   |-- contexts.py
|   |   `-- contexts.yml
|   |-- designs
|   |   |-- 100_base_elements.yaml.j2
|   |   |-- 200_branch.yaml.j2
|   |   |-- 300_access_switch.yaml.j2
|   |   `-- device_profiles.yaml
|   |-- helpers
|   |   |-- __init__.py
|   |   `-- ipam.py
|   `-- jobs.py
|-- isp_backbone
|   |-- contexts
|   |   |-- contexts.py
|   |   `-- contexts.yml
|   |-- designs
|   |   |-- 100_base_elements.yaml.j2
|   |   |-- 200_cables.yaml.j2
|   |   `-- report.md.j2
|   `-- jobs.py
`-- ntc_coolkitt
    |-- contexts
    |   |-- contexts.py
    |   `-- contexts.yml
    |-- designs
    |   |-- 100_base_elements.yaml.j2
    |   `-- report.md.j2
    `-- jobs.py

[itdependsnetworks]

I am good with it

[nkallergis]

I also prefer this structure with everything in a self-contained folder. I guess that's why there's multiple jobs.py files?

[alhogan]

Does this require calling load_jobs() in each jobs.py or do we still need to do that from the root?

[abates]

Does this require calling load_jobs() in each jobs.py or do we still need to do that from the root?

load_jobs() only needs to be called once. See the examples in #73

[abates]

Fixed in #73