From 939a7bbe50af223a315b61a0b07866ff409dae9d Mon Sep 17 00:00:00 2001 From: Saria Hajjar Date: Sun, 19 Jan 2020 15:43:31 +0000 Subject: [PATCH 1/2] Fixes #3135: Documented power modelling --- docs/core-functionality/power.md | 58 +++++++++++++++++++++++++++++++ docs/release-notes/version-2.7.md | 1 + mkdocs.yml | 1 + 3 files changed, 60 insertions(+) create mode 100644 docs/core-functionality/power.md diff --git a/docs/core-functionality/power.md b/docs/core-functionality/power.md new file mode 100644 index 000000000..047bb13e6 --- /dev/null +++ b/docs/core-functionality/power.md @@ -0,0 +1,58 @@ +# Power Panel + +A power panel represents distribution board where power circuits – and their circuit breakers – terminate on. If you have multiple power panels in your data center, you should model them as such in NetBox to assist you in determining the redundancy of your power allocation. + +# Power Feed + +A power feed identifies the power outlet/drop that goes to a rack and is terminated to a power panel. Power feeds have a supply type (AC/DC), voltage, amperage, and phase type (single/three). + +Power feeds are optionally assigned to a rack. In addition, a power port – and only one – can connect to a power feed; in the context of a PDU, the power feed is analogous to the power outlet that a PDU's power port/inlet connects to. + +!!! info + The power usage of a rack is calculated when a power feed (or multiple) is assigned to that rack and connected to a power port. + +# Power Outlet + +Power outlets represent the ports on a PDU that supply power to other devices. Power outlets are downstream-facing towards power ports. A power outlet can be associated with a power port on the same device and a feed leg (i.e. in a case of a three-phase supply). This can be used to indicate which power port of a PDU is used to supply power through its power outlets. + +# Power Port + +A power port is the inlet of a device where it draws its power. Power ports are upstream-facing towards power outlets. Alternatively, a power port can connect to a power feed – as mentioned in the power feed section – to indicate the power source of a PDU's inlet. + +!!! info + If the draw of a power port is left empty, it will be dynamically calculated based on the power outlets associated with that power port. This is usually the case on the power ports of devices that supply power, like a PDU. + + +# Example + +Below is a simple diagram demonstrating how power is modelled in NetBox. + +!!! note + The power feeds are connected to the same power panel to illustrative purposes; usually, you would have such feeds diversely connected to panels to avoid the single point of failure. + +``` + +---------------+ + | Power panel 1 | + +---------------+ + | | + | | ++--------------+ +--------------+ +| Power feed 1 | | Power feed 2 | ++--------------+ +--------------+ + | | + | | + | | <-- Power ports + +---------+ +---------+ + | PDU 1 | | PDU 2 | + +---------+ +---------+ + | \ / | <-- Power outlets + | \ / | + | \ / | + | X | + | / \ | + | / \ | + | / \ | <-- Power ports + +--------+ +--------+ + | Server | | Router | + +--------+ +--------+ +``` diff --git a/docs/release-notes/version-2.7.md b/docs/release-notes/version-2.7.md index ed9fdd28d..e1c09cfcc 100644 --- a/docs/release-notes/version-2.7.md +++ b/docs/release-notes/version-2.7.md @@ -2,6 +2,7 @@ ## Enhancements +* [#3135](https://github.com/netbox-community/netbox/issues/3135) - Documented power modelling * [#3842](https://github.com/netbox-community/netbox/issues/3842) - Add 802.11ax interface type * [#3954](https://github.com/netbox-community/netbox/issues/3954) - Add `device_bays` filter for devices and device types diff --git a/mkdocs.yml b/mkdocs.yml index 686c04a1d..95f7bae10 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,6 +24,7 @@ pages: - Virtual Machines: 'core-functionality/virtual-machines.md' - Services: 'core-functionality/services.md' - Circuits: 'core-functionality/circuits.md' + - Power: 'core-functionality/power.md' - Secrets: 'core-functionality/secrets.md' - Tenancy: 'core-functionality/tenancy.md' - Additional Features: From a6fde3168b74b6a64cf879e0466085214a7bd6d0 Mon Sep 17 00:00:00 2001 From: Saria Hajjar Date: Mon, 20 Jan 2020 11:37:51 +0000 Subject: [PATCH 2/2] Minor corrections --- docs/core-functionality/power.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/core-functionality/power.md b/docs/core-functionality/power.md index 047bb13e6..1eda1aa00 100644 --- a/docs/core-functionality/power.md +++ b/docs/core-functionality/power.md @@ -1,6 +1,6 @@ # Power Panel -A power panel represents distribution board where power circuits – and their circuit breakers – terminate on. If you have multiple power panels in your data center, you should model them as such in NetBox to assist you in determining the redundancy of your power allocation. +A power panel represents the distribution board where power circuits – and their circuit breakers – terminate on. If you have multiple power panels in your data center, you should model them as such in NetBox to assist you in determining the redundancy of your power allocation. # Power Feed @@ -13,7 +13,7 @@ Power feeds are optionally assigned to a rack. In addition, a power port – and # Power Outlet -Power outlets represent the ports on a PDU that supply power to other devices. Power outlets are downstream-facing towards power ports. A power outlet can be associated with a power port on the same device and a feed leg (i.e. in a case of a three-phase supply). This can be used to indicate which power port of a PDU is used to supply power through its power outlets. +Power outlets represent the ports on a PDU that supply power to other devices. Power outlets are downstream-facing towards power ports. A power outlet can be associated with a power port on the same device and a feed leg (i.e. in a case of a three-phase supply). This indicates which power port supplies power to a power outlet. # Power Port @@ -28,7 +28,7 @@ A power port is the inlet of a device where it draws its power. Power ports are Below is a simple diagram demonstrating how power is modelled in NetBox. !!! note - The power feeds are connected to the same power panel to illustrative purposes; usually, you would have such feeds diversely connected to panels to avoid the single point of failure. + The power feeds are connected to the same power panel for illustrative purposes; usually, you would have such feeds diversely connected to panels to avoid the single point of failure. ``` +---------------+