CloudForge CI Documentation
Complete documentation for deploying and managing secure, compliant Jenkins infrastructure on AWS.
📖 Table of Contents
- Quick Start
- Applications & Plugins
- Setup & Configuration
- Compliance & Security
- Advanced Topics
- Reference
🚀 Quick Start
New to CloudForge? Start here:
- Quick Start Guide - Get running in 10 minutes
- Sample Project - Clone and deploy
- Interactive Deployer - User-friendly CLI tool
Example deployment:
git clone https://github.com/CloudForgeCI/cloudforge-sample.git
cd cloudforge-sample
mvn clean package
cdk deploy --context cfc=@deployment-context.json
🔌 Applications & Plugins
Application Guides
Comprehensive guides for each application with deployment-context examples:
| Application | Status | Guide |
|---|---|---|
| Jenkins | Verified | Jenkins Guide |
| Mattermost | Verified | Mattermost Guide |
| Metabase | Verified | Metabase Guide |
| GitLab | Available | GitLab Guide |
| Grafana | Available | Grafana Guide |
| Harbor | Available | Harbor Guide |
| Nexus | Available | Nexus Guide |
| SonarQube | Plugin | SonarQube Guide |
All Application Guides | Deployment Context Examples
Application Catalog
| Document | Description |
|---|---|
| Application Catalog | Complete catalog of 14 built-in applications |
| Application Compliance | Compliance requirements for each application |
| OIDC Integration | Application-level OIDC authentication (Grafana, GitLab, Jenkins) |
Plugin System
| Document | Description |
|---|---|
| Plugin Ecosystem | Overview of built-in applications and plugin architecture |
| Plugin System Guide | Core architecture and development patterns |
| Application Plugin Guide | Build custom application plugins |
| Compliance Plugin Guide | Build custom compliance framework validators |
⚙️ Setup & Configuration
Authentication
| Document | Description | Best For |
|---|---|---|
| Identity Center Setup | AWS IAM Identity Center + ALB-OIDC (Okta, Auth0) | Enterprise SSO |
| Cognito MFA Compliance | AWS Cognito user pools with MFA | HIPAA, PCI-DSS, Quick setup |
Configuration Files
| Document | Description |
|---|---|
| deployment-context.json Reference | All configuration properties |
| Compliance Configurations | Framework-specific settings |
🔐 Compliance & Security
Compliance Frameworks
| Framework | Document | Key Features |
|---|---|---|
| SOC 2 | Multi-Framework Guide | Access controls, monitoring, 2-year logs |
| HIPAA | Multi-Framework Guide | Encryption, 6-year logs, private network |
| PCI-DSS | PCI-DSS Guide | WAF, threat detection, 1-year logs |
| GDPR | Multi-Framework Guide | Encryption, data protection, EU regions |
Framework Comparison Table - See requirements side-by-side
Automated Compliance
| Document | Description |
|---|---|
| Automated Compliance | Auto-remediation features overview |
| S3 Versioning Remediation | Automatic S3 versioning enforcement |
| Multi-Framework Compliance | Deploy multiple frameworks simultaneously |
| PCI-DSS Application Security | Application-level PCI compliance |
| AWS Config Multi-Stack | Multi-account AWS Config setup |
| Deployment Guide | Production deployment strategies |
Security
| Document | Description |
|---|---|
| Security Hardening | Security best practices and policies |
| Security Rules | Comprehensive security guidelines |
| IAM Rules | IAM best practices and policies |
📚 Advanced Topics
Audit & Monitoring
| Document | Description |
|---|---|
| AWS Audit Manager | Continuous audit automation setup |
| Auditor Compliance Mapping | Control mappings for external audits |
Testing & Validation
| Document | Description |
|---|---|
| Extended Testing | Comprehensive testing guide |
| Compliance Truth Tables | Systematic compliance rules testing |
Developer Resources
| Document | Description |
|---|---|
| IAM Rules | IAM best practices and policies |
| Security Rules | Comprehensive security guidelines |
📑 Reference
Indexes & Catalogs
- Compliance Overview - All compliance documentation
- Configuration Reference - All deployment-context.json properties
Quick Links
- Main README - Project overview and quick start
- CHANGELOG - Release history
- CONTRIBUTING - How to contribute
- LICENSE - Apache 2.0 License
🎯 Documentation by Use Case
"I want to deploy an application"
- Application Guides - Comprehensive guides for each app
- Deployment Context Examples - Ready-to-use JSON configs
- Interactive Deployer - CLI deployment tool
"I want to deploy Jenkins quickly"
"I need SOC2 compliance"
"I need HIPAA compliance"
"I need PCI-DSS compliance"
"I want to set up authentication"
- Identity Center Setup (enterprise SSO)
- Cognito MFA Setup (AWS-native with MFA)
"I'm deploying to production"
📞 Getting Help
- Issues: GitHub Issues
- Examples: cloudforge-sample
- Discussions: GitHub Discussions
🤝 Contributing
Found a documentation error or want to improve something?
- Read CONTRIBUTING.md
- Submit a pull request
- Help others by sharing your knowledge
Last Updated: 2025-12-07 Documentation Version: 3.0.0