making small changes to documentation

uc-cdis · Oct 15, 2024 · cefbf6e · cefbf6e
1 parent bd696e5
commit cefbf6e
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 6 deletions.
diff --git a/helm/alloy/SETUP.md b/helm/alloy/SETUP.md
@@ -6,7 +6,7 @@ This document provides a guide for deploying Grafana Alloy to your Kubernetes cl
 
 In this deployment, the Alloy ConfigMap plays a crucial role in configuring which logs are collected for Loki and which metrics are gathered for Mimir. It also specifies the endpoints for Loki and Mimir where the data will be sent.
 
-Before deploying Alloy, it is important to first deploy the "observability" Helm chart, as it provides the necessary components and configuration for Alloy to function properly. Please refer to the SETUP.md observability chart documentation for instructions on how to set it up before proceeding with the Alloy deployment.
+Before deploying Alloy, it is important to first deploy the "observability" Helm chart, as it provides the necessary components and configuration for Alloy to function properly. Please refer to the [SETUP.md](https://github.com/uc-cdis/gen3-helm/blob/master/helm/observability/SETUP.md) observability chart documentation for instructions on how to set it up before proceeding with the Alloy deployment.
 
 ## Configuring Alloy
 

diff --git a/helm/faro-collector/SETUP.md b/helm/faro-collector/SETUP.md
@@ -4,7 +4,7 @@
 
 This guide provides a step-by-step approach to configuring an Alloy instance to collect Grafana Faro logs sent over the internet, similar to Real User Monitoring (RUM). The Portal service generates Faro logs, which Alloy collects and forwards to Loki for storage and analysis in Grafana. Additionally, this guide explains how to enable metrics in the Fence service and adjust the Faro URL in the Gen3 Portal configuration to route metrics to your Alloy instance. Future updates will enable more Gen3 services to offer metric collection.
 
-Before deploying Alloy, it is important to first deploy the "observability" Helm chart, as it provides the necessary components and configuration for Alloy to function properly. Please refer to the observability chart documentation for instructions on how to set it up before proceeding with the Alloy deployment.
+Before deploying Alloy, it is important to first deploy the "observability" Helm chart, as it provides the necessary components and configuration for Alloy to function properly. Please refer to the [SETUP.md](https://github.com/uc-cdis/gen3-helm/blob/master/helm/observability/SETUP.md) observability chart documentation for instructions on how to set it up before proceeding with the Alloy deployment.
 
 ### Why Does Faro Require an Internet-Facing Ingress?
 

diff --git a/helm/observability/image.png → helm/observability/Grafana.png b/helm/observability/image.png → helm/observability/Grafana.png
diff --git a/helm/observability/SETUP.md b/helm/observability/SETUP.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-This Helm chart provides an all-in-one solution for deploying Mimir, Loki, and Grafana to your Kubernetes cluster, enabling a complete observability stack for metrics, logs, and visualization.
+The Observability Helm chart provides an all-in-one solution for deploying Mimir, Loki, and Grafana to your Kubernetes cluster, enabling a complete observability stack for metrics, logs, and visualization.
 
 ### Grafana: 
 A leading open-source platform for data visualization and monitoring. Grafana allows you to create rich, interactive dashboards from a variety of data sources, making it easy to analyze metrics and logs from your systems.
@@ -14,11 +14,22 @@ Grafana Mimir is a highly scalable time-series database optimized for storing an
 Grafana Loki is a log aggregation system designed to efficiently collect, store, and query logs from your applications. It works seamlessly with Grafana, providing an integrated way to visualize logs alongside metrics.
 
 By deploying this Helm chart, you'll set up these three components together, allowing you to monitor your systems and applications comprehensively with metrics from Mimir, logs from Loki, and dashboards and alerts in Grafana.
+
+### Alloy:
+Grafana Alloy is a powerful observability tool that collects and ships logs and metrics from your services to Grafana Loki and Mimir for storage and analysis.
+
+***Note: Grafana is deployed in a separate Helm Chart. You will need to follow the instructions outlined in [Alloy Chart](../alloy/SETUP.md) after completing the following guide.
+
+### Faro Collector (Alloy):
+Alloy Faro Collector is a specialized configuration of Alloy that enables it to gather Real User Monitoring (RUM) data from Portal through Grafana Faro. In this role, Alloy acts as an ingestion point for RUM data.
+
+***Note: The Faro Collector is deployed in a separate Helm Chart. You will need to follow the instructions outlined in [faro.md](../faro-collector/SETUP.md) after completing the following guide.
+
 ## General Architecture
 
-The Alloy Helm chart can be deployed across one or more environments or clusters. In this setup, Loki and Mimir are configured with internal ingress resources, enabling Alloy to send metrics and logs securely via VPC peering connections. Both Loki and Mimir write the ingested data to Amazon S3 for scalable and durable storage. This data can be queried and visualized through Grafana, which is hosted behind an internet-facing ingress. Access to Grafana can be restricted using CIDR ranges defined through the ALB ingress annotation: alb.ingress.kubernetes.io/inbound-cidrs: "cidrs". Additionally, the chart supports SAML authentication for Grafana, configured through the grafana.ini field, ensuring secure user access.
+In this setup, Loki and Mimir are configured with internal ingress resources, enabling Alloy to send metrics and logs securely via VPC peering connections. Both Loki and Mimir write the ingested data to Amazon S3 for scalable and durable storage. This data can be queried and visualized through Grafana, which is hosted behind an internet-facing ingress. Access to Grafana can be restricted using CIDR ranges defined through the ALB ingress annotation: alb.ingress.kubernetes.io/inbound-cidrs: "cidrs". Additionally, the chart supports SAML authentication for Grafana, configured through the grafana.ini field, ensuring secure user access.
 
-![Grafana Architecture](image.png)
+![Grafana Architecture](Grafana.png)
 
 ### Fips compliant images
 
@@ -295,4 +306,4 @@ Loki is used for log aggregation, querying, and management. Each Loki component
 5. **Query Frontend**
    - **Pods**: `grafana-loki-query-frontend-*`
    - **Purpose**: Distributes and coordinates queries.
-   - **Function**: Splits large queries into smaller ones for faster execution by the queriers.
+   - **Function**: Splits large queries into smaller ones for faster execution by the queriers.