Skip to content

Naming conventions

When you set up your infrastructure, the templates generate files. These files follow the naming rules below.

  • Files managed by templates always start with an underscore. The number of underscores depends on the layer. All template files also include gp.
  • gp stands for Golden Path.

Configuration layer

  • Prefix: Two underscores followed by "gp" (__gp)
  • Example: __gp_config.tf

The app template generates these:

  • __gp_config.tf
  • __gp_config_app_image.auto.tfvars.json
  • __gp_dependencies.tf
  • __gp_variables.tf

Resource and module layer

  • Prefix: Single underscore followed by "gp" (_gp)
  • Example: _gp_iam.tf

The same template generates these alongside them:

  • _gp_alb_tg_host_routing_apex_domain.tf
  • _gp_alb_tg_host_routing_subdomain.tf
  • _gp_deployment.tf
  • _gp_ecs_container_definition_main.tf
  • _gp_ecs_otel_collector_sidecar.tf
  • _gp_ecs_service.tf
  • _gp_iam_cd_assumable_role.tf
  • _gp_iam_cicd_policies.tf
  • _gp_iam_cicd_roles.tf
  • _gp_security_groups.tf
  • _gp_telemetry_collection.tf

Adding your own files

You can create two types of files in addition to the files you get from the Golden Path templates

  • Override files that override Golden Path files. Terraform overrides (guide) are used when you need to change behavior from the Golden Path templates. The guide explains how to name these files.
  • Normal Terraform files, that you create yourself. Typically to create features that Golden Path does not support yet. You do not need to use a prefix when creating these files.