diff --git a/charter/packages/cluster-auditor/Architecture.md b/charter/packages/cluster-auditor/Architecture.md new file mode 100644 index 0000000000000000000000000000000000000000..eebdacf961360f55685b9764a4af22b0c14eaf66 --- /dev/null +++ b/charter/packages/cluster-auditor/Architecture.md @@ -0,0 +1,39 @@ +# Cluster Auditor + +## Overview + +Cluster Auditor(CA) pulls data from the kubernetes API, transforms them and inserts them into Elasticsearch which can then be queried by Kibana. The types of objects are both OPA Gatekeeper CRDs and native kubernetes [objects](https://repo1.dso.mil/platform-one/big-bang/apps/core/cluster-auditor/-/blob/main/chart/templates/configMap.yaml). + +## Big Bang Touchpoints + +```mermaid +graph TB + subgraph "Cluster Auditor" + clusterauditor + end + + subgraph "Elasticsearch" + clusterauditor --> elasticsearch + end +``` + +## High Availability + +CA currently does not support HA. + +## Storage + +It uses the currently deployed Elasticsearch that's deployed as part of the logging stack. + +## Single Sign On (SSO) + +CA does not have SSO Integration. + +## Licensing + +CA parent image is `fluentd` which uses [Apache License 2.0](https://github.com/fluent/fluentd/blob/master/LICENSE). + +## Dependant Packages + +- Elasticsearch Kibana +- OPA Gatekeeper