Skip to content

local_setup.md

Latest commit

 

History

History
76 lines (63 loc) · 1.66 KB

local_setup.md

File metadata and controls

76 lines (63 loc) · 1.66 KB

CloudCull Setup Guide

Prerequisites

  • Python 3.12+
  • Node.js 20+ (for dashboard)
  • uv package manager (recommended)

Credential Configuration

CloudCull relies on standard SDK credential chains. It does not manage keys itself.

1. AWS Credentials

Standard Boto3 configuration:

export AWS_ACCESS_KEY_ID="testing"
export AWS_SECRET_ACCESS_KEY="testing"
export AWS_REGION="us-east-1"

Or use ~/.aws/credentials

2. Azure Credentials

Uses DefaultAzureCredential. Set these environment variables:

export AZURE_SUBSCRIPTION_ID="your-sub-id"
export AZURE_TENANT_ID="your-tenant-id"
export AZURE_CLIENT_ID="your-client-id"
export AZURE_CLIENT_SECRET="your-client-secret"

3. GCP Credentials

Uses Application Default Credentials (ADC):

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/key.json"
export GOOGLE_CLOUD_PROJECT="your-project-id"

4. AI Model Keys

At least one is required for analysis:

export ANTHROPIC_API_KEY="sk-ant-..."
# OR
export GOOGLE_API_KEY="AIza..."
# OR
export OPENAI_API_KEY="sk-..."

Simulated Mode (Demo)

To run CloudCull without any of the above credentials:

uv run cloudcull --simulated --dry-run

This will generate a high-fidelity mock report.

Secure Dashboard

The dashboard is served via a secure Python backend to protect sensitive logs.

  1. Build the Frontend (once):

    cd dashboard
npm run build
cd ..

  2. Start the Secure Server:

    python3 src/dashboard_server.py

    Access at http://localhost:8080.

Legacy Dev Mode

Note: Will not be able to access secured logs.

cd dashboard
npm run dev