Skip to content

Commit

Permalink
docs(itim): cluster user docs
Browse files Browse the repository at this point in the history
ref: #244 #71
  • Loading branch information
jon-nfc committed Aug 23, 2024
1 parent 5d66069 commit 79b2c66
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/projects/centurion_erp/user/itam/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
61 changes: 61 additions & 0 deletions docs/projects/centurion_erp/user/itim/cluster.md
Original file line number Diff line number Diff line change
@@ -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).
12 changes: 12 additions & 0 deletions docs/projects/centurion_erp/user/itim/clustertype.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 79b2c66

Please sign in to comment.