Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.95 KB

readme.md

File metadata and controls

46 lines (28 loc) · 2.95 KB
Raw

Terrarium Farm Documentation

Terrarium Farm is a collection of modules and interfaces designed to enhance the functionality of Terraform and provide smart autocomplete features through the Terrarium VSCode extension. This documentation provides an overview of the Terrarium Farm modules and dependency interfaces.

Terrarium Farm Modules

The modules directory contains a set of Terraform module calls in HCL (HashiCorp Configuration Language) without any attributes. When you run terraform init, all the specified modules are downloaded into the .terraform/modules directory. These modules are then parsed by the Terrarium CLI to extract information about the Terraform providers, resources, modules, attribute mappings, and more.

Here's an example of a module call in HCL format:

module "vpc" {
  source  = "terraform-aws-modules/vpc/aws"
  version = "4.0.2"
}

To hide a module from the module indexer in Terrarium (terrarium harvest modules) while still using it in resource and resource attribute mapping harvesting (terrarium harvest mappings), you can prefix the module name with tr-hide-. This allows you to exclude specific modules from indexing while retaining their functionality.

Here's an example of a hidden module call:

module "tr-hide-banking-demo" {
  source = "github.com/cldcvr/codepipes-tutorials//tfs/aws-ecr-apprunner-vpc?ref=terrarium-sources"
}

Harvesting Multiple Modules

To avoid provider version conflicts when harvesting multiple modules at once the user may provide a file containing a list of modules to be processed by the harvest commands. The commands then process each module in a separate workspace while performing the required Terraform initialization automatically.

Read more - src/pkg/metadata/cli/readme.md

Terrarium Farm Dependency Interfaces

The Terrarium Dependency Interface is a contract that defines the inputs and outputs of an infrastructure dependency, facilitating communication between applications and Infrastructure as Code (IaC). It enables multi-platform implementation and is a key component in the Terrarium project architecture.

Read more - src/pkg/metadata/dependency/readme.md

We hope this documentation provides you with a clear understanding of the Terrarium Farm modules and dependency interfaces. If you have any further questions or need assistance, please refer to the official Terrarium documentation or reach out to the Terrarium community for support.

Terrarium Farm Platform

The YAML file encapsulates essential repository details required for accessing the 'terrarium.yaml' file. In addition to managing repository details, the YAML configuration is used in mapping relationships between platforms and dependency interfaces. This is done by mapping the components in the terrarium.yaml and dependency interface already stored in the db. The mapping details are then stored in the platform_components table