Merge pull request #269 from intelops/ttl-readme

TTL-readme-configuration added

README.md

@@ -179,7 +179,7 @@ helm upgrade -i kubviz-agent kubviz/agent -n kubviz --set nats.host=<NATS IP Add
 
 **NOTE:** 
 
-The time-based job scheduler is added for each plugin, allowing you to schedule and automate the execution of plugins at specific times or intervals. To activate this scheduler, set 'enabled' to 'true.' Once enabled, each plugin's execution can be configured to run at a precise time or at regular intervals, based on the provided settings. Additionally, if you set the 'schedulingInterval' to '0', it will disable the plugins
+The time-based job scheduler is added for each plugin, allowing you to schedule and automate the execution of plugins at specific times or intervals. To activate this scheduler, set 'enabled' to 'true.' Once enabled, each plugin's execution can be configured to run at a precise time or at regular intervals, based on the provided settings. Additionally, if you set the 'schedulingInterval' to '0', it will disable the plugins.
 
 #### How to Verify if Everything is Up and Running
 
@@ -214,7 +214,17 @@ export POD_NAME=$(kubectl get pods --namespace kubviz -l "app.kubernetes.io/name
 kubectl --namespace kubviz port-forward $POD_NAME 3000
 ```
 
-3. Access "localhost:3000" in your web browser, where you'll be prompted to enter your credentials. Utilize the username "admin" and the password obtained from step 1 to proceed.   
+3. Access "localhost:3000" in your web browser, where you'll be prompted to enter your credentials. Utilize the username "admin" and the password obtained from step 1 to proceed.
+
+#### TTL - Time-To-Live Feature
+
+We've implemented a Time-To-Live (TTL) feature to streamline the management of data within your ClickHouse tables. With TTL, historical data can be automatically relocated to alternative storage or purged to optimize storage space. This feature is particularly valuable for scenarios like time-series data or logs where older data gradually loses its relevance over time.
+
+#### Configuring TTL
+
+The TTL value is customizable, empowering you to define the specific duration after which data is marked as 'expired'.
+
+To guide you through the process of setting up a TTL, [please follow these steps](docs/CONFIGURATION_TTL.md)
 
 ## Use Cases
 

docs/CONFIGURATION_TTL.md

@@ -0,0 +1,17 @@
+# Configuring TTL: Guidelines and Instructions
+
+- **TTL_INTERVAL**: This parameter sets the numeric value for the TTL duration. For instance, if you wish for data to expire after a duration of 2 time units, set this value to 2. The default value is 1.
+
+- **TTL_UNIT**: This parameter specifies the time unit for the TTL duration. It accepts valid values such as SECOND, MINUTE, HOUR, DAY, MONTH, and more. For example, to set a TTL of 2 hours, you would set TTL_INTERVAL to 2 and TTL_UNIT to HOUR. The default unit is MONTH.
+
+# Usage
+
+## Setting Environment Variables
+
+To configure TTL for your application, set the desired environment variables. Here's an example of how to do this:
+
+```bash
+export TTL_INTERVAL=5
+export TTL_UNIT=MINUTE
+```
+