estel/netbox
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

Update virtualization models documentation

Browse Source
This commit is contained in:
jeremystretch
2022-08-16 15:57:29 -04:00
parent d43c98d546
commit 0ba45caabf
6 changed files with 154 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/models/virtualization/cluster.md
View File

@@ -1,5 +1,28 @@
# Clusters
A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type (technological classification) and operational status, and may optionally be assigned to a cluster group, site, and/or tenant. Each cluster must have a unique name within its assigned group and/or site, if any.
A cluster is a logical grouping of physical resources within which [virtual machines](./virtualmachine.md) run. Physical [devices](../dcim/device.md) may be associated with clusters as hosts. This allows users to track on which host(s) a particular virtual machine may reside.
Physical devices may be associated with clusters as hosts. This allows users to track on which host(s) a particular virtual machine may reside. However, NetBox does not support pinning a specific VM within a cluster to a particular host device.
## Fields
### Name
A human-friendly name for the cluster. Must be unique within the assigned group and site.
### Type
The [cluster type](./clustertype.md) assigned for this cluster.
### Group
The [cluster group](./clustergroup.md) to which this cluster belongs.
### Status
The cluster's operational status.
!!! tip
Additional statuses may be defined by setting `Cluster.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter.
### Site
The [site](../dcim/site.md) with which the cluster is associated.