cal/claude-home
1
0
Fork 0
Code Issues 6 Pull Requests 4 Actions Packages Projects Releases Wiki Activity
ceb4dd36a0
claude-home/docker/scripts/CONTEXT.md
Cal Corum ceb4dd36a0 Add docker scripts, media-tools, VM management, and n8n workflow docs 
Add CONTEXT.md for docker and VM management script directories.
Add media-tools documentation with Playwright scraping patterns.
Add Tdarr GPU monitor n8n workflow definition.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-07 22:26:10 -06:00

3.1 KiB
Raw Blame History

Docker Scripts - Operational Context

Script Overview

This directory is reserved for active operational scripts for Docker container management, orchestration, and automation.

Current Status: No operational scripts currently deployed. This structure is maintained for future Docker automation needs.

Future Script Categories

Planned Script Types

Container Lifecycle Management

  • Start/stop scripts for complex multi-container setups
  • Health check and restart automation
  • Graceful shutdown procedures for dependent containers

Maintenance Automation

  • Image cleanup and pruning scripts
  • Volume backup and restoration
  • Container log rotation and archiving
  • Network cleanup and validation

Monitoring and Alerts

  • Container health monitoring
  • Resource usage tracking
  • Discord/webhook notifications for container events
  • Uptime and availability reporting

Deployment Automation

  • CI/CD integration scripts
  • Rolling update procedures
  • Blue-green deployment automation
  • Container migration tools

Integration Points

External Dependencies

  • Docker/Podman: Container runtime
  • Docker Compose: Multi-container orchestration
  • cron: System scheduler for automation
  • Discord Webhooks: Notification integration (when implemented)

File System Dependencies

  • Container Volumes: Various locations depending on service
  • Configuration Files: Service-specific docker-compose.yml files
  • Log Files: Container and automation logs
  • Backup Storage: For volume snapshots and exports

Network Dependencies

  • Docker Networks: Bridge, host, and custom networks
  • External Services: APIs and webhooks for monitoring
  • Registry Access: For image pulls and pushes (when needed)

Development Guidelines

When Adding New Scripts

Documentation Requirements:

  1. Add script description to this CONTEXT.md under appropriate category
  2. Include usage examples and command-line options
  3. Document dependencies and prerequisites
  4. Specify cron schedule if automated
  5. Add troubleshooting section for common issues

Script Standards:

#!/bin/bash
# Script name and purpose
# Dependencies: list required commands/services
# Usage: ./script.sh [options]

set -euo pipefail  # Strict error handling

Testing Requirements:

  • Test with both Docker and Podman where applicable
  • Verify error handling and logging
  • Document failure modes and recovery procedures
  • Include dry-run or test mode where appropriate

Related Documentation

  • Technology Overview: /docker/CONTEXT.md
  • Troubleshooting: /docker/troubleshooting.md
  • Examples: /docker/examples/ - Reference configurations and patterns
  • Main Instructions: /CLAUDE.md - Context loading rules

Notes

This directory structure is maintained to support future Docker automation needs while keeping operational scripts organized and documented according to the technology-first documentation pattern established in the claude-home repository.

When scripts are added, this file should be updated to include specific operational context similar to the comprehensive documentation found in /tdarr/scripts/CONTEXT.md.