reportportal/migrations-complex repository overview

⁠ReportPortal Migrations Complex

A service for migrating ReportPortal data between storage systems and upgrading database schemas. Supports three migration types that can run independently or together in a single execution.

⁠What It Does

Benefits: All migrations can run in one job, execute sequentially, and preserve data integrity.

⁠Downtime

⁠Quick Start (Helm)

helm repo add reportportal-migrations https://reportportal.io/migrations-complex/
helm repo update
helm show values reportportal-migrations/migrations-complex > my-values.yaml
# Edit my-values.yaml: enable migrations and set DB/storage credentials
helm install my-migration reportportal-migrations/migrations-complex -f my-values.yaml

Monitor:

kubectl logs -l app.kubernetes.io/name=migrations-complex --follow

Clean up:

helm uninstall my-migration

⁠Migration Types (Summary)

1. Database API Keys — Converts OAuth tokens to API keys. Needs DB credentials. Requires downtime.
2. Multi-bucket to single bucket — Finds buckets by prefix, merges into one, updates DB. Needs DB + storage (MinIO or S3). Requires downtime.
3. MinIO to S3 — Copies data from one MinIO bucket to one S3 bucket. Needs MinIO + S3 credentials. No downtime.

⁠Prerequisites

• Kubernetes cluster with Helm 3.x
• Access to ReportPortal database (PostgreSQL)
• Storage credentials (MinIO and/or S3) with read/write
• Database backup recommended

⁠Configuration (Values)

Enable migrations and set endpoints/credentials in your values file:

migrations:
  database:
    apiKeys:
      enabled: false   # true for API keys migration
  storage:
    multiBucketToSingleBucket:
      enabled: false
      destinationType: minio   # or "s3"
      buckets:
        projectPrefix: "prj-"
        pluginsBucket: "rp-bucket"
        singleBucketName: "rp-storage"
    minioToS3:
      enabled: false
      buckets:
        sourceBucket: "rp-storage"
        destinationBucket: "rp-s3-storage"

database:
  endpoint: <postgres-host>
  port: 5432
  user: rpuser
  dbName: reportportal
  password: ""   # or use secretName

storage:
  minio:
    endpoint: <minio-host>
    port: 9000
    ssl: false
    accessKey: ""
    secretKey: ""
  s3:
    region: "eu-central-1"
    endpoint: s3.eu-central-1.amazonaws.com
    ssl: true
    accessKey: ""
    secretKey: ""

Use Kubernetes secrets for credentials when possible (secretName / passwordKeyName, etc.).

⁠Troubleshooting

• Job won’t start: Check resources, image pull secrets, node selectors/tolerations.
• DB errors: Verify endpoint, credentials, and network from pod (e.g. kubectl run with postgres image and psql).
• Storage errors: Check bucket names, credentials, and IAM/permissions (S3) or endpoint/SSL (MinIO).
• Slow migration: Increase CPU/memory limits and check network/storage performance.

⁠Documentation

• Full Helm chart and scenario guide: charts/README.md⁠
• ReportPortal: reportportal.io⁠

⁠License

See repository LICENSE file.