Skip to content

fix: [CI-21068]: Add MinIO setup guide for self-hosted cache storage#11838

Open
spahuja-harness wants to merge 1 commit intomainfrom
add-minio-self-hosted-cache-docs
Open

fix: [CI-21068]: Add MinIO setup guide for self-hosted cache storage#11838
spahuja-harness wants to merge 1 commit intomainfrom
add-minio-self-hosted-cache-docs

Conversation

@spahuja-harness
Copy link
Member

Summary

Adds comprehensive documentation for using MinIO as an S3-compatible gateway for self-hosted Harness CI cache storage.

This documentation addresses the use case where customers:

  • Only have NFS storage available (no S3-compatible storage)
  • Are in air-gapped environments
  • Need to maintain cache data on-premises for compliance reasons

Changes

  • Added new section "Self-Hosted Cache with MinIO" to docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
  • Included complete MinIO deployment examples:
    • Docker deployment with NFS backing
    • Kubernetes deployment with NFS volumes
  • Documented MinIO bucket creation and lifecycle policies
  • Provided YAML examples for SaveCache/RestoreCache steps with MinIO configuration
  • Added best practices for production deployments
  • Documented network requirements and firewall rules

Why This Change?

Based on internal architecture documentation and customer requirements, many self-hosted customers don't have direct S3 access but do have NFS storage. MinIO provides the S3-compatible API layer needed to use Harness cache features in these environments.

Testing

  • Documentation builds successfully
  • YAML examples are syntactically correct
  • MinIO deployment steps verified against architecture docs

Related Issues

  • JIRA: CI-21068

Add comprehensive documentation for using MinIO as an S3-compatible
gateway for self-hosted Harness CI cache storage. This is particularly
useful for customers who:
- Only have NFS storage available
- Are in air-gapped environments
- Need to maintain cache data on-premises

Changes:
- Added "Self-Hosted Cache with MinIO" section
- Included Docker and Kubernetes deployment examples
- Documented MinIO bucket creation and lifecycle policies
- Provided complete SaveCache/RestoreCache YAML examples
- Added best practices and network requirements
- Explained pathStyle requirement for MinIO compatibility
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@bot-gitexp-user
Copy link

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://699c8db674ef96610224235f--harness-developer.netlify.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants