From cda441f9bac9e8b3217791aa1931d081d7e5e36e Mon Sep 17 00:00:00 2001
From: brandt keller <brandt.keller@defenseunicorns.com>
Date: Tue, 16 Aug 2022 18:16:25 +0000
Subject: [PATCH] Feat: creating promtail architecture document

---
 .../promtail/Architecture.md                  | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 docs/understanding-bigbang/package-architecture/promtail/Architecture.md

diff --git a/docs/understanding-bigbang/package-architecture/promtail/Architecture.md b/docs/understanding-bigbang/package-architecture/promtail/Architecture.md
new file mode 100644
index 0000000000..84f9fbc25d
--- /dev/null
+++ b/docs/understanding-bigbang/package-architecture/promtail/Architecture.md
@@ -0,0 +1,51 @@
+# Promtail
+
+## Overview
+
+> Promtail is an agent which reads log files and sends streams of log data to the centralised Loki instances along with a set of labels.
+
+## Big Bang Touch Points
+
+```mermaid
+graph TB
+
+  subgraph "Promtail"
+    promtail
+  end      
+
+  subgraph "Loki"
+    promtail --> loki
+  end
+
+```
+
+### Architecture: 
+- [Promtail Client](https://grafana.com/docs/loki/latest/clients/promtail/)
+
+### Storage
+
+Promtail does not persist data, and instead reads log files and streams the data to a log aggregation system.
+
+### Istio Configuration
+
+Istio is disabled in the promtail chart by default and can be enabled by setting the following values in the bigbang chart:
+
+```yaml
+istio:
+  enabled: true
+```
+
+These values get passed into the promtail chart [here](https://repo1.dso.mil/platform-one/big-bang/apps/sandbox/promtail/-/blob/main/chart/values.yaml#L428). 
+
+## High Availability
+
+By default, Promtail runs as a `daemonset` with a pod on each node.
+
+## Single Sign on (SSO)
+
+None. This service doesn't have a web interface.
+
+
+## Licensing
+
+Promtail utilizes an [AGPLv3 License](https://github.com/grafana/loki/blob/main/LICENSE) for it's code and binaries.
\ No newline at end of file
-- 
GitLab