Skip to content

README.md

Latest commit

 

History

History
224 lines (158 loc) · 9.18 KB

README.md

File metadata and controls

224 lines (158 loc) · 9.18 KB

CloudForge CI Documentation

Complete documentation for deploying and managing secure, compliant Jenkins infrastructure on AWS.

📖 Table of Contents

🚀 Quick Start

New to CloudForge? Start here:

  1. Quick Start Guide - Get running in 10 minutes
  2. Sample Project - Clone and deploy
  3. 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

Quick Links

🎯 Documentation by Use Case

"I want to deploy an application"

  1. Application Guides - Comprehensive guides for each app
  2. Deployment Context Examples - Ready-to-use JSON configs
  3. Interactive Deployer - CLI deployment tool

"I want to deploy Jenkins quickly"

  1. Jenkins Guide
  2. Jenkins Dev Example
  3. Quick Start Guide

"I need SOC2 compliance"

  1. SOC2 Configuration Example
  2. Multi-Framework Guide
  3. Automated Compliance

"I need HIPAA compliance"

  1. HIPAA Configuration Example
  2. Multi-Framework Guide
  3. Security Hardening

"I need PCI-DSS compliance"

  1. PCI-DSS Configuration Example
  2. PCI-DSS Guide
  3. PCI-DSS Application Security

"I want to set up authentication"

  1. Identity Center Setup (enterprise SSO)
  2. Cognito MFA Setup (AWS-native with MFA)

"I'm deploying to production"

  1. Deployment Guide
  2. Security Rules
  3. Extended Testing

📞 Getting Help

🤝 Contributing

Found a documentation error or want to improve something?

  1. Read CONTRIBUTING.md
  2. Submit a pull request
  3. Help others by sharing your knowledge

Last Updated: 2025-12-07 Documentation Version: 3.0.0