teleport/integrations/terraform

Terraform Provider Plugin

Usage

Please refer to the official documentation.

Development

1. Install protobuf.

2. Install Terraform v1.1.0+. Alternatively, you can use tfenv. Please note that on Mac M1 you need to specify TFENV_ARCH (ex: TFENV_ARCH=arm64 tfenv install 1.1.6).

3. Build and install the plugin:

   cd integrations/terraform
   make install
   

4. Run tests:

   make test
   

5. For provider architecture and resource development, see:

   • Architecture
   • Contributing resources

Updating the provider

Run:

make gen-tfschema

This will generate types_tfschema.go from a current API .proto file, and regenerate the provider code.

If the schema changed, you will need to re-render the docs with:

make docs

Playing with examples locally

1. Start Teleport.

   teleport start
   

2. Create Terraform user and role:

   tctl create example/terraform.yaml
   tctl auth sign --format=file --user=terraform --out=/tmp/terraform-identity --ttl=10h
   

3. Create main.tf file:

   cp example/main.tf.example example/main.tf
   

   Please note that target identity file was exported to /tmp/terraform-identity on previous step. If you used another location, please change in in main.tf.

4. Create sample resources:

   cp example/user.tf.example example/user.tf
   cp example/role.tf.example example/role.tf
   cp example/provision_token.tf.example example/provision_token.tf
   

   Please note that some resources require preliminary setup steps.

5. Apply changes:

   make apply
   

6. Make changes to .tf files and run:

   make reapply
   

7. Clean up:

   make destroy