Takomo
  • What is Takomo?
  • Getting started
    • Installation
    • Quick start
    • Tutorial
  • Configuration
    • AWS credentials
    • Directory structure
    • Stacks and stack groups
    • Project configuration
  • Stack properties
    • Name
    • Regions
    • Template
    • Template bucket
    • Command role
    • Account ids
    • Depends
    • Parameters
    • Tags
    • Inherit tags
    • Termination protection
    • Timeout
    • Capabilities
    • Stack policy
    • Ignore
    • Obsolete
    • Hooks
    • Data
    • Schemas
  • Variables and templating
    • Introduction
    • Handlebars syntax
    • Environment variables
    • Command-line variables
    • Partials
    • Helpers
    • Available variables
  • Parameter resolvers
    • Built-in parameter resolvers
      • Stack output resolver
      • External stack output resolver
      • Command resolver
      • File contents resolver
      • Hook output resolver
      • SSM parameter resolver
      • Secret resolver
    • Custom parameter resolvers
  • Hooks
    • Built-in hooks
    • Custom hooks
    • Sharing data between hooks
  • Validation schemas
    • Custom validation schemas
  • Command-line usage
    • Common options
    • Deploy stacks
    • Undeploy stacks
    • Prune stacks
    • List stacks
    • Detect drift
    • Generate IAM policies
    • Inspect stack configuration
    • Inspect stack dependencies
  • Support
    • Getting help
    • Troubleshooting
  • Development
    • Change log
Powered by GitBook
On this page
  • Required Takomo version
  • Allowed regions
  • Feature flags
  • Extending project configuration

Was this helpful?

Export as PDF
  1. Configuration

Project configuration

PreviousStacks and stack groupsNextName

Last updated 3 years ago

Was this helpful?

You can configure project-wide settings in a takomo.yml file that you place in the project root directory.

Required Takomo version

You specify the required Takomo version with the requiredVersion property. It accepts a NPM compatible version range.

Example

Require Takomo version 3.4.0 or above:

takomo.yml
requiredVersion: ">=3.4.0"

Allowed regions

By default, the supported regions are hardcoded in Takomo's codebase. A new Takomo version is released whenever AWS launches new regions.

In case you need to use an older Takomo version that does not include some regions launched after its release, you may specify the missing regions yourself using this property.

You can also use this property to list only the regions you intend to use to prevent deploys to any other region.

Example

Allow only these four regions:

takomo.yml
regions:
  - us-east-1
  - eu-west-1
  - eu-central-1
  - eu-north-1 

Feature flags

You can enable and disable certain Takomo features by specifying feature flags under the features property. Here are the available feature flags

Feature flag

Description

deploymentTargetsUndeploy

You might want to disable this command to add an extra confirmation step to prevent removing targets unintentionally.

deploymentTargetsTearDown

You might want to disable this command to add an extra confirmation step to prevent removing targets unintentionally.

Example

Disable undeploy deployment targets command:

takomo.yml
features:
  deploymentTargetsUndeploy: false

Extending project configuration

You can make a Takomo project configuration file to inherit configuration from another file. Inheriting configuration becomes useful, for example, when you have a monorepo containing multiple Takomo projects, each having its own configuration and sharing some common properties with others. You can place the common properties in a parent file that others then inherit.

You use the extends property to make a project configuration file inherit configuration from another file:

takomo.yml
extends: ../my-parent-config.yml

Set false to disable command.

You can override this setting by giving --feature deploymentTargetsUndeploy=true option from command-line when executing command.

Set false to disable command.

You can override this setting by giving --feature deploymentTargetsTearDown=true option from command-line when executing command.

semver
undeploy deployment targets
undeploy deployment targets
tear down deployment targets
tear down deployment targets