Skip to content

components definitions

All component definitions in this configuration file.
These components are used and configured separately per site.

Example:

components:
  - name: api-extensions
    short_name: apiexts
    source: git::ssh://git@git.labdigital.nl/mach-components/api-extensions-component.git//terraform
    version: 3b8ab91
    endpoints: 
      main: default
  - name: ct-products-types
    source: git::ssh://git@git.labdigital.nl/mach-components/ct-product-types.git//terraform
    version: 1.4.0
    integrations: ["commercetools"]
  • name - Name of the component. To be used as reference in the site definitions.
  • version - A Git commit hash or tag
  • source - Source definition of the terraform module
  • short_name - Short name to be used in cloud resources. Should be at most 10 characters to avoid running into Resource naming limits.
    Defaults to the given components name
  • integrations - Defines a list of integrations for the given component. It controls what Terraform variables are passed on to the components Terraform module.
    Defaults to ["azure"] or ["aws"], depending on your cloud provider.
    Could be any of:
    • azure
    • aws
    • commercetools
    • contentful
  • endpoints - Defines the endpoint that needs to connect to this component.
    Will setup Frontdoor routing or pass API Gateway information when set.
  • health_check_path - Defines a custom healthcheck path.
    Defaults to /<name>/healthchecks

Development settings

In addition to the default set of component settings, a couple of settings can be defined during development.
These are not intendend to be used for a production deployment, but can facilitate local development:

  • branch - Configure the git branch of the component. Only used to facilitate the mach update CLI command.
  • package_script - Script file to build and package the component, relative from where MACH is run. AWS only
  • package_filename - Filename to be used for deployment, relative from where MACH is run. AWS only

Example: 

components:
- name: my-component
  source: ../mach-component-my-component/terraform
  integrations: ["aws", "commercetools", "sentry"]
  version: latest
  package_filename: ../mach-component-my-component/.serverless/my-component.zip
  package_script: cd ../mach-component-my-component/ && yarn package

More info on using MACH during development