Prerequisites
You require the following tools and environment variables to use the Obliq SRE Agent.
Minimum Requirements
-
Virtual Machine Requirements:
- 16 GB RAM
- 8 CPU cores
- 40 GB storage
Recommended Requirements
-
Docker Engine 24.0+. Use the following script to install Docker:
curl -fsSL https://get.docker.com -o install-docker.sh
sudo sh install-docker.sh -
Virtual Machine Requirements:
- 32 GB RAM
- 16 CPU cores
- 100 GB SSD storage
Environment Variables
The following example file provides the environment variables required for the agent installation.
info
Currently, the AI SRE Agent only supports Jira tracking tool.
# ********* 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 is used by your application
# or monitoring tools to query metrics from Prometheus
PROMETHEUS_URL=""
# 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_WEBHOOK_URL=""
# UI Configuration
#
# NEXT_PUBLIC_BASE_URL - The Backend endpoint for UI. Use http://localhost:8000 is the setup is locally
NEXT_PUBLIC_BASE_URL="http://localhost:8000"