blob: fc25e5ea131022c6a8588b6840936ab16b40bb2a [file] [log] [blame]
AWSTemplateFormatVersion: '2010-09-09'
Description: Deploy Gerrit primary to ECS cluster
Parameters:
GerritServiceName:
Type: String
Default: gerrit-primary
ReplicaServiceStackName:
Type: String
Default: gerrit-replica
TemplateBucketName:
Description: S3 bucket containing cloudformation templates
Type: String
ClusterStackName:
Description: Stack name of the ECS cluster to deply the serivces
Type: String
Default: gerrit-cluster
EnvironmentName:
Description: An environment name used to build the log stream names
Type: String
Default: test
DockerImage:
Description: Gerrit official Docker image
Type: String
Default: aws-gerrit/gerrit:latest
DockerRegistryUrl:
Description: Docker registry URL
Type: String
DesiredCount:
Description: How many instances of this task should we run across our cluster?
Type: Number
Default: 1
HTTPPort:
Description: Gerrit HTTP port
Type: Number
Default: 8080
HTTPSPort:
Description: Gerrit HTTPS port
Type: Number
Default: 443
SSHPort:
Description: Gerrit SSH port
Type: Number
Default: 29418
GitPort:
Description: Git daemon port
Type: Number
Default: 9418
GitSSHPort:
Description: Git ssh port
Type: Number
Default: 1022
CertificateArn:
Description: SSL Certificates ARN
Type: String
HostedZoneName:
Description: The route53 HostedZoneName.
Type: String
HttpSubdomain:
Description: The subdomain of the loadbalancer serving HTTP traffic for the primary Gerrit
Type: String
Default: gerrit-primary-http-demo
SshSubdomain:
Description: The subdomain of the loadbalancer serving SSH traffic for the primary Gerrit
Type: String
Default: gerrit-primary-ssh-demo
LoadBalancerScheme:
Description: Load Balancer schema, The nodes of an Internet-facing load balancer have public IP addresses.
Type: String
Default: internet-facing
AllowedValues: [internal, internet-facing]
SshReplicaSubdomain:
Description: The subdomain of the loadbalancer serving SSH traffic for the replicas
Type: String
GerritKeyPrefix:
Description: Gerrit credentials keys prefix
Type: String
GerritRAM:
Description: RAM to allocate to the Gerrit container
Type: Number
Default: 6000
GerritCPU:
Description: vCPU to allocate to the Gerrit container
Type: Number
Default: 1024
GerritHeapLimit:
Description: Gerrit Heap limit
Type: String
Default: 6g
FileDescriptorsSoftLimit:
Description: The soft limit for file descriptors allowed in the Gerrit container
Type: Number
Default: 1024
FileDescriptorsHardLimit:
Description: The hard limit for file descriptors allowed in the Gerrit container
Type: Number
Default: 1024
JgitCacheSize:
Description: JGit cache size
Type: String
Default: 3g
JgitOpenFiles:
Description: Maximum number of pack files to have open at once
Type: Number
Default: 128
LDAPServer:
Description: LDAP server URL
Type: String
LDAPUsername:
Description: Username to bind to the LDAP server with
Type: String
LDAPAccountBase:
Description: Root of the tree containing all user accounts
Type: String
LDAPGroupBase:
Description: Root of the tree containing all group objects
Type: String
LDAPAccountPattern:
Description: Query pattern to use when searching for a user account
Type: String
Default: (&(objectClass=person)(uid=${username}))
SMTPServer:
Description: SMTP server URL
Type: String
SMTPServerPort:
Description: SMTP server port
Type: Number
Default: 465
SMTPUser:
Description: User name to authenticate with, if required for relay
Type: String
SMTPDomain:
Description: Domain to be used in the From field
Type: String
SMTPEncryption:
Description: Encryption to be used
Type: String
Default: ssl
AllowedValues: ['ssl', 'tls', 'none']
SMTPSslVerify:
Description: If false and SMTPEncryption is 'ssl' or 'tls', Gerrit will not verify the server certificate when it connects to send an email message.
Type: String
Default: true
AllowedValues: [true, false]
InstanceId:
Description: Optional identifier for the Gerrit instance
Type: String
Default: gerrit-primary-replica-PRIMARY
MetricsCloudwatchEnabled:
Description: Whether gerrit metrics should be published to cloudwatch
Type: String
Default: false
AllowedValues: [true, false]
MetricsCloudwatchNamespace:
Description: The CloudWatch namespace for Gerrit metrics
Type: String
Default: gerrit
MetricsCloudwatchRate:
Description: The rate at which metrics should be fired to AWS
Type: String
Default: 60s
MetricsCloudwatchInitialDelay:
Description: The time to delay the first reporting execution
Type: String
Default: 0
MetricsCloudwatchJVMEnabled:
Description: Whether JVM metrics shoiuld be published to cloudwatch
Type: String
Default: false
AllowedValues: [true, false]
MetricsCloudwatchDryRun:
Description: The reporter will log.DEBUG the metrics, instead of doing a real POST to CloudWatch
Type: String
Default: false
AllowedValues: [true, false]
MetricsCloudwatchExcludeMetrics:
Description: Comma separated list of regex patterns to exclude metrics reported to CloudWatch
Type: CommaDelimitedList
Default: ''
EnableXray:
Description: Whether to enable X-Ray tracing for Gerrit
Type: String
Default: false
AllowedValues: [true, false]
Mappings:
XRay:
Info:
ContainerName: xray-daemon
Port: 2000
Gerrit:
Volume:
Git: gerrit-git
Data: gerrit-data
Index: gerrit-index
Cache: gerrit-cache
Db: gerrit-db
Logs: gerrit-logs
Conditions:
ShouldEnableXRay: !Equals [!Ref EnableXray, true]
Resources:
Service:
Type: AWS::ECS::Service
DependsOn:
- HTTPListener
- SSHListener
Properties:
Cluster:
Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'ClusterName']]
DesiredCount: !Ref DesiredCount
TaskDefinition: !Ref TaskDefinition
LoadBalancers:
- ContainerName: !Ref GerritServiceName
ContainerPort: !Ref HTTPPort
TargetGroupArn: !Ref HTTPTargetGroup
- ContainerName: !Ref GerritServiceName
ContainerPort: !Ref SSHPort
TargetGroupArn: !Ref SSHTargetGroup
TaskDefinition:
Type: AWS::ECS::TaskDefinition
Properties:
Family: !Join ['', [!Ref GerritServiceName, TaskDefinition]]
TaskRoleArn: !GetAtt ECSTaskExecutionRoleStack.Outputs.TaskExecutionRoleRef
ExecutionRoleArn: !GetAtt ECSTaskExecutionRoleStack.Outputs.TaskExecutionRoleRef
NetworkMode: bridge
PlacementConstraints:
- Expression: !Sub 'attribute:target_group == primary'
Type: "memberOf"
ContainerDefinitions:
- Name: !Ref GerritServiceName
Essential: true
Image: !Sub '${DockerRegistryUrl}/${DockerImage}'
Environment:
- Name: XRAY_ENABLED
Value: !Ref EnableXray
- Name: AWS_XRAY_TRACING_NAME
Value: !Ref InstanceId
- Name: AWS_XRAY_DAEMON_ADDRESS
Value: !Join [':', [!FindInMap ['XRay', 'Info', 'ContainerName'], !FindInMap ['XRay', 'Info', 'Port']]]
- Name: CANONICAL_WEB_URL
Value: !Sub 'https://${HttpSubdomain}.${HostedZoneName}'
- Name: SSHD_ADVERTISED_ADDRESS
Value: !Sub '${SshSubdomain}.${HostedZoneName}:${SSHPort}'
- Name: HTTPD_LISTEN_URL
Value: !Sub 'proxy-https://*:${HTTPPort}/'
- Name: AWS_REGION
Value: !Ref AWS::Region
- Name: SETUP_REPLICATION
Value: true
- Name: GERRIT_KEY_PREFIX
Value: !Ref GerritKeyPrefix
- Name: GERRIT_HEAP_LIMIT
Value: !Ref GerritHeapLimit
- Name: JGIT_CACHE_SIZE
Value: !Ref JgitCacheSize
- Name: JGIT_OPEN_FILES
Value: !Ref JgitOpenFiles
- Name: LDAP_SERVER
Value: !Ref LDAPServer
- Name: LDAP_USERNAME
Value: !Ref LDAPUsername
- Name: LDAP_ACCOUNT_BASE
Value: !Ref LDAPAccountBase
- Name: LDAP_GROUP_BASE
Value: !Ref LDAPGroupBase
- Name: LDAP_ACCOUNT_PATTERN
Value: !Ref LDAPAccountPattern
- Name: SMTP_SERVER
Value: !Ref SMTPServer
- Name: SMTP_SERVER_PORT
Value: !Ref SMTPServerPort
- Name: SMTP_ENCRYPTION
Value: !Ref SMTPEncryption
- Name: SMTP_SSL_VERIFY
Value: !Ref SMTPSslVerify
- Name: SMTP_USER
Value: !Ref SMTPUser
- Name: SMTP_DOMAIN
Value: !Ref SMTPDomain
- Name: GERRIT_INSTANCE_ID
Value: !Ref InstanceId
- Name: GIT_PORT
Value: !Ref GitPort
- Name: GIT_SSH_PORT
Value: !Ref GitSSHPort
- Name: REPLICA_SUBDOMAIN
Value: !Ref SshReplicaSubdomain
- Name: HOSTED_ZONE_NAME
Value: !Ref HostedZoneName
- Name: REINDEX_AT_STARTUP
Value: false
- Name: METRICS_CLOUDWATCH_ENABLED
Value: !Ref MetricsCloudwatchEnabled
- Name: METRICS_CLOUDWATCH_NAMESPACE
Value: !Ref MetricsCloudwatchNamespace
- Name: METRICS_CLOUDWATCH_RATE
Value: !Ref MetricsCloudwatchRate
- Name: METRICS_CLOUDWATCH_INITIAL_DELAY
Value: !Ref MetricsCloudwatchInitialDelay
- Name: METRICS_CLOUDWATCH_JVM_ENABLED
Value: !Ref MetricsCloudwatchJVMEnabled
- Name: METRICS_CLOUDWATCH_DRY_RUN
Value: !Ref MetricsCloudwatchDryRun
- Name: METRICS_CLOUDWATCH_EXCLUDE_METRICS_LIST
Value: !Join [',', !Ref MetricsCloudwatchExcludeMetrics]
Ulimits:
- Name: nofile
HardLimit: !Ref FileDescriptorsHardLimit
SoftLimit: !Ref FileDescriptorsSoftLimit
MountPoints:
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Git']
ContainerPath: /var/gerrit/git
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Data']
ContainerPath: /var/gerrit/data
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Index']
ContainerPath: /var/gerrit/index
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Cache']
ContainerPath: /var/gerrit/cache
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Db']
ContainerPath: /var/gerrit/db
- SourceVolume: !FindInMap ['Gerrit', 'Volume', 'Logs']
ContainerPath: /var/gerrit/logs
Cpu: !Ref GerritCPU
Memory: !Ref GerritRAM
PortMappings:
- ContainerPort: !Ref HTTPPort
HostPort: !Ref HTTPPort
Protocol: tcp
- ContainerPort: !Ref SSHPort
HostPort: !Ref SSHPort
Protocol: tcp
LogConfiguration:
LogDriver: awslogs
Options:
awslogs-group: !Ref ClusterStackName
awslogs-region: !Ref AWS::Region
awslogs-stream-prefix: !Ref EnvironmentName
Links:
Fn::If:
- ShouldEnableXRay
-
- !FindInMap ['XRay', 'Info', 'ContainerName']
- !Ref "AWS::NoValue"
- Fn::If:
- ShouldEnableXRay
- Name: !FindInMap ['XRay', 'Info', 'ContainerName']
Essential: false
Image: "amazon/aws-xray-daemon"
Cpu: 32
MemoryReservation: 256
PortMappings:
- HostPort: 2000
ContainerPort: 2000
Protocol: "udp"
- !Ref "AWS::NoValue"
Volumes:
- Name: !FindInMap ['Gerrit', 'Volume', 'Db']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Db']]]
- Name: !FindInMap ['Gerrit', 'Volume', 'Git']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Git']]]
- Name: !FindInMap ['Gerrit', 'Volume', 'Data']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Data']]]
- Name: !FindInMap ['Gerrit', 'Volume', 'Cache']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Cache']]]
- Name: !FindInMap ['Gerrit', 'Volume', 'Index']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Index']]]
- Name: !FindInMap ['Gerrit', 'Volume', 'Logs']
Host:
SourcePath: !Join ['/', ["/gerrit-mount-point", !FindInMap ['Gerrit', 'Volume', 'Logs']]]
GerritHTTPLoadBalancerSG:
Type: AWS::EC2::SecurityGroup
Properties:
VpcId:
Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'VPCId']]
GroupDescription: "Allow public HTTPS traffic to primary Gerrit"
GroupName: !Sub '${ClusterStackName}-P-H'
SecurityGroupIngress:
- IpProtocol: 'tcp'
FromPort: !Ref HTTPSPort
ToPort: !Ref HTTPSPort
CidrIp: '0.0.0.0/0'
Description: "HTTPS connections from everywhere (IPv4)"
- IpProtocol: 'tcp'
FromPort: !Ref HTTPSPort
ToPort: !Ref HTTPSPort
CidrIpv6: '::/0'
Description: "HTTPS connections from everywhere (IPv6)"
GerritHTTPLoadBalancer:
Type: AWS::ElasticLoadBalancingV2::LoadBalancer
Properties:
Name: !Sub '${ClusterStackName}-P-H'
Type: application
Scheme: !Ref 'LoadBalancerScheme'
SecurityGroups:
- !Ref GerritHTTPLoadBalancerSG
Subnets:
- Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'PublicSubnetOne']]
- Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'PublicSubnetTwo']]
Tags:
- Key: Name
Value: !Join ['-', [!Ref 'EnvironmentName', !Ref 'GerritServiceName', 'alb']]
GerritSSHLoadBalancer:
Type: AWS::ElasticLoadBalancingV2::LoadBalancer
Properties:
Name: !Sub '${ClusterStackName}-P-S'
Type: network
Scheme: !Ref 'LoadBalancerScheme'
LoadBalancerAttributes:
- Key: 'load_balancing.cross_zone.enabled'
Value: true
Subnets:
- Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'PublicSubnetOne']]
- Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'PublicSubnetTwo']]
Tags:
- Key: Name
Value: !Join ['-', [!Ref 'EnvironmentName', !Ref 'GerritServiceName', 'nlb']]
HTTPTargetGroup:
Type: AWS::ElasticLoadBalancingV2::TargetGroup
DependsOn: GerritHTTPLoadBalancer
Properties:
VpcId:
Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'VPCId']]
Port: !Ref HTTPPort
Protocol: HTTP
HealthCheckProtocol: HTTP
HealthCheckPort: !Ref HTTPPort
HealthCheckPath: '/config/server/healthcheck~status'
Name: !Sub '${ClusterStackName}-P-H'
HTTPListener:
Type: AWS::ElasticLoadBalancingV2::Listener
Properties:
Certificates:
- CertificateArn: !Ref CertificateArn
DefaultActions:
- Type: forward
TargetGroupArn: !Ref HTTPTargetGroup
LoadBalancerArn: !Ref GerritHTTPLoadBalancer
Port: !Ref HTTPSPort
Protocol: HTTPS
SSHTargetGroup:
Type: AWS::ElasticLoadBalancingV2::TargetGroup
DependsOn: GerritSSHLoadBalancer
Properties:
VpcId:
Fn::ImportValue:
!Join [':', [!Ref 'ClusterStackName', 'VPCId']]
Port: !Ref SSHPort
Protocol: TCP
HealthCheckProtocol: HTTP
HealthCheckPort: !Ref HTTPPort
HealthCheckPath: '/config/server/healthcheck~status'
Name: !Sub '${ClusterStackName}-P-S'
SSHListener:
Type: AWS::ElasticLoadBalancingV2::Listener
Properties:
DefaultActions:
- Type: forward
TargetGroupArn: !Ref SSHTargetGroup
LoadBalancerArn: !Ref GerritSSHLoadBalancer
Port: !Ref SSHPort
Protocol: TCP
ECSTaskExecutionRoleStack:
Type: AWS::CloudFormation::Stack
Properties:
TemplateURL: !Join [ '', ['https://', !Ref TemplateBucketName, '.s3.amazonaws.com/cf-gerrit-task-execution-role.yml'] ]
TimeoutInMinutes: '5'
Outputs:
########
# HTTP #
########
GerritHTTPLoadBalancerDNSName:
Description: The DNS name of the gerrit HTTP load balancer
Value: !GetAtt 'GerritHTTPLoadBalancer.DNSName'
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritHTTPLoadBalancerDNSName' ] ]
GerritHTTPCanonicalHostedZoneID:
Description: Canonical Hosted Zone ID of the gerrit HTTP load balancer
Value: !GetAtt 'GerritHTTPLoadBalancer.CanonicalHostedZoneID'
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritHTTPCanonicalHostedZoneID' ] ]
GerritHTTPLoadBalancerUrl:
Description: The url of the gerrit HTTP load balancer
Value: !Join ['', ['http://', !GetAtt 'GerritHTTPLoadBalancer.DNSName']]
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritHTTPLoadBalancerUrl' ] ]
#######
# SSH #
#######
GerritSSHLoadBalancerDNSName:
Description: The DNS name of the gerrit SSH load balancer
Value: !GetAtt 'GerritSSHLoadBalancer.DNSName'
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritSSHLoadBalancerDNSName' ] ]
GerritSSHCanonicalHostedZoneID:
Description: Canonical Hosted Zone ID of the gerrit SSH load balancer
Value: !GetAtt 'GerritSSHLoadBalancer.CanonicalHostedZoneID'
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritSSHCanonicalHostedZoneID' ] ]
GerritSSHLoadBalancerUrl:
Description: The url of the gerrit SSH load balancer
Value: !Join ['', ['http://', !GetAtt 'GerritSSHLoadBalancer.DNSName']]
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'GerritSSHLoadBalancerUrl' ] ]
#######
# DNS #
#######
HostedZoneName:
Description: Route53 Hosted Zone name
Value: !Ref HostedZoneName
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'HostedZoneName' ] ]
HttpSubdomain:
Description: Service DNS subdomain for gerrit HTTP traffic
Value: !Ref HttpSubdomain
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'HttpSubdomain' ] ]
SshSubdomain:
Description: Service DNS subdomain for gerrit SSH traffic
Value: !Ref SshSubdomain
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'SshSubdomain' ] ]
CanonicalWebUrl:
Description: Canonical Web URL
Value: !Sub 'https://${HttpSubdomain}.${HostedZoneName}'
Export:
Name: !Join [ ':', [ !Ref 'AWS::StackName', 'CanonicalWebUrl' ] ]