diff --git a/README.md b/README.md index 6c588b6..0ff47b2 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ The NetBox plugin for Cisco ACI allows NetBox to document ACI specific objects l Documentation: https://pheus.github.io/netbox-aci-plugin/ +## Features + +- Tenants + ## Compatibility | NetBox Version | Plugin Version | @@ -41,7 +45,7 @@ PLUGINS_CONFIG = { ``` ## Status -This project has just started. +This project has just started. Database migrations will be added once the main models have been defined. ## Release notes diff --git a/docs/features/tenants.md b/docs/features/tenants.md new file mode 100644 index 0000000..fda28e2 --- /dev/null +++ b/docs/features/tenants.md @@ -0,0 +1,29 @@ +# Tenants + +An ACI fabric manages one or more *tenants* based on the tenant portion of the hierarchical management information tree (MIT). + +```mermaid +flowchart TD + TN([Tenant]) + subgraph graphTN [Tenant] + TN + end +``` + +## Tenant + +A *tenant* in the ACI policy model represents a container for application policies with domain-based access control. Tenants can be modeled after customers, organizations, domains, or used to group policies. + +The *ACITenant* model has the following fields: + +*Required fields*: + +- **Name**: represent the tenant name in the ACI + +*Optional fields*: + +- **Alias**: an alias in the ACI +- **Description**: a description of the ACI tenant +- (NetBox) **Tenant**: an assignment to the NetBox tenant model +- **Comments**: a text field for additional notes +- **Tags**: a list of NetBox tags diff --git a/mkdocs.yml b/mkdocs.yml index a348e19..a9cd488 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ repo_name: pheus/netbox-aci-plugin # strict: true nav: - Home: index.md + - Features: + - Tenants: features/tenants.md - Contributing: contributing.md - Changelog: changelog.md theme: @@ -60,8 +62,8 @@ markdown_extensions: - pymdownx.details - admonition - toc: - baselevel: 2 - permalink: true + baselevel: 1 + permalink: '#' slugify: !!python/object/apply:pymdownx.slugs.slugify {} - meta plugins: