Sign inSign up

dbdaryl/gitlab-support-scripts

By dbdaryl

โ€ขUpdated about 1 year ago

Support scripts for GitLab health checks, DB, Redis, Sidekiq, and backup verification.

Image
Monitoring & observability
0

836

dbdaryl/gitlab-support-scripts repository overview

โ GitLab Support Scripts ๐Ÿ“š

A comprehensive collection of Ruby and Bash scripts for GitLab administration, monitoring, and troubleshooting tasks. This Docker image provides ready-to-use tools for GitLab health checking, database analysis, Redis monitoring, Sidekiq statistics, and backup verification.

โ ๐Ÿš€ Quick Start

# Health check (no token required)
docker run --rm dbdaryl/gitlab-support-scripts gitlab-health-check https://gitlab.example.com

# Database analysis (requires admin token)
docker run --rm dbdaryl/gitlab-support-scripts gitlab-db-analyzer https://gitlab.example.com glpat-xxxxxxxxxxxxxxxxxxxx

โ ๐Ÿ“‹ Available Tools

ScriptPurposeAuth Required
gitlab-health-checkInstance health, readiness, liveness checksNo
gitlab-db-analyzerDatabase performance and slow query analysisYes
gitlab-redis-monitorRedis metrics, memory usage, key patternsYes
gitlab-sidekiq-statsQueue analysis, job statistics, worker performanceYes
gitlab-backup-verifyBackup integrity and structure validationNo

โ ๐Ÿ’ก Usage Examples

โ Health Monitoring
docker run --rm dbdaryl/gitlab-support-scripts gitlab-health-check https://gitlab.example.com
โ Performance Analysis
# Database performance
docker run --rm dbdaryl/gitlab-support-scripts \
  gitlab-db-analyzer https://gitlab.example.com glpat-your-token-here

# Redis monitoring  
docker run --rm dbdaryl/gitlab-support-scripts \
  gitlab-redis-monitor https://gitlab.example.com glpat-your-token-here

# Sidekiq queue analysis
docker run --rm dbdaryl/gitlab-support-scripts \
  gitlab-sidekiq-stats https://gitlab.example.com glpat-your-token-here
โ Backup Verification
# Mount your backup directory and verify
docker run --rm -v /path/to/backups:/backups \
  dbdaryl/gitlab-support-scripts gitlab-backup-verify -d /backups -v
โ Interactive Mode
# Get shell access for multiple commands
docker run -it --rm dbdaryl/gitlab-support-scripts bash

โ ๐Ÿ”ง Docker Compose

Create a .env file:

GITLAB_URL=https://your-gitlab.com
GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxxxxxx

Run with docker-compose:

# One-off health check
docker-compose run --rm gitlab-support-scripts gitlab-health-check

# Start continuous monitoring
docker-compose --profile monitoring up -d gitlab-monitor

โ ๐Ÿงช Testing

# Run all tests
docker run --rm dbdaryl/gitlab-support-scripts --test

# Run specific test suite
docker run --rm dbdaryl/gitlab-support-scripts run-tests health-check

โ ๐Ÿ“š Documentation & Support

โ ๐Ÿ”’ Security & Permissions

  • Scripts requiring API access need GitLab admin tokens for full functionality
  • All tools are designed for defensive security and administration purposes
  • No data is stored or transmitted outside your environment

โ ๐Ÿ“„ License

MIT License - Free for commercial and personal use


Tags: gitlab, monitoring, administration, devops, ruby, health-check, database, redis, sidekiq, backup

Tag summary

Content type

Image

Digest

sha256:edd9ca241โ€ฆ

Size

40.7 MB

Last updated

about 1 year ago

docker pull dbdaryl/gitlab-support-scripts