Merge pull request #226 from openobserve/update-docs

ktx-abhishek · web-flow · commit 5e4d48511782 · 2025-10-15T19:18:50.000+05:30
Update enterprise feature availability markings across documentation portal
diff --git a/docs/user-guide/actions/actions-in-openobserve.md b/docs/user-guide/actions/actions-in-openobserve.md
@@ -5,8 +5,11 @@ description: >-
 ---
 This guide explains what Actions are, their types, and use cases.
 
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
+    
 ## What are Actions  
-**Actions** in OpenObserve are user-defined Python scripts that support custom automation workflows. They can be applied to log data directly from the Logs UI or used as alert destinations. 
+Actions in OpenObserve are user-defined Python scripts that support custom automation workflows. They can be applied to log data directly from the Logs UI or used as alert destinations. 
 
 - Previously, OpenObserve supported log transformations only through VRL (Vector Remap Language). Python scripts written for Actions expand the capabilities of log transformations in OpenObserve.  
 - Additionally, earlier, when an alert gets triggered, users used to get notified via email or webhook. But, with Actions as alert destinations, users can take an immediate action by adding an automation workflow using Actions. 
diff --git a/docs/user-guide/actions/create-and-use-real-time-actions.md b/docs/user-guide/actions/create-and-use-real-time-actions.md
@@ -8,6 +8,9 @@ description: >-
 
 This guide provides instruction on how to create Real-time Actions.
 
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
+
 ## Create a Real-time Action
 ??? info "Prerequisite"
     Create a Service Account and Assign a Role 
diff --git a/docs/user-guide/actions/create-and-use-scheduled-actions.md b/docs/user-guide/actions/create-and-use-scheduled-actions.md
@@ -6,6 +6,9 @@ description: >-
 ---
 This guide provides step-by-step instructions for creating and using Scheduled Actions in OpenObserve.
 
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
+
 **Scheduled Actions** in OpenObserve allow you to execute custom Python scripts at a specific time, either **once** or on a **recurring schedule** defined using a cron expression.  
 Scheduled Actions run based on time, making them suitable for:
 
diff --git a/docs/user-guide/federated-search/federated-search-architecture.md b/docs/user-guide/federated-search/federated-search-architecture.md
@@ -4,7 +4,8 @@ description: Technical explanation of OpenObserve deployment modes, normal clust
 ---
 This document explains the technical architecture of OpenObserve deployments, how queries execute in normal clusters, and how [federated search](../) coordinates queries across clusters in a supercluster.
 
-> This feature is available in Enterprise Edition.
+!!! info "Availability"
+    This feature is available in Enterprise Edition. Not available in Open Source and Cloud.
 
 ## Understanding OpenObserve deployments
 Before diving into how federated search works, you need to understand how OpenObserve can be deployed. OpenObserve scales from a single machine to a globally distributed infrastructure.
diff --git a/docs/user-guide/federated-search/how-to-use-federated-search.md b/docs/user-guide/federated-search/how-to-use-federated-search.md
@@ -3,7 +3,9 @@ title: Federated Search in OpenObserve - How-to Guide
 description: Step-by-step instructions for querying your current cluster and performing federated searches across one or more clusters in a supercluster setup.
 ---
 This document explains how to query your current cluster and how to perform [federated searches](../) across one or more different clusters in a supercluster setup.
-> This feature is available in Enterprise Edition.
+
+!!! info "Availability"
+    This feature is available in Enterprise Edition. Not available in Open Source and Cloud.
 
 ## How to query your current cluster in a supercluster
 
@@ -17,7 +19,7 @@ Query your current cluster when you know the data is in your cluster or when you
     - Results will include data from the current cluster only.
 <br>
 **Steps:**
-![current-cluster-query](current-cluster-query.png)
+![current-cluster-query](../../images/current-cluster-query.png)
 
 1. Navigate to the **Logs** page.
 2. Enter your query in the SQL Query Editor.
@@ -30,7 +32,7 @@ Query your current cluster when you know the data is in your cluster or when you
 
 **Result**<br>
 Data from the selected cluster only.
-![current-cluster-query-result](current-cluster-query-result.png)
+![current-cluster-query-result](../../images/current-cluster-query-result.png)
 
 
 ## How to query one or more different clusters in a supercluster
@@ -44,7 +46,7 @@ Use federated search when you need data from multiple clusters.
 
 **Steps**
 <br>
-![federated-search](federated-search.png)
+![federated-search-multi-select](../../images/federated-search-multi-select.png)
 
 1. Navigate to the **Logs** page.
 2. Enter your query in the SQL Query Editor.
@@ -57,7 +59,7 @@ Use federated search when you need data from multiple clusters.
 
 **Result**<br>
 Combined data from all selected clusters.
-![federated-search-result](federated-search-result.png)
+![federated-search-result](../../images/federated-search-result.png)
 ## Region selection reference
 
 Use this quick reference to understand how region selection affects query execution:
diff --git a/docs/user-guide/federated-search/index.md b/docs/user-guide/federated-search/index.md
@@ -4,8 +4,9 @@ description: Learn what federated search is, key concepts, prerequisites, and wh
 ---
 This document provides an overview of federated search in OpenObserve.
 
-> This feature is available in Enterprise Edition.
-
+!!! info "Availability"
+    This feature is available in Enterprise Edition. Not available in Open Source and Cloud.
+    
 ## What is federated search?
 
 Federated search enables querying across multiple OpenObserve clusters that are connected as a supercluster, all from one interface.
diff --git a/docs/user-guide/identity-and-access-management/role-based-access-control.md b/docs/user-guide/identity-and-access-management/role-based-access-control.md
@@ -5,15 +5,16 @@ description: >-
 ---
 This guide provides an overview of Role-Based Access Control (RBAC), its features, and how it is implemented in OpenObserve.
 
-## Overview
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
 
-OpenObserve uses RBAC to manage what actions users can perform based on their assigned roles. Instead of giving all users the same level of access, RBAC ensures that each user can only access the features and data relevant to their role.
+    - **Enterprise version**: RBAC requires manual configuration using [OpenFGA](https://openfga.dev/api/service). Learn more about [enabling RBAC in OpenObserve Enterprise](enable-rbac-in-openobserve-enterprise.md).
+    - **Cloud version**: RBAC is preconfigured and does not require setup.
+    - **Open-source version**: RBAC is not supported. All users have unrestricted access to all features.
 
-RBAC is available in **OpenObserve Enterprise** and **Cloud** versions but is not supported in the open-source version:
+## Overview
 
-- **Enterprise version**: RBAC requires manual configuration using [OpenFGA](https://openfga.dev/api/service). Learn more about [enabling RBAC in OpenObserve Enterprise](enable-rbac-in-openobserve-enterprise.md).
-- **Cloud version**: RBAC is preconfigured and does not require setup.
-- **Open-source version**: RBAC is not supported. All users have unrestricted access to all features.
+OpenObserve uses RBAC to manage what actions users can perform based on their assigned roles. Instead of giving all users the same level of access, RBAC ensures that each user can only access the features and data relevant to their role.
 
 ## How OpenObserve Implements RBAC
 
diff --git a/docs/user-guide/identity-and-access-management/sso.md b/docs/user-guide/identity-and-access-management/sso.md
@@ -5,11 +5,13 @@ description: >-
 ---
 <!-- search: SSO, Single Sign-On-->
 
-> `Applicable to enterprise version`
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
 
+## SSO in OpenObserve
 OpenObserve, integrates Single Sign-On (SSO) capabilities using Dex, an OpenID Connect Identity (OIDC) and OAuth 2.0 provider. Dex does not have a user database and instead uses external identity providers like LDAP, Google, GitHub, etc. for authentication.
 
-## Setup OpenObserve
+## Configure SSO in OpenObserve
 
 You must set following environment variables to enable SSO in OpenObserve.
 
diff --git a/docs/user-guide/management/aggregation-cache.md b/docs/user-guide/management/aggregation-cache.md
@@ -5,7 +5,6 @@ description: Learn how streaming aggregation works in OpenObserve Enterprise.
 ---
 This page explains what streaming aggregation is and shows how to use it to improve query performance with aggregation cache in OpenObserve.
 
-> This is an enterprise feature. 
 
 === "Overview"
 
diff --git a/docs/user-guide/management/audit-trail.md b/docs/user-guide/management/audit-trail.md
@@ -6,8 +6,9 @@ description: >-
 ---
 # Audit Trail
 
-> **Note:** This feature is applicable to the Enterprise Edition.
-
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
+    
 ## What is Audit Trail
 Audit Trail records user actions across all organizations in OpenObserve. It captures non-ingestion API calls and helps you monitor activity and improve security.
 
@@ -31,7 +32,7 @@ When audit logging is enabled using the `O2_AUDIT_ENABLED` environment variable,
 !!! note "Example"
     The following example shows a captured audit event from the `audit` stream:
   ![audit-trail](../../images/audit-trail.png)
-  
+
 !!! note "Use cases"
     Because audit events are stored in a log stream, you can:
 
diff --git a/docs/user-guide/management/cipher-keys.md b/docs/user-guide/management/cipher-keys.md
@@ -7,7 +7,8 @@ description: >-
 This page explains how to create and manage **Cipher Keys** in OpenObserve and how to use them to decrypt encrypted log data during search queries. 
 The **Cipher Keys** feature is essential for handling sensitive data stored in encrypted formats while still enabling effective log search and analysis, without storing decrypted data on disk. 
 
-> **Note:** This feature is applicable to the OpenObserve [Enterprise Edition](../../../openobserve-enterprise-edition-installation-guide/).
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
 
 ## Create Cipher Keys
 
diff --git a/docs/user-guide/management/sensitive-data-redaction.md b/docs/user-guide/management/sensitive-data-redaction.md
@@ -4,7 +4,9 @@ description: Learn how to redact or drop sensitive data using regex patterns dur
 ---
 
 This document explains how to configure and manage regex patterns for redacting or dropping sensitive data in OpenObserve.
-> Note: This feature is applicable to the OpenObserve [Enterprise Edition](../../../openobserve-enterprise-edition-installation-guide/).
+
+!!! info "Availability"
+    This feature is available in Enterprise Edition and Cloud. Not available in Open Source.
 
 ## Overview 
 The **Sensitive Data Redaction** feature helps prevent accidental exposure of sensitive data by applying regex-based detection to values ingested into streams and to values already stored in streams. Based on this detection, sensitive values can be either **redacted** or **dropped**. This ensures data is protected before it is stored and hidden when displayed in query results. You can configure these actions to run at ingestion time or at query time.
