feat: Adding FST architecture diagrams & documentation

docs/Overloaded Terms.md

@@ -0,0 +1,22 @@
+# Overloaded terms
+
+These are terms which are used in different contexts by developers, product teams customers.
+Each context implies a different meaning, hence they are referred here as overloaded.
+
+- Node
+- Network
+- Services
+- Settings | Config
+- Gossip (Sync | chatter)
+- Test
+- VirtualMap | Map
+- Streams (sidecars streams, record stream, post consensus, pre consensus)
+- Events (Pre consensus, ..  )
+- Container
+- Proxy (Envoy, Haproxy, JSON RPC relay )
+- Stats (CSV, Prometheus)
+- Merkle
+- Reconnect (TCP | on the gossip protocol)
+- Recovery (Replay of preconsensus stream | disaster recovery = replay of post consensus event stream)
+- Deployment
+

docs/Terminology.md

@@ -0,0 +1,69 @@
+# Terminology
+
+This page collects a standard vocabulary to avoid any confusion when communicating with stakeholders.
+You can refer to list of [Overloaded Terms](./Overloaded Terms.md).
+
+- Network Deployment
+    - represents everything in the k8s namespace
+        - Node Software Pod
+        - minio deployment
+        - mirror node deployment
+        - mirror node explorer
+        - json rpc relay
+        - envoy proxy
+        - haproxy
+    - A single k8s cluster can have many Network Deployment
+
+- Node Software Pod ( 1 k8s statefulset )
+    - Hedera App Software
+    - Platform Software
+    - Side cars
+        - state backup uploader
+        - stream uploader
+            - record
+            - sidecars
+            - post consensus eventStreams
+            - account balances
+- Mirror node deployment
+    - importer
+        - only handles record streams, account balances and sidecars
+- Proxy deployment
+- Mirror node explorer deployment
+- JSON RPC replay deployment
+- minio deployment
+    - post consesus event streams
+    - accountbalances
+    - sidecars
+    - record
+    - state backups
+- Full Stack Cluster Operators
+    - Minio Operator,
+    - ~ Prometheus / Grafana Operators
+    - Cert Manager
+    - Ingress Operator
+    - Sealed secrets operator ?
+
+Settings and Configuration
+- Platform Settings
+    - setting.txt
+- Platform Configuration
+    - config.txt
+- Node Software Address Books
+    - account  101 .bin
+    - account 102 .bin
+- Node Software Logging Configuration
+    - log4j2.xml
+- Node Software App Configuration
+    - platform sdk test apps
+        - varies
+    - hedera app
+        - bootstrap.properties
+        - node.properties
+
+Keys
+- platform software gossip mutual TLS keys
+    - public key store
+    - private key store
+- hedera app tls keys
+    - certificate
+    - private key

docs/Versioning.md

@@ -0,0 +1,9 @@
+# Versioning
+
+## Overview
+We support [semantic versioning](https://semver.org/) for FST releases.
+Release will be tagged with a version number in the format of  `MAJOR.MINOR.PATCH`
+
+## Versioning Policy
+Major versions of FST are not tied to the major version of Hedara releases.
+Each major release version of FST will be compatible with a range of Hedera releases, as described in the release notes.

docs/architecture/Architecture.md

@@ -0,0 +1,5 @@
+# Architecture
+
+## Architecture diagram
+
+![Architecture Diagram](./architecture.drawio.svg)

docs/architecture/High Level Flow Diagram.md

@@ -0,0 +1,3 @@
+# High Level Flow Diagram
+
+![Flow Diagram](./flow diagram-high level.drawio.svg)