rudder-terraform-setup

Name: rudder-terraform-setup
Author: rudderlabs

18stars0forks

How to install rudder-terraform-setup?

rudderlabs/rudder-agent-skills/rudder-terraform-setup

$npx -y skills add rudderlabs/rudder-agent-skills --skill rudder-terraform-setup

Installs into the current project.

Summary

Installs Terraform and configures the RudderStack provider. Use when setting up terraform for rudderstack, installing terraform-provider-rudderstack, or terraform provider not found errors

Files · 1

View on GitHub

SKILL.md

1	# RudderStack Terraform Setup
2
3	Install Terraform (if missing), configure the RudderStack provider, and verify setup.
4
5	## Setup Workflow
6
7	```
8	1. Check Terraform ──► terraform version
9	│
10	├── Found ──► Skip to Provider Setup
11	│
12	└── Not Found ──► Guide Installation
13	│
14	2. Configure Provider ◄─────────────┘
15	│
16	└── Add required_providers block
17
18	3. Initialize ──► terraform init
19	│
20	└── Downloads provider from registry
21
22	4. Configure Auth ──► Check RUDDERSTACK_ACCESS_TOKEN
23	│
24	└── Verify with terraform plan
25	```
26
27	## Step 1: Check Terraform Installation
28
29	```bash
30	terraform version
31	```
32
33	If found: Shows version. Skip to Step 2.
34
35	If not found: Install Terraform.
36
37	### Install Terraform
38
39	#### macOS (Homebrew)
40
41	```bash
42	brew tap hashicorp/tap
43	brew install hashicorp/tap/terraform
44	```
45
46	#### Linux (apt)
47
48	```bash
49	# Add HashiCorp GPG key
50	wget -O- https://apt.releases.hashicorp.com/gpg \| sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
51
52	# Add repository
53	echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" \| sudo tee /etc/apt/sources.list.d/hashicorp.list
54
55	# Install
56	sudo apt update && sudo apt install terraform
57	```
58
59	#### Alternative: tfenv (Version Manager)
60
61	```bash
62	# macOS
63	brew install tfenv
64
65	# Then install Terraform
66	tfenv install latest
67	tfenv use latest
68	```
69
70	#### Verify Installation
71
72	```bash
73	terraform version
74	```
75
76	Expected: `Terraform v1.x.x`
77
78	## Step 2: Configure RudderStack Provider
79
80	### Create or Update versions.tf
81
82	In your Terraform project directory, create `versions.tf`:
83
84	```hcl
85	terraform {
86	required_version = ">= 1.0"
87
88	required_providers {
89	rudderstack = {
90	source = "rudderlabs/rudderstack"
91	version = "~> 4.3.1"
92	}
93	}
94	}
95
96	provider "rudderstack" {
97	# access_token read from RUDDERSTACK_ACCESS_TOKEN env var
98	}
99	```
100
101	### Check Provider Latest Version
102
103	Visit https://registry.terraform.io/providers/rudderlabs/rudderstack/latest for the current version.
104
105	## Step 3: Initialize Provider
106
107	```bash
108	terraform init
109	```
110
111	Expected output:
112	```
113	Initializing provider plugins...
114	- Finding rudderlabs/rudderstack versions matching "~> 4.3.1"...
115	- Installing rudderlabs/rudderstack v4.3.1...
116	- Installed rudderlabs/rudderstack v4.3.1
117
118	Terraform has been successfully initialized!
119	```
120
121	### Verify Provider Installed
122
123	```bash
124	terraform providers
125	```
126
127	Should show `rudderlabs/rudderstack` in the list.
128
129	## Step 4: Configure Authentication
130
131	### Set Access Token
132
133	Get your access token from RudderStack dashboard: Settings → Access Tokens
134
135	```bash
136	export RUDDERSTACK_ACCESS_TOKEN="your-token-here"
137	```
138
139	For permanent setup, add to your shell profile (`~/.zshrc` or `~/.bashrc`):
140
141	```bash
142	echo 'export RUDDERSTACK_ACCESS_TOKEN="your-token-here"' >> ~/.zshrc
143	source ~/.zshrc
144	```
145
146	### Verify Authentication
147
148	Create a minimal `main.tf` to test:
149
150	```hcl
151	# main.tf - minimal test configuration
152	data "rudderstack_source" "test" {
153	# This will fail if auth is wrong
154	}
155	```
156
157	Then run:
158
159	```bash
160	terraform plan
161	```
162
163	If authenticated: Shows "No changes" or data source info.
164
165	If not authenticated: Shows authentication error.
166
167	## Credential Security
168
169	- Never hardcode tokens in `.tf` files
170	- Use environment variable `RUDDERSTACK_ACCESS_TOKEN`
171	- Add `.env` and `*.tfvars` containing secrets to `.gitignore`
172	- For CI/CD, use repository secrets or vault
173	- Never commit `.tfstate` without encryption (contains sensitive data)
174
175	## Provider Configuration Options
176
177	```hcl
178	provider "rudderstack" {
179	# Token from env var (recommended)
180	# access_token = var.rudderstack_token # Alternative: use variable
181
182	# Optional: Override API URL (default: https://api.rudderstack.com/v2)
183	# api_url = "https://api.rudderstack.com/v2"
184	}
185	```
186
187	## Troubleshooting
188
189	\| Issue \| Solution \|
190	\|-------\|----------\|
191	\| `provider not found` \| Run `terraform init` \|
192	\| `unauthorized` \| Check RUDDERSTACK_ACCESS_TOKEN is set correctly \|
193	\| `version constraints` \| Update version in required_providers block \|
194	\| `init fails` \| Check network; try with `-upgrade` flag \|
195
196	## Next Steps
197
198	After setup completes:
199	- Run `/rudder-environment-check` to verify full environment
200	- Use `/rudder-terraform-workflow` for plan/apply cycles

People who liked this also viewed

6 picks

Type

rudder-terraform-setup

18stars0forks

View on GitHub

How to install rudder-terraform-setup?

rudderlabs/rudder-agent-skills/rudder-terraform-setup

$npx -y skills add rudderlabs/rudder-agent-skills --skill rudder-terraform-setup

Installs into the current project.

Summary

Installs Terraform and configures the RudderStack provider. Use when setting up terraform for rudderstack, installing terraform-provider-rudderstack, or terraform provider not found errors

Files · 1

View on GitHub

SKILL.md

1	# RudderStack Terraform Setup
2
3	Install Terraform (if missing), configure the RudderStack provider, and verify setup.
4
5	## Setup Workflow
6
7	```
8	1. Check Terraform ──► terraform version
9	│
10	├── Found ──► Skip to Provider Setup
11	│
12	└── Not Found ──► Guide Installation
13	│
14	2. Configure Provider ◄─────────────┘
15	│
16	└── Add required_providers block
17
18	3. Initialize ──► terraform init
19	│
20	└── Downloads provider from registry
21
22	4. Configure Auth ──► Check RUDDERSTACK_ACCESS_TOKEN
23	│
24	└── Verify with terraform plan
25	```
26
27	## Step 1: Check Terraform Installation
28
29	```bash
30	terraform version
31	```
32
33	If found: Shows version. Skip to Step 2.
34
35	If not found: Install Terraform.
36
37	### Install Terraform
38
39	#### macOS (Homebrew)
40
41	```bash
42	brew tap hashicorp/tap
43	brew install hashicorp/tap/terraform
44	```
45
46	#### Linux (apt)
47
48	```bash
49	# Add HashiCorp GPG key
50	wget -O- https://apt.releases.hashicorp.com/gpg \| sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
51
52	# Add repository
53	echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" \| sudo tee /etc/apt/sources.list.d/hashicorp.list
54
55	# Install
56	sudo apt update && sudo apt install terraform
57	```
58
59	#### Alternative: tfenv (Version Manager)
60
61	```bash
62	# macOS
63	brew install tfenv
64
65	# Then install Terraform
66	tfenv install latest
67	tfenv use latest
68	```
69
70	#### Verify Installation
71
72	```bash
73	terraform version
74	```
75
76	Expected: `Terraform v1.x.x`
77
78	## Step 2: Configure RudderStack Provider
79
80	### Create or Update versions.tf
81
82	In your Terraform project directory, create `versions.tf`:
83
84	```hcl
85	terraform {
86	required_version = ">= 1.0"
87
88	required_providers {
89	rudderstack = {
90	source = "rudderlabs/rudderstack"
91	version = "~> 4.3.1"
92	}
93	}
94	}
95
96	provider "rudderstack" {
97	# access_token read from RUDDERSTACK_ACCESS_TOKEN env var
98	}
99	```
100
101	### Check Provider Latest Version
102
103	Visit https://registry.terraform.io/providers/rudderlabs/rudderstack/latest for the current version.
104
105	## Step 3: Initialize Provider
106
107	```bash
108	terraform init
109	```
110
111	Expected output:
112	```
113	Initializing provider plugins...
114	- Finding rudderlabs/rudderstack versions matching "~> 4.3.1"...
115	- Installing rudderlabs/rudderstack v4.3.1...
116	- Installed rudderlabs/rudderstack v4.3.1
117
118	Terraform has been successfully initialized!
119	```
120
121	### Verify Provider Installed
122
123	```bash
124	terraform providers
125	```
126
127	Should show `rudderlabs/rudderstack` in the list.
128
129	## Step 4: Configure Authentication
130
131	### Set Access Token
132
133	Get your access token from RudderStack dashboard: Settings → Access Tokens
134
135	```bash
136	export RUDDERSTACK_ACCESS_TOKEN="your-token-here"
137	```
138
139	For permanent setup, add to your shell profile (`~/.zshrc` or `~/.bashrc`):
140
141	```bash
142	echo 'export RUDDERSTACK_ACCESS_TOKEN="your-token-here"' >> ~/.zshrc
143	source ~/.zshrc
144	```
145
146	### Verify Authentication
147
148	Create a minimal `main.tf` to test:
149
150	```hcl
151	# main.tf - minimal test configuration
152	data "rudderstack_source" "test" {
153	# This will fail if auth is wrong
154	}
155	```
156
157	Then run:
158
159	```bash
160	terraform plan
161	```
162
163	If authenticated: Shows "No changes" or data source info.
164
165	If not authenticated: Shows authentication error.
166
167	## Credential Security
168
169	- Never hardcode tokens in `.tf` files
170	- Use environment variable `RUDDERSTACK_ACCESS_TOKEN`
171	- Add `.env` and `*.tfvars` containing secrets to `.gitignore`
172	- For CI/CD, use repository secrets or vault
173	- Never commit `.tfstate` without encryption (contains sensitive data)
174
175	## Provider Configuration Options
176
177	```hcl
178	provider "rudderstack" {
179	# Token from env var (recommended)
180	# access_token = var.rudderstack_token # Alternative: use variable
181
182	# Optional: Override API URL (default: https://api.rudderstack.com/v2)
183	# api_url = "https://api.rudderstack.com/v2"
184	}
185	```
186
187	## Troubleshooting
188
189	\| Issue \| Solution \|
190	\|-------\|----------\|
191	\| `provider not found` \| Run `terraform init` \|
192	\| `unauthorized` \| Check RUDDERSTACK_ACCESS_TOKEN is set correctly \|
193	\| `version constraints` \| Update version in required_providers block \|
194	\| `init fails` \| Check network; try with `-upgrade` flag \|
195
196	## Next Steps
197
198	After setup completes:
199	- Run `/rudder-environment-check` to verify full environment
200	- Use `/rudder-terraform-workflow` for plan/apply cycles

People who liked this also viewed

6 picks

Type