Skip to main content

Deployment Context Examples

Ready-to-use deployment context configurations for CloudForge applications. Copy any of these files and customize for your environment.

Quick Start

# Copy an example
cp docs/examples/applications/jenkins-dev.json deployment-context.json

# Edit required fields
vim deployment-context.json

# Deploy
cdk deploy

Required Customizations

Before deploying, update these fields in any example:

FieldDescriptionExample
stackNameUnique CloudFormation stack nameMyCompany-Jenkins-Prod
domainYour domain (or omit for Private CA)example.com
subdomainService subdomain (or omit for Private CA)jenkins
cognitoDomainPrefixGlobally unique Cognito prefixmycompany-jenkins-prod
regionAWS regionus-east-1

SSL Certificate Options

Option A: Custom Domain (public certificate)

{
"domain": "example.com",
"subdomain": "jenkins",
"enableSsl": true
// Public ACM certificate via DNS validation
}

Option B: No Domain (Private CA certificate)

For rapid deployment without domain setup, omit domain and subdomain. The system automatically creates an AWS Private CA and issues a certificate for the ALB DNS name:

{
"enableSsl": true,
"authMode": "alb-oidc",
"cognitoAutoProvision": true
// No domain/subdomain - Private CA certificate issued for ALB DNS name
}

Private CA Notes:

  • Only created when no domain is configured AND enableSsl: true
  • Costs ~$400/month (auto-deleted with stack via RemovalPolicy.DESTROY)
  • Browser shows certificate warnings (not publicly trusted)
  • Fully compliant with HIPAA, PCI-DSS, SOC2, GDPR (encryption requirements met)

Examples by Application

Jenkins

FileEnvironmentFeatures
jenkins-dev.jsonDevelopmentMinimal, no auth
jenkins-dev-auth.jsonDevelopmentWith Cognito OIDC
jenkins-dev-quick.jsonDevelopmentNo domain - Private CA, Cognito OIDC
jenkins-production.jsonProductionSOC2, HA, build agents

Mattermost

FileEnvironmentFeatures
mattermost-dev.jsonDevelopmentMinimal, no database
mattermost-production.jsonProductionSOC2, RDS PostgreSQL

Metabase

FileEnvironmentFeatures
metabase-dev.jsonDevelopmentEmbedded H2 database
metabase-production.jsonProductionSOC2, RDS PostgreSQL

GitLab

FileEnvironmentFeatures
gitlab-production.jsonProductionSSH, Registry, Metrics

Grafana

FileEnvironmentFeatures
grafana-production.jsonProductionRDS PostgreSQL, HA

Harbor

FileEnvironmentFeatures
harbor-production.jsonProductionTrivy, Notary

SonarQube

FileEnvironmentFeatures
sonarqube-production.jsonProductionALB-OIDC

Examples by Compliance Framework

No Domain Quick Start (Private CA)

Test compliance rules without domain infrastructure:

FileDescription
compliance-soc2-quick.jsonSOC2 staging - no domain required
compliance-hipaa-quick.jsonHIPAA staging - no domain required

SOC2

FileDescription
compliance-soc2-staging.jsonSOC2 staging template
compliance-soc2-production.jsonSOC2 production template

HIPAA

FileDescription
compliance-hipaa-production.jsonHIPAA + SOC2 template

PCI-DSS

FileDescription
compliance-pci-dss-production.jsonPCI-DSS + SOC2 template

File Naming Convention

{application}-{environment}.json
compliance-{framework}-{environment}.json