Explore the env.sample Helm Chart
Let us understand the env.sample Helm Chart that's included in the Agent Helm charts that you download from the repository.
# ********* REQUIRED settings **********
# Databases Configuration
#
# NEO4J_USER - The username for authenticating with the Neo4j database. The default administrative user is typically neo4j
# NEO4J_PASSWORD - The password associated with the Neo4j user. This credential is required to authenticate and access the Neo4j database
NEO4J_USER="neo4j"
NEO4J_PASSWORD=""
# AWS Configuration
#
# AWS_ACCESS_KEY_ID - The AWS access key ID used to authenticate API requests to AWS services. It identifies the IAM user or role making the request
# AWS_SECRET_ACCESS_KEY - The secret access key paired with the access key ID. It is used to securely sign requests to AWS APIs
# AWS_REGION - Specifies the AWS region where your resources are located or where API requests should be directed
AWS_ACCESS_KEY_ID=""
AWS_SECRET_ACCESS_KEY=""
AWS_REGION=""
# OpenAI
#
# OPENAI_API_KEY - The API key used to authenticate requests to the OpenAI API. This key grants access to
# OpenAI’s services such as language models, embeddings, and other AI capabilities
OPENAI_API_KEY=""
# Prometheus Configuration
#
# PROMETHEUS_URL - The base URL or endpoint of your Prometheus server. This URL configured for your application
# or monitoring tools to query metrics from Prometheus.
# PROMETHEUS_USER - The username for authenticating with Prometheus/Thanos when basic auth is enabled
# PROMETHEUS_PASSWORD - The password for authenticating with Prometheus/Thanos when basic auth is enabled
PROMETHEUS_URL=""
PROMETHEUS_USER=""
PROMETHEUS_PASSWORD=""
# MongoDB Configuration
#
# MONGO_ROOT_USERNAME - The username for the MongoDB root user. This user has administrative privileges and is used to manage the MongoDB instance
# MONGO_ROOT_PASSWORD - The password associated with the MongoDB root user. This credential is required for authenticating as the root user
MONGO_ROOT_USERNAME=""
MONGO_ROOT_PASSWORD=""
# Jira Configuration
#
# JIRA_EMAIL - The email address associated with your Jira account. This is used as the username for authenticating API requests
# JIRA_API_TOKEN - The API token generated from your Jira account. This token is used instead of a password to authenticate API requests securely
# JIRA_BASE_URL - The base URL of your Jira instance
# JIRA_PROJECT_KEY - The key of the Jira project you want to interact with (e.g., PROJ).
# This is used to scope API operations like issue creation or querying to a specific project
# JIRA_PAT - Personal Access Token (PAT) for Jira, an alternative authentication method to API tokens.
# It grants scoped access to Jira APIs and can be used in place of JIRA_API_TOKEN depending on your Jira setup
JIRA_EMAIL=""
JIRA_API_TOKEN=""
JIRA_BASE_URL=https://avesha.atlassian.net
JIRA_PROJECT_KEY=""
JIRA_PAT=""
# Slack Configuration
#
# SLACK_WEBHOOK_URL - used to specify the Incoming Webhook URL provided by Slack,
# which allows your application or workflow to send messages directly into a Slack channel
# SLACK_BOT_TOKEN - The bot user OAuth token for Slack. This token is used for bot authentication and
# allows the bot to perform actions like sending messages, reading channels, and responding to events
SLACK_WEBHOOK_URL=""
SLACK_BOT_TOKEN=""
# Logging Configuration
#
# LOG_LEVEL - The logging level for the application (DEBUG, INFO, WARN, ERROR)
# LOGURU_LEVEL - The logging level for Loguru logger (DEBUG, INFO, WARN, ERROR)
LOG_LEVEL="INFO"
LOGURU_LEVEL="INFO"
# Cert-Manager Configuration
#
# CERT_MANAGER_EMAIL - The email address used for Let's Encrypt notifications and account management.
# This email will receive important notifications about your SSL certificates
# DOMAIN_NAME - The primary domain name for your cluster. This is used as the base domain for
# SSL certificate generation and DNS zone configuration
CERT_MANAGER_EMAIL="admin@avesha.com"
DOMAIN_NAME="avesha.local"
# Service Graph data source configuration
#
# SG_APM_PROVIDER - The Application Performance Monitoring (APM) provider to use for service graph data collection.
# Currently supports "datadog" as the primary provider. This determines which APM system
# the service graph engine will connect to for topology and dependency data.
# DD_API_KEY - The Datadog API key used to authenticate API requests to Datadog services. This key grants access
# to query service topology, dependencies, and other APM data from your Datadog account.
# DD_APP_KEY - The Datadog application key (also called APP key) used for application-level authentication.
# This key is required alongside the API key for accessing Datadog's APM and service graph APIs.
# DD_SITE - The Datadog site/region URL where your account is hosted. Common values include:
# "us5.datadoghq.com" (US), "eu1.datadoghq.com" (EU), "datadoghq.com" (US1), etc.
# This determines which Datadog instance your service graph engine will connect to.
# DD_ENVIRONMENTS - A comma-separated list of environment names to filter service graph data.
# This allows you to scope the service graph to specific environments (e.g., "staging,production")
# or use a single environment like "staging" for focused analysis.
SG_APM_PROVIDER="datadog"
DD_API_KEY="your Datadog api key"
DD_APP_KEY="your Datadog app key"
DD_SITE="your Datadog url"
DD_ENVIRONMENTS="staging"