This set of Templates provide all the components to deploy a single Gerrit master in ECS
Two templates are provided in this example:
cf-cluster
: define the ECS cluster and the networking stackcf-service
: defined the service stack running Gerritcf-dns-route
: defined the DNS routing for the serviceerror_log
is exported in a Log Group in CloudWatchYou can find on GerritForge's YouTube Channel a step-by-step guide on how to setup you Gerrit Code Review in AWS.
However, keep reading this guide for a more exhaustive explanation.
Follow the steps described in the Prerequisites section
Each recipe provides a setup.env.template
file which is a template for configuring the Gerrit stacks. Copy that into a setup.env
and set the correct values for the provided environment variables.
cp setup.env.template setup.env
This is the list of available parameters:
Configuration values affecting deployment environment and cluster properties
DOCKER_REGISTRY_URI
: Mandatory. URI of the Docker registry. See the prerequisites section for more details.SSL_CERTIFICATE_ARN
: Mandatory. ARN of the SSL Certificate.CLUSTER_STACK_NAME
: Optional. Name of the cluster stack. gerrit-cluster
by default.SERVICE_STACK_NAME
: Optional. Name of the service stack. gerrit-service
by default.DNS_ROUTING_STACK_NAME
: Optional. Name of the DNS routing stack. gerrit-dns-routing
by default.HOSTED_ZONE_NAME
: Optional. Name of the hosted zone. mycompany.com
by default.SUBDOMAIN
: Optional. Name of the sub domain. gerrit-master-demo
by default.GERRIT_KEY_PREFIX
: Optional. Secrets prefix used during the Import into AWS Secret Manager. gerrit_secret
by default.Configuration values to spec up Gerrit containers.
GERRIT_RAM
: RAM allocated (MiB) to the Gerrit container. 70000
by default.GERRIT_CPU
: vCPU units allocated to the Gerrit container. 10240
by default.GERRIT_HEAP_LIMIT
: Maximum heap size of the Java process running Gerrit, in bytes. See Gerrit documentation 35g
by default.JGIT_CACHE_SIZE
: Maximum number of bytes to load and cache in memory from pack files. See Gerrit documentation for more details. 12g
by default.Configuration values related to LDAP integration. See more details here
LDAP_SERVER
: Mandatory. URL of the organization’s LDAP server to query for user information and group membership from See Gerrit documentationLDAP_USERNAME
: Mandatory. Username to bind to the LDAP server with See Gerrit documentationLDAP_ACCOUNT_BASE
: Mandatory. Root of the tree containing all user accounts See Gerrit documentationLDAP_GROUP_BASE
: Mandatory. Root of the tree containing all group objects See Gerrit documentationConfiguration values related to SMTP integration. See more details here
SMTP_SERVER
: Mandatory. Hostname (or IP address) of a SMTP server that will relay messages generated by Gerrit to end users See Gerrit documentationSMTP_USER
: Mandatory. User name to authenticate with See Gerrit documentationSMTP_DOMAIN
: Mandatory. Domain to be used in the “From” field of any generated email messages See Gerrit documentationmake create-all
It might take several minutes to build the stack. You can monitor the creations of the stacks in CloudFormation
pem
file on the current directory. To use when ssh-ing into your instances as follow: ssh -i cluster-keys.pem ec2-user@<ec2_instance_ip>
make delete-all
Note that this will not delete:
You Gerrit instance will be available at this URL: http://<HOSTED_ZONE_NAME>.<SUBDOMAIN>
.
The available ports are 8080
for HTTP and 29418
for SSH.
If you need to setup some external services (maybe for testing purposes, such as SMTP or LDAP), you can follow the instructions here
Refer to the Docker section for information on how to setup docker or how to publish images