diff options
| author |   Parker Berberian <pberberian@iol.unh.edu> | 2019-12-19 12:39:01 -0500 |
|---|---|---|
| committer | Parker Berberian <pberberian@iol.unh.edu> | 2020-01-28 16:09:35 -0500 |
| commit | 77377d5e9362bd35a3b300df231e82ee974675e1 (patch) | |
| tree | 5e3799768eb887a0259c8c21ed61123cdde2d608 /src/resource_inventory/idf_templater.py | |
| parent | 899e1a4baa95d0bc6f0eef34de66f0e257174878 (diff) | |
Comments and Documentation
This change adds a ton of comments and documentation across all the code.
Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553
Signed-off-by: Parker Berberian <pberberian@iol.unh.edu>
Diffstat (limited to 'src/resource_inventory/idf_templater.py')
| -rw-r--r-- | src/resource_inventory/idf_templater.py | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/src/resource_inventory/idf_templater.py b/src/resource_inventory/idf_templater.py index bf6eda0..8f0f924 100644 --- a/src/resource_inventory/idf_templater.py +++ b/src/resource_inventory/idf_templater.py @@ -16,9 +16,8 @@ from resource_inventory.models import Vlan class IDFTemplater: - """ - Utility class to create a full IDF yaml file - """ + """Utility class to create a full Installer Descriptor File (IDF) yaml file.""" + net_names = ["admin", "mgmt", "private", "public"] bridge_names = { "admin": "br-admin", @@ -39,9 +38,7 @@ class IDFTemplater: } def makeIDF(self, booking): - """ - fills the installer descriptor file template with info about the resource - """ + """Fill the IDF template with info about the resource.""" template = "dashboard/idf.yaml" info = {} info['version'] = "0.1" |