-
Notifications
You must be signed in to change notification settings - Fork 3
Notes on assigning names
There are many places where you will assign a name to a file or a key. General characteristics of all assigned names are:
- names are arbitrary, but you will want to give a meaningful name
- example names are given in all places where names are assigned
- do not use spaces in names
- prefer
-(dash) over_(underscore) unless the example indicates otherwise
Example names are for a single deploy environment. Many institutions follow a multi-deploy environment (e.g. development, staging, production). In this case, you can run the templates for each deploy environment. The names you assign should include an indicator of the environment being deployed.
Assuming support of development, staging, and production multi-deploy environments, one possible approach to naming would be to include abbreviations for each environment in the name.
File names would include the abbreviation. For example, resources-parameters.env would become:
- resources-parameters-dev.env
- resources-parameters-stg.env
- resources-parameters-prod.env
Key names would also include the abbreviation. For example, the value for S3 bucket names would become:
- lookup-dev-bucket
- lookup-stg-bucket
- lookup-prod-bucket