Add enable logs steps

SimpleDataLabsInc · Nov 26, 2024 · 2d42457 · 2d42457
1 parent f82b013
commit 2d42457
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 9 deletions.
diff --git a/docs/architecture/deployment/private-saas/configure-audit-logs.md b/docs/architecture/deployment/private-saas/configure-audit-logs.md
@@ -32,7 +32,7 @@ Certain [object store level configurations](./configure-object-store.md) are sha
 
 There are certain environment variables that need to be configured in Athena based on the kind of user events audit logs required.
 
-### Navigating to the Audit config UI
+### Navigate to the Audit config UI
 
 To configure object store settings in the Prophecy UI, follow these steps:
 

diff --git a/docs/architecture/deployment/private-saas/configure-backup.md b/docs/architecture/deployment/private-saas/configure-backup.md
@@ -38,7 +38,7 @@ Note this doc is constantly updated with new features/options and hence it is be
 
 There are certain environment variables that need to be configured in Athena based on the kind of backup-restore required.
 
-### Navigating to the Backup config UI
+### Navigate to the Backup config UI
 
 To configure object store settings in the Prophecy UI, follow these steps:
 
@@ -83,7 +83,7 @@ To trigger a backup/restore manually you would require a API key. [Follow the AP
 
 :::
 
-#### Triggering a backup
+#### Trigger a backup
 
 By default when you set the `ENABLE_REGULAR_BACKUPS` to `true`, backups are taken automatically at the configured `BACKUP_FREQUENCY` CRON schedule. However, we you would like to manually trigger a backup, you may use the API below.
 
@@ -250,7 +250,7 @@ Note the following:
 - If backup was taken in Athena’s local Persistent Volume, it needs to be copied to Athena’s Persistent Volume in the destination cluster before the restore operation can be performed.
 - Restore operation always assumes a running destination Prophecy cluster where the data and the configuration of source cluster will be restored.
 
-### Starting a Restore
+### Start a Restore
 
 :::note
 
@@ -344,7 +344,7 @@ Sample response when there is an ongoing backup and when there is no `timestamp`
 4. Disaster Recovery restore can be initiated from the remote region when the primary goes down
 5. Once the restore is done the Disaster Recovery site is available for work to continue.
 
-## Migrating to different cluster
+## Migrate to different cluster
 
 If there is a requirement to migrate to a different Kubernetes cluster, you can leverage the backups for that:
 

diff --git a/docs/architecture/deployment/private-saas/configure-object-store.md b/docs/architecture/deployment/private-saas/configure-object-store.md
@@ -17,7 +17,7 @@ tags:
 
 Prophecy provides reliable support for storing essential data such as backups and audit logs. However, to enable this functionality, a storage location is required. Prophecy seamlessly integrates with the industry's leading cloud (provider) object stores, including AWS S3, Azure Blob Storage, and GCP Cloud Storage, as well as local persistent volumes (which could be backed by a NFS). This section outlines how to configure these storage options effectively.
 
-## Navigating to the OS config UI
+## Navigate to the OS config UI
 
 To configure object store settings in the Prophecy UI, follow these steps:
 

diff --git a/docs/architecture/deployment/private-saas/download-logs.md b/docs/architecture/deployment/private-saas/download-logs.md
@@ -1,5 +1,5 @@
 ---
-title: Download Logs
+title: Download logs
 id: download-logs
 description: Download Prophecy support logs
 sidebar_position: 3
@@ -15,7 +15,7 @@ As an admin user, you can download your environment logs from Prophecy without n
 - The overarching objective is to debug what is going on with your Prophecy services.
 - To achieve this, we've enabled admins to be able to download Prophecy logs and environment information so that they can upload them to Zendesk.
 
-### Download Logs features
+### Download logs features
 
 You can use the Download Logs feature to capture logs using the Services and time selectors.
 
@@ -37,7 +37,70 @@ Sensitive information, such as customer preview data, credentials, tokens, or pa
 
 :::
 
-### Navigating to the Download Logs UI
+## Enable Prophecy Downloads logs
+
+Before you can download logs, you must enable it in your private SAAS deployment.
+
+See the following requirements for enabling the Prophecy logs:
+
+- Prophecy collects the logs of all pods and stores it in the Athena Pod.
+- Each pod uses an additional 500 MB ephemeral storage for temporary storage.
+- Athena requires additional storage of around 100 GB to store one week of logs.
+- A new container image fluentbit (`gcr.io/prophecy-share/fluent-bit:2.2.3`) is required for this feature.
+
+To enable Minio in Athena and provide it a volume, follow these steps:
+
+1. Add env variables to Athena STS:
+
+```
+  - name: MINIO_ENDPOINT
+    value: athena:9000
+  - name: ENABLE_FLUENTBIT_SIDECARS
+    value: "true"
+  - name: RUN_ATHENA_MINIO
+    value: "true"
+```
+
+2. Add volume to Athena STS:
+
+```
+  volumeClaimTemplates:
+  ...
+  - apiVersion: v1
+    kind: PersistentVolumeClaim
+    metadata:
+      creationTimestamp: null
+      name: minio-storage
+    spec:
+      accessModes:
+      - ReadWriteOnce
+      resources:
+        requests:
+          storage: 10Gi
+      volumeMode: Filesystem
+```
+
+3. Add volume mount to Athena:
+
+```
+  volumeMounts:
+  ...
+  - mountPath: /minio/data
+    name: minio-storage
+```
+
+4. Add the Minio port to Athena SVC:
+
+```
+  ports:
+  ...
+  - name: minio
+    port: 9000
+    protocol: TCP
+    targetPort: 9000
+```
+
+## Navigate to the Download logs UI
 
 To download logs in the Prophecy UI, follow these steps: