Merge pull request #23 from ucdavis/sam-changes

Added Netbox Procedure
ucdavis · Jun 26, 2024 · 3216d07 · 3216d07
2 parents 60e9aba + e7b64a7
commit 3216d07
Show file tree

Hide file tree

Showing 28 changed files with 55 additions and 0 deletions.
diff --git a/docs/admin/netbox.md b/docs/admin/netbox.md
@@ -1 +1,56 @@
 # Netbox
+
+[HPCCF's Netbox Site](https://netbox.hpc.ucdavis.edu/dcim/sites/) is our source of truth for our
+rack layouts, network addressing, and other infrastructure. NetBox is an infrastructure resource modeling (IRM) application designed to empower network automation. NetBox was developed specifically to address the needs of network and infrastructure engineers.
+
+## Netbox Features
+
+- Comprehensive Data Model
+- Focused Development
+- Extensible and Customizable
+- Flexible Permissions
+- Custom Validation & Protection Rules
+- Device Configuration Rendering
+- Custom Scripts
+- Automated Events
+- Comprehensive Change Logging
+
+## Netbox Administration
+
+This section will give an overview of how HPCCF admins utilize and administer Netbox.
+
+### How to add assets into Netbox
+
+1. Navigate to HPCCF's Netbox instance here: [HPCCF's Netbox Site](https://netbox.hpc.ucdavis.edu/dcim/sites/) ![netbox1](../img/netbox1.jpeg)
+
+2. Select the site to which you will be adding an asset too. In this example I have chosen Campus DC: ![netbox2](../img/netbox2.jpeg)
+
+3. Scroll down to the bottom of this page and select which of the locations you will add your asset too, here I chose the Storage Cabinet: ![netbox3](../img/netbox3.jpeg) ![netbox4](../img/netbox4.jpeg)
+
+4. On this page scroll to the bottom and select Add a Device: ![netbox5](../img/netbox5.jpeg)
+
+5. After you have selected Add a Device you should see a page like this: ![netbox6](../img/netbox6.jpeg)
+
+6. Fill out this page with specifics of the asset, some fields are not required but try to fill out this section as much as possible with the fields available, here is an example of a created asset and how it should look: ![netbox7](../img/netbox7.jpeg)![netbox8](../img/netbox8.jpeg)![netbox9](../img/netbox9.jpeg)![netbox10](../img/netbox10.jpeg)![netbox11](../img/netbox11.jpeg)![netbox12](../img/netbox12.jpeg)![netbox13](../img/netbox13.jpeg)
+
+7. Ensure to click on Save to have the device added.
+
+### How to add components to an Asset
+
+1. On the asset page select the + Add Components dropdown and select the component you wish to add, for this I have chosen a Console Port: ![netbox14](../img/netbox14.jpeg)
+
+2. Here again you will fill out the dropdowns as thoroughly as possible, the example here is of an interface that has already been added: ![netbox15](../img/netbox15.jpeg)![netbox16](../img/netbox16.jpeg)![netbox17](../img/netbox17.jpeg)![netbox18](../img/netbox18.jpeg)
+
+3. Again make sure to click Save to ensure the component has been added.
+
+4. This process can be used to add all of the following componentes to a device:![netbox19](../img/netbox19.jpeg)
+
+### How to connect components
+
+1. After a component has been created such as an interface, power port or any other type of component you will want to connect it to something. For any component the process is similar within Netbox. In this example it will show how to connect an Infiniban port on a device to a port on an Infiniban switch. First navigate to the device you wish to work with and select the appropriate tab, in this case it will be Interfaces and you will see a page like this: ![netbox20](../img/netbox20.jpeg)
+
+2. Here we will connect ib1 to an infiniban switch by clicking the green dropdown off to the right of ib1 and we will be connecting to another interface on the infiniban switch so we will choose interface as shown here: ![netbox21](../img/netbox21.jpeg)
+
+3. Once selected you will come to a screen that looks like this: ![netbox22](../img/netbox22.jpeg)![netbox23](../img/netbox23.jpeg)![netbox24](../img/netbox24.jpeg)
+
+4. Once all filled out with the required information to complete the connection (and any additional information that can be provided) at the bottom make sure to create the connection, your screen should look something like this: ![netbox25](../img/netbox25.jpeg)![netbox26](../img/netbox26.jpeg)![netbox27](../img/netbox27.jpeg)
diff --git a/docs/img/netbox1.jpeg b/docs/img/netbox1.jpeg
diff --git a/docs/img/netbox10.jpeg b/docs/img/netbox10.jpeg
diff --git a/docs/img/netbox11.jpeg b/docs/img/netbox11.jpeg
diff --git a/docs/img/netbox12.jpeg b/docs/img/netbox12.jpeg
diff --git a/docs/img/netbox13.jpeg b/docs/img/netbox13.jpeg
diff --git a/docs/img/netbox14.jpeg b/docs/img/netbox14.jpeg
diff --git a/docs/img/netbox15.jpeg b/docs/img/netbox15.jpeg
diff --git a/docs/img/netbox16.jpeg b/docs/img/netbox16.jpeg
diff --git a/docs/img/netbox17.jpeg b/docs/img/netbox17.jpeg
diff --git a/docs/img/netbox18.jpeg b/docs/img/netbox18.jpeg
diff --git a/docs/img/netbox19.jpeg b/docs/img/netbox19.jpeg
diff --git a/docs/img/netbox2.jpeg b/docs/img/netbox2.jpeg
diff --git a/docs/img/netbox20.jpeg b/docs/img/netbox20.jpeg
diff --git a/docs/img/netbox21.jpeg b/docs/img/netbox21.jpeg
diff --git a/docs/img/netbox22.jpeg b/docs/img/netbox22.jpeg
diff --git a/docs/img/netbox23.jpeg b/docs/img/netbox23.jpeg
diff --git a/docs/img/netbox24.jpeg b/docs/img/netbox24.jpeg
diff --git a/docs/img/netbox25.jpeg b/docs/img/netbox25.jpeg
diff --git a/docs/img/netbox26.jpeg b/docs/img/netbox26.jpeg
diff --git a/docs/img/netbox27.jpeg b/docs/img/netbox27.jpeg
diff --git a/docs/img/netbox3.jpeg b/docs/img/netbox3.jpeg
diff --git a/docs/img/netbox4.jpeg b/docs/img/netbox4.jpeg
diff --git a/docs/img/netbox5.jpeg b/docs/img/netbox5.jpeg
diff --git a/docs/img/netbox6.jpeg b/docs/img/netbox6.jpeg
diff --git a/docs/img/netbox7.jpeg b/docs/img/netbox7.jpeg
diff --git a/docs/img/netbox8.jpeg b/docs/img/netbox8.jpeg
diff --git a/docs/img/netbox9.jpeg b/docs/img/netbox9.jpeg