Skip to main content

CloudForge CI Documentation

Documentation for defining, deploying, and validating supported application infrastructure on AWS with CloudForge.

Table of Contents​

Quick Start​

New to CloudForge? Start here:

  1. Quick Start Guide - Configure compliance validation
  2. Local Emulator Quick Start - Build, MiniStack, and LocalStack from repository root
  3. Sample Project - Clone and deploy
  4. Interactive Deployer - CLI deployment 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​

Application guides with deployment-context examples:

ApplicationStatusGuide
JenkinsVerifiedJenkins Guide
MattermostVerifiedMattermost Guide
MetabaseVerifiedMetabase Guide
GitLabAvailableGitLab Guide
GrafanaAvailableGrafana Guide
HarborAvailableHarbor Guide
NexusAvailableNexus Guide
SonarQubePluginSonarQube Guide

All Application Guides | Deployment Context Examples

Application Catalog​

DocumentDescription
Application CatalogCatalog of 33 built-in applications
Application ComplianceCompliance requirements for each application
OIDC IntegrationApplication-level OIDC authentication (Grafana, GitLab, Jenkins)

Plugin System​

DocumentDescription
Plugin EcosystemOverview of built-in applications and plugin architecture
Plugin System GuideCore architecture and development patterns
Application Plugin GuideBuild custom application plugins
Compliance Plugin GuideBuild custom compliance framework validators

Setup & Configuration​

Authentication​

DocumentDescriptionBest For
Identity Center SetupAWS IAM Identity Center + ALB-OIDC (Okta, Auth0)Organization-managed SSO
Cognito MFA ComplianceAWS Cognito user pools with MFAHIPAA, PCI-DSS, Quick setup

Configuration Files​

DocumentDescription
deployment-context.json ReferenceAll configuration properties
Compliance ConfigurationsFramework-specific settings

Local AWS Emulation (MiniStack & LocalStack)​

Deploy without an AWS account from the repository root. Start here:

DocumentDescription
Local Emulator Quick StartBuild, start emulators, synth, deploy (root commands)
Local Emulator Hostnames/etc/hosts *.cloudforge.localhost for MiniStack and LocalStack
Local Emulator Edge (nginx)Port-free Host routing; StackPort for resource deep-dive
MiniStack OverviewArchitecture, fidelity table, source layout
LocalStack OverviewToken and adapter behavior
SetupMiniStack prerequisites and environment detail
DeploymentInteractive Deployer, Jenkins walkthrough
VerificationConfirm deployed resources
AdvancedAuth proxy, incremental updates, env vars
TroubleshootingDebugging local deployments

Compliance & Security​

Compliance Frameworks​

FrameworkDocumentKey Features
SOC 2Multi-Framework GuideAccess controls, monitoring, 2-year logs
HIPAAMulti-Framework GuideEncryption, 6-year logs, private network
PCI-DSSPCI-DSS GuideWAF, threat detection, 1-year logs
GDPRMulti-Framework GuideEncryption, data protection, EU regions

Framework Comparison Table - See requirements side-by-side

Automated Compliance​

DocumentDescription
Automated ComplianceAuto-remediation features overview
S3 Versioning RemediationAutomatic S3 versioning enforcement
Multi-Framework ComplianceDeploy multiple frameworks simultaneously
PCI-DSS Application SecurityApplication-level PCI compliance
AWS Config Multi-StackMulti-account AWS Config setup
Deployment GuideProduction deployment strategies

Security​

DocumentDescription
Security HardeningSecurity best practices and policies
Security RulesSecurity guidelines
IAM RulesIAM best practices and policies

Advanced Topics​

Architecture​

DocumentDescription
CloudForge Sample BOM TemplateStandalone project / cloudforge-sample POM

Audit & Monitoring​

DocumentDescription
AWS Audit ManagerContinuous audit automation setup
Auditor Compliance MappingControl mappings for external audits

Testing & Validation​

DocumentDescription
Extended TestingTesting procedures and configurations
Compliance Truth TablesSystematic compliance rules testing
Integration TestsAWS-focused integration tests
MiniStack Local DeploymentLocal MiniStack setup, deploy, verify (cfc-testing)

Developer Resources​

DocumentDescription
IAM RulesIAM best practices and policies
Security RulesSecurity guidelines

Reference​

Indexes & Catalogs​

Documentation by Use Case​

"I want to deploy an application"​

  1. Application Guides - Configuration guides for supported applications
  2. Deployment Context Examples - Example JSON configurations
  3. Interactive Deployer - CLI deployment tool

"I want to deploy Jenkins"​

  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​

  1. Read CONTRIBUTING.md
  2. Submit a pull request

Last Updated: June 2026 Documentation Version: 3.2.0