Merge pull request #68 from ryanmerolle/1.0.1

1.0.1

Author: ryanmerolle

.devcontainer/Dockerfile-plugin_dev

@@ -1,10 +1,13 @@
-ARG VARIANT=v3.2-2.1.0
+ARG NETBOX_VARIANT=v3.2
 
-FROM netboxcommunity/netbox:${VARIANT}
+FROM netboxcommunity/netbox:${NETBOX_VARIANT}
+
+ARG NETBOX_INITIALIZERS_VARIANT=3.2.3
 
 ARG DEBIAN_FRONTEND=noninteractive
 
 # Install APT packages
+# hadolint ignore=DL3008
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y install --no-install-recommends  curl git make openssh-client python3.10-dev sudo wget zsh \
     && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
@@ -18,22 +21,26 @@ ARG USERNAME=vscode
 ARG USER_UID=1000
 ARG USER_GID=$USER_UID
 
-RUN useradd -md /home/vscode -s /usr/bin/zsh -u $USER_UID $USERNAME \
+RUN useradd -l -md /home/vscode -s /usr/bin/zsh -u $USER_UID $USERNAME \
     && usermod -aG sudo $USERNAME \
     && echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers \
     && mkdir /opt/netbox/netbox/netbox-acls \
     && chown $USERNAME:$USERNAME /opt/netbox /etc/netbox /opt/unit -R
 
 USER $USERNAME
 
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 # Add oh my zsh
 RUN wget --quiet https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | zsh || true
 
 COPY .bashrc /home/vscode/.bashrc
 COPY .zshrc /home/vscode/.zshrc
 
+RUN /opt/netbox/venv/bin/pip install  --no-warn-script-location netbox-initializers==${NETBOX_INITIALIZERS_VARIANT}
+
 WORKDIR /opt/netbox/netbox/netbox-acls
 
+# hadolint ignore=DL3002
 USER root
 
 COPY entrypoint-dev.sh /bin/entrypoint-dev.sh

.devcontainer/configuration/plugins.py

@@ -5,9 +5,11 @@
 # See https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins
 
 PLUGINS = [
+    "netbox_initializers",  # Loads demo data
     "netbox_acls",
 ]
 
-PLUGINS_CONFIG = {
+PLUGINS_CONFIG = { # type: ignore
+    "netbox_initializers": {},
     "netbox_acls": {},
 }

.devcontainer/devcontainer.json

@@ -44,6 +44,10 @@
 				"python.linting.banditPath": "/opt/netbox/venv/bin/bandit",
 				"python.linting.enabled": true,
 				"python.linting.flake8Path": "/opt/netbox/venv/bin/flake8",
+				"python.linting.flake8Args": [
+					"--max-line-length=160",
+					"--ignore=E203"
+				],
 				"python.linting.mypyPath": "//opt/netbox/venv/bin/mypy",
 				"python.linting.pycodestylePath": "/opt/netbox/venv/bin/pycodestyle",
 				"python.linting.pydocstylePath": "/opt/netbox/venv/bin/pydocstyle",
@@ -57,6 +61,7 @@
 				],
 				"python.linting.pylintEnabled": true,
 				"python.linting.pylintPath": "/opt/netbox/venv/bin/pylint",
+				"python.linting.lintOnSave": true,
 				"python.pythonPath": "/opt/netbox/venv/bin/python3",
 				"python.terminal.activateEnvironment": true,
 				"python.venvPath": "/opt/netbox/",
@@ -83,6 +88,7 @@
 				"ms-python.python",
 				"ms-python.vscode-pylance",
 				"mutantdino.resourcemonitor",
+				"paulomenezes.duplicated-code",
 				"searKing.preview-vscode",
 				"sourcery.sourcery"
 			]

.devcontainer/initializers/aggregates.yml

@@ -1,4 +1,3 @@
----
 - prefix: 10.0.0.0/16
   rir: RFC1918
   tenant: tenant1

.devcontainer/initializers/asns.yml

@@ -1,4 +1,3 @@
----
 - asn: 1
   rir: RFC1918
   tenant: tenant1

.devcontainer/initializers/cables.yml

@@ -0,0 +1,71 @@
+# Required parameters for termination X ('a' or 'b'):
+#
+# ```
+#   termination_x_name -> name of interface
+#   termination_x_device -> name of the device interface belongs to
+#   termination_x_class -> required if different than 'Interface' which is the default
+# ```
+#
+# Supported termination classes: Interface, ConsolePort, ConsoleServerPort, FrontPort, RearPort, PowerPort, PowerOutlet
+#
+#
+# If a termination is a circuit then the required parameter is termination_x_circuit.
+# Required parameters for a circuit termination:
+#
+# ```
+# termination_x_circuit:
+#   term_side -> termination side of a circuit. Must be A or B
+#   cid -> circuit ID value
+#   site OR provider_network -> name of Site or ProviderNetwork respectively. If both provided, Site takes precedence
+# ```
+#
+# If a termination is a power feed then the required parameter is termination_x_feed.
+#
+# ```
+#   termination_x_feed:
+#     name -> name of the PowerFeed object
+#     power_panel:
+#       name -> name of the PowerPanel the PowerFeed is attached to
+#       site -> name of the Site in which the PowerPanel is present
+# ```
+#
+# Any other Cable parameters supported by Netbox are supported as the top level keys, e.g. 'type', 'status', etc.
+#
+# - termination_a_name: console
+#   termination_a_device: spine
+#   termination_a_class: ConsolePort
+#   termination_b_name: tty9
+#   termination_b_device: console-server
+#   termination_b_class: ConsoleServerPort
+#   type: cat6
+#
+- termination_a_name: to-server02
+  termination_a_device: server01
+  termination_b_name: to-server01
+  termination_b_device: server02
+  status: planned
+  type: mmf
+
+- termination_a_name: eth0
+  termination_a_device: server02
+  termination_b_circuit:
+    term_side: A
+    cid: Circuit_ID-1
+    site: AMS 1
+  type: cat6
+
+- termination_a_name: psu0
+  termination_a_device: server04
+  termination_a_class: PowerPort
+  termination_b_feed:
+    name: power feed 1
+    power_panel:
+      name: power panel AMS 1
+      site: AMS 1
+
+- termination_a_name: outlet1
+  termination_a_device: server04
+  termination_a_class: PowerOutlet
+  termination_b_name: psu1
+  termination_b_device: server04
+  termination_b_class: PowerPort

.devcontainer/initializers/circuit_types.yml

@@ -1,4 +1,3 @@
----
 - name: VPLS
   slug: vpls
 - name: MPLS

.devcontainer/initializers/circuits.yml

@@ -1,4 +1,3 @@
----
 - cid: Circuit_ID-1
   provider: Provider1
   type: Internet

.devcontainer/initializers/cluster_groups.yml

@@ -1,4 +1,3 @@
----
 - name: Group 1
   slug: group-1
 - name: Group 2

.devcontainer/initializers/cluster_types.yml

@@ -1,3 +1,2 @@
----
 - name: Hyper-V
   slug: hyper-v