Skip to content

docs: Use version reference in module snippets in readmes. #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2025
Merged

docs: Use version reference in module snippets in readmes. #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06c2919
Use version reference in module snippets in readmes.
eshiferax Jun 1, 2025
9f95fbf
Add output block to samples in readme.
eshiferax Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,16 @@ Each module directory linked above contains its own detailed `README.md` which i
* A sample invocation block.
* Step-by-step deployment instructions.

To use any of these modules, you would typically reference its path using a Git source in your Terraform configuration. For example:
To use any of these modules, you would typically reference its path using a Git source in your Terraform configuration.

We recommend to pin to the specific/[latest](https://github.com/tecton-ai/tecton-terraform-setup/releases/latest) version at the time of deployment. Add `?ref=<version_number>` at the end of the `source` statement.

For example:

```terraform
module "tecton" {
# This example uses the dataplane_rift module
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift" # Path updated
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift?ref=<version>"

# ... provide all required input variables for the selected module here ...
# Example variables for 'dataplane_rift':
Expand Down
6 changes: 5 additions & 1 deletion modules/controlplane_rift/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/controlplane_rift"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/controlplane_rift?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -35,6 +35,10 @@ module "tecton" {
tecton_control_plane_account_id = "987654321098" # Replace with Tecton's Control Plane Account ID
cross_account_external_id = "your-tecton-external-id" # Replace with the External ID from Tecton
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy (when using this module)
Expand Down
6 changes: 5 additions & 1 deletion modules/controlplane_rift_with_emr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/controlplane_rift_with_emr"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/controlplane_rift_with_emr?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -43,6 +43,10 @@ module "tecton" {
# To enable EMR debugging for Tecton support (requires notebook_cluster_count = 1):
# emr_debugging_count = 1
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy
Expand Down
10 changes: 5 additions & 5 deletions modules/controlplane_rift_with_emr/infrastructure.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ terraform {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//deployment"
source = "../../deployment"
providers = {
aws = aws
}
Expand All @@ -28,7 +28,7 @@ module "tecton" {

## EMR Resources
module "security_groups" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//emr/security_groups"
source = "../../emr/security_groups"
providers = {
aws = aws
}
Expand All @@ -39,7 +39,7 @@ module "security_groups" {

# Tecton default vpc/subnet configuration
module "subnets" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//emr/vpc_subnets"
source = "../../emr/vpc_subnets"
providers = {
aws = aws
}
Expand All @@ -49,7 +49,7 @@ module "subnets" {

# Notebook Cluster and Debugging
module "notebook_cluster" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//emr/notebook_cluster"
source = "../../emr/notebook_cluster"
providers = {
aws = aws
}
Expand Down Expand Up @@ -83,7 +83,7 @@ module "notebook_cluster" {
#
# Enable this module by setting count = 1
module "emr_debugging" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//emr/debugging"
source = "../../emr/debugging"
providers = {
aws = aws
}
Expand Down
6 changes: 5 additions & 1 deletion modules/databricks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/databricks"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/databricks?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -47,6 +47,10 @@ module "tecton" {
tecton_control_plane_account_id = "987654321098" # Tecton's Control Plane Account ID
cross_account_external_id = "your-tecton-external-id" # External ID from Tecton
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy (when using this module)
Expand Down
6 changes: 5 additions & 1 deletion modules/dataplane_rift/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -44,6 +44,10 @@ module "tecton" {
# Optional: For PrivateLink to Control Plane. Add _after_ deployment is complete and PrivateLink details are shared by Tecton
# tecton_vpce_service_name = "com.amazonaws.vpce.us-west-2.vpce-svc-xxxxxxxxxxxxxxxxx"
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy (when using this module)
Expand Down
6 changes: 5 additions & 1 deletion modules/dataplane_rift_with_emr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift_with_emr"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/dataplane_rift_with_emr?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -46,6 +46,10 @@ module "tecton" {
# To enable EMR debugging for Tecton support (requires notebook_cluster_count = 1):
# emr_debugging_count = 1
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy
Expand Down
6 changes: 5 additions & 1 deletion modules/emr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ provider "aws" {
}

module "tecton" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/emr"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/emr?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -44,6 +44,10 @@ module "tecton" {
# Optional: Enable Redis
# enable_redis = true
}

output "tecton" {
value = module.tecton
}
```

### Steps to Deploy
Expand Down
6 changes: 5 additions & 1 deletion modules/standalone_rift/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ provider "aws" {
}

module "rift" {
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/standalone_rift"
source = "git::https://github.com/tecton-ai/tecton-terraform-setup.git//modules/standalone_rift?ref=<version>"
providers = {
aws = aws
}
Expand All @@ -49,6 +49,10 @@ module "rift" {
# use_network_firewall = true
# additional_allowed_egress_domains = ["example.com", "*.example.org"]
}

output "tecton" {
value = module.rift
}
```

### Steps to Deploy
Expand Down
Loading