Merge pull request #18 from netboxlabs/april-updates

Add prefix lists to Administration Console navigation
netboxlabs · Apr 29, 2024 · ae9b0bc · ae9b0bc
2 parents b6186b0 + d53f38a
commit ae9b0bc
Show file tree

Hide file tree

Showing 18 changed files with 103 additions and 34 deletions.
diff --git a/docs/Administration Console/configuring_ip_allow_lists.md b/docs/Administration Console/configuring_ip_allow_lists.md
diff --git a/docs/Administration Console/prefix-lists.md b/docs/Administration Console/prefix-lists.md
@@ -0,0 +1,102 @@
+# Prefix Lists
+
+You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to **Prefix Lists**, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from. 
+
+The following features are available in the NetBox Labs [Admin Console](https://console.netboxlabs.com) when working with prefix lists: 
+
+- Create, Edit and Delete prefix lists
+- Synchronize prefix lists from a NetBox instance using tags
+
+There is also large list support (~15K prefixes) and separate prefixes can be applied to the NetBox Cloud UI, API and GraphQL interfaces. 
+
+**Note** - When you have built your prefix lists in the Admin Console, raise a support ticket by emailing the [NetBox Labs Support Team](mailto:[email protected]) and we will apply them to your NetBox Cloud instances. 
+
+Watch this quick video or follow the steps outlined below to start managing your prefix lists:
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/nPwL7ve513g?si=gbsuGCvK3s8VXPP8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+## Create a Prefix List (not synchronized with a NetBox)
+
+1. From within the Admin Console, navigate to **Settings** in the left-hand menu
+
+    ![settings](../images/prefix-lists/settings.png)
+
+2. Scroll down and click to expand the **Prefix List** section, and then click on **Create Prefix List** on the right hand side to start the wizard: 
+
+    ![create prefix list](../images/prefix-lists/create-prefix-list.png)
+
+3. Give the prefix list a name and then click **CREATE PREFIX LIST**:
+
+    ![name prefix list](../images/prefix-lists/create-prefix-list-non-sync-1.png)
+
+4. Enter the first prefix and give it a description. If you wish to add additional prefixes then you can also do that here by clicking **+ ADD ADDITIONAL PREFIX**, then when you are happy click **CREATE PREFIXES**.
+
+    *Note* - if you wish to add the IP address that you are currently using then click **Use Current IP Address** and this will add it to the prefix list: 
+
+    ![enter prefixes](../images/prefix-lists/create-prefix-list-non-sync-2.png)
+
+ 5. You can then view the prefix list from within **Settings > Prefix List**: 
+
+    ![view prefix list](../images/prefix-lists/create-prefix-list-non-sync-3.png)
+
+## Create a Prefix List (synchronized with a NetBox)
+
+1. From within the Admin Console, navigate to **Settings** in the left-hand menu
+
+    ![settings](../images/prefix-lists/settings.png)
+
+2. Scroll down and click to expand the **Prefix List** section, and then click on **Create Prefix List** on the right hand side to start the wizard: 
+
+    ![create prefix list](../images/prefix-lists/create-prefix-list.png)
+
+3. Give the prefix list a name and then select the **Yes** radio button to sync the prefix list from a NetBox. Then select the NetBox instance you wish to sync from, specify the NetBox Tag that you wish to use, and then click **CREATE PREFIX LIST**:    
+
+    ![create prefix list](../images/prefix-lists/create-prefix-list-sync-1.png)
+
+4. Switch to your NetBox instance, and go to **Customization > Tags** and create the required tag(s) to be applied to any prefixes that are to be synchronized to the Prefix List: 
+
+    ![create tags](../images/prefix-lists/create-prefix-list-sync-2.png)
+
+5. Under **IPAM > Prefixes** add the prefixes, give them a description and tag them with the appropriate tag: 
+
+    ![view prefix list](../images/prefix-lists/create-prefix-list-sync-3.png)
+
+6. You can then view the prefixes in NetBox under **IPAM > Prefixes** (*Tip* - filter on the tag): 
+
+    ![view prefixes](../images/prefix-lists/create-prefix-list-sync-4.png)
+
+7. Switch back to the Admin Console to view the prefix list from within **Settings > Prefix List**. *Note* - it can take a few minutes for the prefix list to be fully synchronized from NetBox. 
+
+    ![view prefix list](../images/prefix-lists/create-prefix-list-sync-5.png)
+
+## Edit a Prefix List
+
+*Note* - this only works for prefix lists that are not synchronized with a NetBox. To edit NetBox synchronized prefix lists you should make the edits within NetBox. 
+
+1. From within the Admin Console, navigate to **Settings** in the left-hand menu, and then scroll down and click to expand the **Prefix List** section. Then click on the name of the prefix list you wish to edit: 
+
+    ![edit prefix list](../images/prefix-lists/edit-prefix-list-1.png)
+
+2. To add more prefixes to the list, click on **Create Prefix** and then follow the wizard again to add more prefixes. 
+
+3. To edit a prefix, click **EDIT** and then make your required changes and then click **EDIT PREFIX** to save your changes: 
+
+    ![edit prefix](../images/prefix-lists/edit-prefix-list-2.png)
+
+4. To delete a prefix, click **DELETE** and then if you are sure you wish to delete the prefix, click **DELETE PREFIX** when prompted: 
+
+    ![delete prefix](../images/prefix-lists/edit-prefix-list-3.png)
+
+## Delete a Prefix List 
+
+*Note* - in order for a prefix list to be deleted it must first be detached from any NetBox instances that it is securing. You will need to contact support and request this before you can delete it. 
+
+1. From within the Admin Console, navigate to **Settings** in the left-hand menu, and then scroll down and click to expand the **Prefix List** section. Then click on the name of the prefix list you wish to delete, and click **DELETE PREFIX LIST**:
+
+    ![delete prefix list](../images/prefix-lists/delete-prefix-list-1.png)
+
+2. If you are sure you wish to delete the prefix list then click **DELETE PREFIX LIST** when you are prompted to confirm the deletion: 
+
+    ![delete prefix list](../images/prefix-lists/delete-prefix-list-2.png)
+
+If you encounter any issues while working with the IP Allow List raise a support ticket by emailing the [NetBox Labs Support Team](mailto:[email protected])
diff --git a/docs/images/prefix-lists/create-prefix-list-non-sync-1.png b/docs/images/prefix-lists/create-prefix-list-non-sync-1.png
diff --git a/docs/images/prefix-lists/create-prefix-list-non-sync-2.png b/docs/images/prefix-lists/create-prefix-list-non-sync-2.png
diff --git a/docs/images/prefix-lists/create-prefix-list-non-sync-3.png b/docs/images/prefix-lists/create-prefix-list-non-sync-3.png
diff --git a/docs/images/prefix-lists/create-prefix-list-sync-1.png b/docs/images/prefix-lists/create-prefix-list-sync-1.png
diff --git a/docs/images/prefix-lists/create-prefix-list-sync-2.png b/docs/images/prefix-lists/create-prefix-list-sync-2.png
diff --git a/docs/images/prefix-lists/create-prefix-list-sync-3.png b/docs/images/prefix-lists/create-prefix-list-sync-3.png
diff --git a/docs/images/prefix-lists/create-prefix-list-sync-4.png b/docs/images/prefix-lists/create-prefix-list-sync-4.png
diff --git a/docs/images/prefix-lists/create-prefix-list-sync-5.png b/docs/images/prefix-lists/create-prefix-list-sync-5.png
diff --git a/docs/images/prefix-lists/create-prefix-list.png b/docs/images/prefix-lists/create-prefix-list.png
diff --git a/docs/images/prefix-lists/delete-prefix-list-1.png b/docs/images/prefix-lists/delete-prefix-list-1.png
diff --git a/docs/images/prefix-lists/delete-prefix-list-2.png b/docs/images/prefix-lists/delete-prefix-list-2.png
diff --git a/docs/images/prefix-lists/edit-prefix-list-1.png b/docs/images/prefix-lists/edit-prefix-list-1.png
diff --git a/docs/images/prefix-lists/edit-prefix-list-2.png b/docs/images/prefix-lists/edit-prefix-list-2.png
diff --git a/docs/images/prefix-lists/edit-prefix-list-3.png b/docs/images/prefix-lists/edit-prefix-list-3.png
diff --git a/docs/images/prefix-lists/settings.png b/docs/images/prefix-lists/settings.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -37,8 +37,8 @@ plugins:
 nav:
   - Home: index.md
   - Guides:
+      - Prefix Lists: "Administration Console/prefix-lists.md"
       - Working with Database Backups: "Administration Console/working_with_database_backups.md"
-      - Configure IP Allow List: "Administration Console/configuring_ip_allow_lists.md"
       - Upgrade NetBox Cloud: "Administration Console/upgrading-nbc.md"
       - Set up Two-Factor Authentication: "Administration Console/set_up_2fa.md"
       - Migrate to NetBox Cloud: "NetBox Cloud/migrating-to-netbox-cloud.md"