From 79b2c668fac1bd66b46347103a5bbd0b0c5212d0 Mon Sep 17 00:00:00 2001
From: Jon <jonathon.lockwood@networkedweb.com>
Date: Sun, 18 Aug 2024 14:30:19 +0930
Subject: [PATCH] docs(itim): cluster user docs

ref: #244 #71
---
 .../centurion_erp/user/itam/device.md         |  2 +
 .../centurion_erp/user/itim/cluster.md        | 61 +++++++++++++++++++
 .../centurion_erp/user/itim/clustertype.md    | 12 ++++
 mkdocs.yml                                    |  4 ++
 4 files changed, 79 insertions(+)
 create mode 100644 docs/projects/centurion_erp/user/itim/cluster.md
 create mode 100644 docs/projects/centurion_erp/user/itim/clustertype.md

diff --git a/docs/projects/centurion_erp/user/itam/device.md b/docs/projects/centurion_erp/user/itam/device.md
index 74422acd2..aea28aba9 100644
--- a/docs/projects/centurion_erp/user/itam/device.md
+++ b/docs/projects/centurion_erp/user/itam/device.md
@@ -27,6 +27,8 @@ For each device within your inventory, the following fields/tabs are available t
 
 - [Change History](../index.md#history)
 
+- Virtual Status
+
 
 ### Status at a glance
 
diff --git a/docs/projects/centurion_erp/user/itim/cluster.md b/docs/projects/centurion_erp/user/itim/cluster.md
new file mode 100644
index 000000000..860b32fd3
--- /dev/null
+++ b/docs/projects/centurion_erp/user/itim/cluster.md
@@ -0,0 +1,61 @@
+---
+title: Cluster
+description: Cluster as part of IT Infrastructure Management Documentation for Centurion ERP by No Fuss Computing
+date: 2024-08-18
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/centurion_erp
+---
+
+This component as part of ITIM is for the management of a cluster.
+
+
+## Features
+
+- Assign Devices as a cluster node
+
+- Assign a Device to be deployed upon a cluster
+
+- Assign configuration for a cluster
+
+
+## Cluster
+
+Within the services the following fields are available:
+
+- Parent Cluster _Cluster that this cluster is deployed upon_
+
+- [Cluster Type](./clustertype.md) _Type of cluster_
+
+- Name _name of the cluster_
+
+- [Organization](../access/organization.md) _organization this cluster belongs to_
+
+- [Nodes](../itam/device.md) _Cluster Nodes_
+
+- [Devices](../itam/device.md) _Devices deployed upon the cluster_
+
+- [Services](./service.md) _Services deployed upon the cluster_
+
+- Config _Cluster Configuration_
+
+We have designed the cluster management feature to track all that is required to configure, deploy and manage. This allows for a cluster to be deployed to a cluster and to have a cluster span multiple sites and/or locations. i.e. like would be the case having nodes from multiple providers.
+
+
+### Node
+
+A Cluster Node is a physical or virtual device that the cluster is deployed upon/across. The resources of a node are for the clusters consumption.
+
+
+### Devices
+
+A Cluster Device is deployed onto the cluster and consumes it resources. This is generally a virtual machine or containerised application.
+
+
+### Services
+
+A Cluster service is a [service](./service.md) deployed to a cluster. See [#125](https://github.com/nofusscomputing/centurion_erp/issues/125) for it's implementation details.
+
+
+### Configuration
+
+Cluster configuration is configuration that is used by Ansible to setup/deploy the cluster. The configuration is presented by Centurion ERP within a format that is designed for [our collection](../../../ansible/collections/centurion/index.md).
diff --git a/docs/projects/centurion_erp/user/itim/clustertype.md b/docs/projects/centurion_erp/user/itim/clustertype.md
new file mode 100644
index 000000000..e0985802a
--- /dev/null
+++ b/docs/projects/centurion_erp/user/itim/clustertype.md
@@ -0,0 +1,12 @@
+---
+title: Cluster Type
+description: Cluster Type as part of IT Infrastructure Management Documentation for Centurion ERP by No Fuss Computing
+date: 2024-08-18
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/centurion_erp
+---
+
+This component as part of ITIM is for the classification of a [cluster](./cluster.md), namely the type of cluster.
+
+!!! info
+    This feature is ready for further features if desired. i.e. `Cluster Type` configuration. want to see this log a feature request on github.
diff --git a/mkdocs.yml b/mkdocs.yml
index 8a9e82c62..17787f85d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -202,6 +202,10 @@ nav:
 
         - projects/centurion_erp/user/itim/index.md
 
+        - projects/centurion_erp/user/itim/cluster.md
+
+        - projects/centurion_erp/user/itim/clustertype.md
+
         - projects/centurion_erp/user/itim/port.md
 
         - projects/centurion_erp/user/itim/service.md