Configuration

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

Here below a list of variables that are common and need to be specified regardless the recipe you want to deploy. Please refer to the individual recipes to understand what additional variables need to be set.

Common parameters

Environment

Configuration values affecting deployment environment and cluster properties

  • AWS_REGION: Optional. Which region to deploy to. us-east-1 by default.
  • AWS_PREFIX: Optional. A string to prefix stacks and resources with. gerrit by default.
  • DOCKER_REGISTRY_URI: Mandatory. URI of the Docker registry. See the prerequisites section for more details.
  • SSL_CERTIFICATE_ARN: Mandatory. ARN of the wildcard SSL Certificate, covering both master nodes.
  • CLUSTER_STACK_NAME: Optional. Name of the cluster stack. gerrit-cluster 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.
  • GERRIT_KEY_PREFIX : Optional. Secrets prefix used during the Import into AWS Secret Manager. gerrit_secret by default.

SPECS

Configuration values to spec up Gerrit containers.

  • CLUSTER_INSTANCE_TYPE: Optional. The EC2 instance Type used to run the cluster. m4.10xlarge by default.
  • 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.
  • INTERNET_GATEWAY_ID: Optional. Id of the existing Internet Gateway. If not set, create a new Internet Gateway
  • VPC_ID: Optional. Id of the existing VPC. If not set, create a new VPC.
  • SUBNET_ID: Optional. Id of the existing Subnet. If not set, create a new Network Stack.
  • LOAD_BALANCER_SCHEME: Optional. The Load Balancer scheme type. internet-facing by default. Allowed values: internal, internet-facing

LDAP

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 documentation
  • LDAP_USERNAME: Mandatory. Username to bind to the LDAP server with See Gerrit documentation
  • LDAP_ACCOUNT_BASE: Mandatory. Root of the tree containing all user accounts See Gerrit documentation
  • LDAP_GROUP_BASE: Mandatory. Root of the tree containing all group objects See Gerrit documentation

SMTP

Configuration 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 documentation
  • SMTP_USER: Mandatory. User name to authenticate with See Gerrit documentation
  • SMTP_DOMAIN: Mandatory. Domain to be used in the “From” field of any generated email messages See Gerrit documentation