From 190a2ff92b8bff17349d3551c78b105f06607bfa Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 30 Jul 2020 13:02:53 -0400 Subject: [PATCH] Update tenancy documentation --- docs/models/tenancy/tenant.md | 5 +++-- docs/models/tenancy/tenantgroup.md | 4 ++-- mkdocs.yml | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/models/tenancy/tenant.md b/docs/models/tenancy/tenant.md index f7cf68ab8..60a160b9e 100644 --- a/docs/models/tenancy/tenant.md +++ b/docs/models/tenancy/tenant.md @@ -1,6 +1,6 @@ # Tenants -A tenant represents a discrete entity for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. The following objects can be assigned to tenants: +A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. The following objects can be assigned to tenants: * Sites * Racks @@ -11,6 +11,7 @@ A tenant represents a discrete entity for administrative purposes. Typically, te * IP addresses * VLANs * Circuits +* Clusters * Virtual machines -Tenant assignment is used to signify ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate. +Tenant assignment is used to signify the ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate. diff --git a/docs/models/tenancy/tenantgroup.md b/docs/models/tenancy/tenantgroup.md index a2ed7e324..078a71a72 100644 --- a/docs/models/tenancy/tenantgroup.md +++ b/docs/models/tenancy/tenantgroup.md @@ -1,5 +1,5 @@ # Tenant Groups -Tenants can be organized by custom groups. For instance, you might create one group called "Customers" and one called "Acquisitions." The assignment of tenants to groups is optional. +Tenants can be organized by custom groups. For instance, you might create one group called "Customers" and one called "Departments." The assignment of a tenant to a group is optional. -Tenant groups may be nested to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of individual tenants grouped by product or account team. +Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of individual tenants grouped by product or account team. diff --git a/mkdocs.yml b/mkdocs.yml index 9de863b4c..af72207d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,7 +40,7 @@ nav: - Circuits: 'core-functionality/circuits.md' - Power Tracking: 'core-functionality/power.md' - Secrets: 'core-functionality/secrets.md' - - Tenancy Assignment: 'core-functionality/tenancy.md' + - Tenancy: 'core-functionality/tenancy.md' - Additional Features: - Caching: 'additional-features/caching.md' - Change Logging: 'additional-features/change-logging.md'