mirror of
https://github.com/awslabs/amazon-bedrock-agentcore-samples.git
synced 2025-09-08 20:50:46 +00:00
e346e83bf1
* Add missing credential_provider_name parameter to config.yaml.example * Fix get_config function to properly parse YAML values with inline comments * Enhanced get_config to prevent copy-paste whitespace errors in AWS identifiers * Improve LLM provider configuration and error handling with bedrock as default * Add OpenAPI templating system and fix hardcoded regions * Add backend template build to Readme * delete old yaml files * Fix Cognito setup with automation script and missing domain creation steps * docs: Add EC2 instance port configuration documentation - Document required inbound ports (443, 8011-8014) - Include SSL/TLS security requirements - Add AWS security group best practices - Provide port usage summary table * docs: Add hyperlinks to prerequisites in README - Link EC2 port configuration documentation - Link IAM role authentication setup - Improve navigation to detailed setup instructions * docs: Add BACKEND_API_KEY to configuration documentation - Document gateway environment variables section - Add BACKEND_API_KEY requirement for credential provider - Include example .env file format for gateway directory - Explain usage in create_gateway.sh script * docs: Add BACKEND_API_KEY to deployment guide environment variables - Include BACKEND_API_KEY in environment variables reference table - Mark as required for gateway setup - Provide quick reference alongside other required variables * docs: Add BedrockAgentCoreFullAccess policy and trust policy documentation - Document AWS managed policy BedrockAgentCoreFullAccess - Add trust policy requirements for bedrock-agentcore.amazonaws.com - Reorganize IAM permissions for better clarity - Remove duplicate trust policy section - Add IAM role requirement to deployment prerequisites * docs: Document role_name field in gateway config example - Explain that role_name is used to create and manage the gateway - Specify BedrockAgentCoreFullAccess policy requirement - Note trust policy requirement for bedrock-agentcore.amazonaws.com - Improve clarity for gateway configuration setup * docs: Add AWS IP address ranges for production security enhancement - Document AWS IP ranges JSON download for restricting access - Reference official AWS documentation for IP address ranges - Provide security alternatives to 0.0.0.0/0 for production - Include examples of restricted security group configurations - Enable egress filtering and region-specific access control * style: Format Python code with black - Reformat 14 Python files for consistent code style - Apply PEP 8 formatting standards - Improve code readability and maintainability * docs: Update SRE agent prerequisites and setup documentation - Convert prerequisites section to markdown table format - Add SSL certificate provider examples (no-ip.com, letsencrypt.org) - Add Identity Provider (IDP) requirement with setup_cognito.sh reference - Clarify that all prerequisites must be completed before setup - Add reference to domain name and cert paths needed for BACKEND_DOMAIN - Remove Managing OpenAPI Specifications section (covered in use-case setup) - Add Deployment Guide link to Development to Production section Addresses issues #171 and #174 * fix: Replace 'AWS Bedrock' with 'Amazon Bedrock' in SRE agent files - Updated error messages in llm_utils.py - Updated comments in both .env.example files - Ensures consistent naming convention across SRE agent codebase --------- Co-authored-by: dheerajoruganty <dheo@amazon.com> Co-authored-by: Amit Arora <aroraai@amazon.com>
133 lines
4.3 KiB
Markdown
133 lines
4.3 KiB
Markdown
# Configuration
|
|
|
|
## Environment Variables
|
|
|
|
The SRE Agent uses environment variables for sensitive configuration values. Create a `.env` file in the `sre_agent/` directory with the following required variables:
|
|
|
|
```bash
|
|
# Required: API key for Claude model access
|
|
# For Anthropic direct access:
|
|
ANTHROPIC_API_KEY=sk-ant-api-key-here
|
|
|
|
# For Amazon Bedrock access:
|
|
AWS_DEFAULT_REGION=us-east-1
|
|
AWS_PROFILE=your-profile-name # Or use AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
|
|
|
|
# Required: AgentCore Gateway authentication
|
|
GATEWAY_ACCESS_TOKEN=your-gateway-token-here # Generated by gateway setup
|
|
|
|
# Optional: Debugging and logging
|
|
LOG_LEVEL=INFO # Options: DEBUG, INFO, WARNING, ERROR
|
|
DEBUG=false # Enable debug mode for verbose output
|
|
```
|
|
|
|
**Note**: The SRE Agent looks for the `.env` file in the `sre_agent/` directory, not the project root. This allows for modular configuration management.
|
|
|
|
## Agent Configuration
|
|
|
|
The agent behavior is configured through `sre_agent/config/agent_config.yaml`. This file defines the mapping between agents and their available tools, as well as LLM parameters:
|
|
|
|
```yaml
|
|
# Agent to tool mapping
|
|
agents:
|
|
kubernetes_agent:
|
|
name: "Kubernetes Infrastructure Agent"
|
|
description: "Specializes in Kubernetes operations and troubleshooting"
|
|
tools:
|
|
- get_pod_status
|
|
- get_deployment_status
|
|
- get_cluster_events
|
|
- get_resource_usage
|
|
- get_node_status
|
|
|
|
logs_agent:
|
|
name: "Application Logs Agent"
|
|
description: "Expert in log analysis and pattern detection"
|
|
tools:
|
|
- search_logs
|
|
- get_error_logs
|
|
- analyze_log_patterns
|
|
- get_recent_logs
|
|
- count_log_events
|
|
|
|
metrics_agent:
|
|
name: "Performance Metrics Agent"
|
|
description: "Analyzes performance metrics and trends"
|
|
tools:
|
|
- get_performance_metrics
|
|
- get_error_rates
|
|
- get_resource_metrics
|
|
- get_availability_metrics
|
|
- analyze_trends
|
|
|
|
runbooks_agent:
|
|
name: "Operational Runbooks Agent"
|
|
description: "Provides operational procedures and guides"
|
|
tools:
|
|
- search_runbooks
|
|
- get_incident_playbook
|
|
- get_troubleshooting_guide
|
|
- get_escalation_procedures
|
|
- get_common_resolutions
|
|
|
|
# Global tools available to all agents
|
|
global_tools:
|
|
- x-amz-bedrock-agentcore-search # AgentCore search tool
|
|
|
|
# Gateway configuration
|
|
gateway:
|
|
uri: "https://your-gateway-url.com" # Updated during setup
|
|
```
|
|
|
|
## Gateway Environment Variables
|
|
|
|
The AgentCore Gateway requires additional environment variables for authentication. Create a `.env` file in the `gateway/` directory with the following:
|
|
|
|
```bash
|
|
# Required: Backend API key for credential provider authentication
|
|
BACKEND_API_KEY=your-backend-api-key-here
|
|
|
|
# Optional: Override config.yaml values with environment variables
|
|
# ACCOUNT_ID=123456789012
|
|
# REGION=us-east-1
|
|
# ROLE_NAME=your-role-name
|
|
# GATEWAY_NAME=MyAgentCoreGateway
|
|
# CREDENTIAL_PROVIDER_NAME=sre-agent-api-key-credential-provider
|
|
```
|
|
|
|
**Note**: The `BACKEND_API_KEY` is used by the `create_gateway.sh` script to authenticate with the credential provider service.
|
|
|
|
## Gateway Configuration
|
|
|
|
The AgentCore Gateway is configured through `gateway/config.yaml`. This configuration is managed by the setup scripts but can be customized:
|
|
|
|
```yaml
|
|
# AgentCore Gateway Configuration Template
|
|
# Copy this file to config.yaml and update with your environment-specific settings
|
|
|
|
# AWS Configuration
|
|
account_id: "YOUR_ACCOUNT_ID"
|
|
region: "us-east-1"
|
|
role_name: "YOUR_ROLE_NAME"
|
|
endpoint_url: "https://bedrock-agentcore-control.us-east-1.amazonaws.com"
|
|
credential_provider_endpoint_url: "https://us-east-1.prod.agent-credential-provider.cognito.aws.dev"
|
|
|
|
# Cognito Configuration
|
|
user_pool_id: "YOUR_USER_POOL_ID"
|
|
client_id: "YOUR_CLIENT_ID"
|
|
|
|
# S3 Configuration
|
|
s3_bucket: "your-agentcore-schemas-bucket"
|
|
s3_path_prefix: "devops-multiagent-demo" # Path prefix for OpenAPI schema files
|
|
|
|
# Provider Configuration
|
|
# This ARN is automatically generated by create_gateway.sh when it runs create_credentials_provider.py
|
|
provider_arn: "arn:aws:bedrock-agentcore:REGION:ACCOUNT_ID:token-vault/default/apikeycredentialprovider/YOUR_PROVIDER_NAME"
|
|
|
|
# Gateway Configuration
|
|
gateway_name: "MyAgentCoreGateway"
|
|
gateway_description: "AgentCore Gateway for API Integration"
|
|
|
|
# Target Configuration
|
|
target_description: "S3 target for OpenAPI schema"
|
|
``` |