Skip to content

Commit b953ab3

Browse files
Completed Deployment section
1 parent 8e89edf commit b953ab3

File tree

7 files changed

+63
-3
lines changed

7 files changed

+63
-3
lines changed

articles/Deployment/deployment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
uid: deployment_deployment
33
---
44

5-
### High-Level Design Overview
5+
# High-Level Design Overview
66
<!-- REMOVABLE DESCRIPTION
77
We have been using two forms to provide a high-level overview of the solution's deployment. Most commonly, we include a
88
textual description of the system's components and a package diagram that contains a brief summary of each component.
99
-->
10-
#### Textual description
10+
## Textual description
1111

1212
The {{PROJECT_NAME}} project comprises three independent DMS clusters, each configured as detailed below and offering
1313
specific features outlined in [value delivery](xref:overview_overview).
1414

15-
#### Alpha Cluster
15+
## Alpha Cluster
1616
Alpha cluster has multiple agents covering London, Brussels, and Washington DC locations. It provides standard monitoring
1717
and control functionality listed in the [delivery features](xref:overview_overview#delivered-value) section.
1818

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
uid: deployment_high_level_architecture
3+
---
4+
5+
# High Level Architecture
6+
7+
<!-- REMOVABLE DESCRIPTION
8+
A high-level architecture outlines the interconnected components and how they interact to deliver a cohesive solution. It can be organized around elements (hardware or software) providing functionality to form the services utilized by end users.
9+
-->
10+
## Components
11+
As shown in the diagram below, the SOLUTION consists of three different hardware elements, including two DataMiner systems that contain the necessary modules for processing and distributing messages:
12+
13+
![components.png](../../images/components.png)
14+
15+
## Interactions
16+
17+
In the interaction diagram below, a DataMiner node process query commands from an aggregator in response to external actions from an implemented third-party application UI:
18+
![interactions.png](../../images/interactions.png)

articles/Deployment/infrastructure.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
uid: deployment_infrastructure
3+
---
4+
5+
# DataMiner Infrastructure
6+
7+
The infrastructure for {{PROJECT_NAME}} is built around a single Dataminer cluster, comprising X DMAs.
8+
9+
| ID | DMA Name | Location | Host | IP |
10+
|------------|-----------------|-------------------------|-----------------|----------------|
11+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
12+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
13+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
14+
15+
# Storage Infrastructure
16+
17+
<!-- REMOVABLE DESCRIPTION
18+
We can either describe the storage cluster's location and reference other documentation, or we can create a table that illustrates the general information of the nodes.
19+
-->
20+
### Cassandra Nodes
21+
| Server Name | IP Address |
22+
|--------------------|------------------|
23+
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
24+
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
25+
26+
### Opensearch Nodes
27+
28+
| Server Name | IP Address |
29+
|----------------|--------------|
30+
| {{OPENS_NAME}} | {{OPENS_IP}} |
31+
| {{OPENS_NAME}} | {{OPENS_IP}} |

articles/Overview/overview.md

+6
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ There are multiple forms to express the delivered value, following some forms:
2121
* **Comparative Improvements:** A list of the achieved improvements of any defined KPIs
2222
* **Customer phrases or outcomes:** Testimonials, use cases, or scenarios describing the success stories and how potential users can benefit
2323

24+
## Revision History
25+
26+
| Revision | Date | Name | Comments |
27+
|----------|-------------|----------|-----------------|
28+
| 001 | 26 Nov 2024 | John Doe | Initial Version |
29+
| 002 | 10 Dic 2024 | John Doe | Added section 2 |

articles/toc.yml

+5
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,8 @@ items:
88
topicUid: overview_references
99
- name: Deployment
1010
topicUid: deployment_deployment
11+
items:
12+
- name: High Level Architecture
13+
topicUid: deployment_high_level_architecture
14+
- name: Infrastructure
15+
topicUid: deployment_infrastructure

images/components.png

69 KB
Loading

images/interactions.png

50 KB
Loading

0 commit comments

Comments
 (0)