Add HowTo tutorial to configure Terraform Custom Provider #1162

lakshmimsft · 2024-07-24T04:06:05Z

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

Read the contribution guide
Commands include options for Linux, MacOS, and Windows within codetabs
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Adding HowTo tutorial to configure Terraform Custom Provider

6539

Reshrahim

Overall flow looks good. Suggested some edits for clarity.

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

Reshrahim · 2024-07-24T14:55:07Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+
+This how-to guide will describe how to:
+
+- Configure a custom Terraform Provider and use it in a Terraform recipe.


Suggested change

- Configure a custom Terraform Provider and use it in a Terraform recipe.

- Configure a custom [Terraform provider](https://registry.terraform.io/browse/providers) in a Radius environment

- Consume the terraform modules from a custom Terraform provider and use it in a Terraform recipe.

Should there also be a bullet point indicating that they will configure credentials for the terraform provider?

added. pls take another look.

Reshrahim · 2024-07-24T14:58:21Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+This how-to guide will describe how to:
+
+- Configure a custom Terraform Provider and use it in a Terraform recipe.
+In this example we're going to configure a PostgreSQL Terraform provider in a Radius environment and deploy a recipe.    


Suggested change

In this example we're going to configure a PostgreSQL Terraform provider in a Radius environment and deploy a recipe.

In this example we're going to configure a [PostgreSQL Terraform provider](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs) in a Radius environment and deploy a recipe.

Suggest adding the reference link here and remove the next line

updated. pls take another look

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

willtsai · 2024-07-24T16:31:55Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+
+This how-to guide will describe how to:
+
+- Configure a custom Terraform Provider and use it in a Terraform recipe.


Should there also be a bullet point indicating that they will configure credentials for the terraform provider?

willtsai · 2024-07-24T16:33:25Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+
+{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}}
+
+> In this example, we're creating a secret with keys `username` and `password` as sensitive inputs required by the Terraform Provider `cyrilgdn/postgresql`.


Can you also explain what exactly this "sensitive data" is used for? I'm assuming it's to authenticate into the postgresql provider but would be good to clarify and maybe even link to any of their documentation on authentication.

Suggested change

> In this example, we're creating a secret with keys `username` and `password` as sensitive inputs required by the Terraform Provider `cyrilgdn/postgresql`.

> In this example, we're creating a secret with keys `username` and `password` as sensitive data required by the Terraform Provider `cyrilgdn/postgresql`.

updated. pls take a look. The link for official provider documentation is there in the beginning of the page. I'm not sure if we want to copy it over again here. let me know

no need to repeat, i think indicating that it's for auth is good enough

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

willtsai · 2024-07-24T16:42:22Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+```
+rad deploy ./env.bicep -p username=****** -p password=******
+```
+


should there be a note here explaining what username and password fields the reader needs to pass into this command?

added a note. Pls take a look

thank you, this looks good!

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

Reshrahim · 2024-07-24T17:22:45Z

@lakshmimsft - Can you target the PR to v0.36 ?

I'll close this and create new PR after comments are addressed. Is that okay?

willtsai

some additional corrections i missed earlier

willtsai · 2024-07-24T23:08:48Z

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

+```
+rad deploy ./env.bicep -p username=****** -p password=******
+```
+


thank you, this looks good!

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

willtsai

approved from my side, but might want @Reshrahim to take a look as well

Reshrahim

Looks good to me. Have a small suggestion

docs/content/guides/recipes/terraform/howto-custom-provider/index.md

Reshrahim

LGTM

* add howto doc for tf custom provider config * unsaved files * update per comments * update for conflicts * extra space * extra space * further comments * capitalizing Environment * one more change --------- Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com>

* add howto doc for tf custom provider config * unsaved files * update per comments * update for conflicts * extra space * extra space * further comments * capitalizing Environment * one more change --------- Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Signed-off-by: sk593 <shruthikumar@microsoft.com>

* Update docs for v0.36.0 Signed-off-by: sk593 <shruthikumar@microsoft.com> * Update auto-generated documentation (#1151) * Autogenerate reference docs Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: sk593 <shruthikumar@microsoft.com> * Add HowTo tutorial to configure Terraform Custom Provider (#1162) * add howto doc for tf custom provider config * unsaved files * update per comments * update for conflicts * extra space * extra space * further comments * capitalizing Environment * one more change --------- Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Signed-off-by: sk593 <shruthikumar@microsoft.com> * correct highlight (#1164) Signed-off-by: sk593 <shruthikumar@microsoft.com> * Update index.md (#1160) Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: sk593 <shruthikumar@microsoft.com> * Add envSecrets block to HowTo Custom Provider tutorial (#1166) * adding envSecrets * updated per suggestion Signed-off-by: sk593 <shruthikumar@microsoft.com> * removing port input in config (#1167) Signed-off-by: sk593 <shruthikumar@microsoft.com> * revert Signed-off-by: sk593 <shruthikumar@microsoft.com> * fix spellcheck Signed-off-by: sk593 <shruthikumar@microsoft.com> * Update docs/layouts/partials/hooks/body-end.html Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: sk593 <shruthikumar@microsoft.com> Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Co-authored-by: Radius CI Bot <radiuscoreteam@service.microsoft.com> Co-authored-by: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Co-authored-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com>

* Update docs for v0.36.0 * Update auto-generated documentation (#1151) * Autogenerate reference docs Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * Add HowTo tutorial to configure Terraform Custom Provider (#1162) * add howto doc for tf custom provider config * unsaved files * update per comments * update for conflicts * extra space * extra space * further comments * capitalizing Environment * one more change --------- Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> * correct highlight (#1164) * Update index.md (#1160) Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * Add envSecrets block to HowTo Custom Provider tutorial (#1166) * adding envSecrets * updated per suggestion * removing port input in config (#1167) * Fix upmerge workflow error when no changes (#1192) Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> * addressing comments Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com> * addressing comments Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com> --------- Signed-off-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com> Co-authored-by: Radius CI Bot <radiuscoreteam@service.microsoft.com> Co-authored-by: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Co-authored-by: rad-ci-bot <rad-ci-bot@users.noreply.github.com> Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Co-authored-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>

add howto doc for tf custom provider config

4add8fe

lakshmimsft temporarily deployed to edge July 24, 2024 04:06 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to edge July 24, 2024 04:07 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to edge July 24, 2024 05:06 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to edge July 24, 2024 05:07 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 5d9710c to 3b49a12 Compare July 24, 2024 05:27

lakshmimsft temporarily deployed to edge July 24, 2024 05:27 — with GitHub Actions Inactive

unsaved files

b492f4a

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 3b49a12 to b492f4a Compare July 24, 2024 05:27

lakshmimsft temporarily deployed to edge July 24, 2024 05:27 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to edge July 24, 2024 05:28 — with GitHub Actions Inactive

Reshrahim requested changes Jul 24, 2024

View reviewed changes

willtsai requested changes Jul 24, 2024

View reviewed changes

lakshmimsft temporarily deployed to edge July 24, 2024 18:01 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from c546958 to 63ea5d8 Compare July 24, 2024 18:02

lakshmimsft temporarily deployed to edge July 24, 2024 18:03 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 63ea5d8 to 6730150 Compare July 24, 2024 18:05

lakshmimsft temporarily deployed to edge July 24, 2024 18:06 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 6730150 to 8c70459 Compare July 24, 2024 18:07

lakshmimsft temporarily deployed to edge July 24, 2024 18:08 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 8c70459 to 60f1566 Compare July 24, 2024 18:14

lakshmimsft temporarily deployed to edge July 24, 2024 18:15 — with GitHub Actions Inactive

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 60f1566 to 161a733 Compare July 24, 2024 18:18

lakshmimsft temporarily deployed to edge July 24, 2024 18:19 — with GitHub Actions Inactive

lakshmimsft marked this pull request as ready for review July 24, 2024 18:21

lakshmimsft requested review from a team as code owners July 24, 2024 18:21

update per comments

150c991

lakshmimsft force-pushed the lakshmimsft/howtocustomtfprovider branch from 161a733 to 150c991 Compare July 24, 2024 18:39

lakshmimsft temporarily deployed to latest July 24, 2024 21:49 — with GitHub Actions Inactive

willtsai reviewed Jul 24, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

willtsai reviewed Jul 24, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

further comments

967b4d9

lakshmimsft temporarily deployed to latest July 24, 2024 23:23 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to latest July 24, 2024 23:24 — with GitHub Actions Inactive

willtsai reviewed Jul 24, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

willtsai reviewed Jul 24, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

willtsai reviewed Jul 24, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

capitalizing Environment

db45625

lakshmimsft temporarily deployed to latest July 24, 2024 23:32 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to latest July 24, 2024 23:33 — with GitHub Actions Inactive

willtsai approved these changes Jul 24, 2024

View reviewed changes

Reshrahim requested changes Jul 25, 2024

View reviewed changes

docs/content/guides/recipes/terraform/howto-custom-provider/index.md Outdated Show resolved Hide resolved

lakshmimsft temporarily deployed to latest July 25, 2024 13:48 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to latest July 25, 2024 13:51 — with GitHub Actions Inactive

one more change

eec5e55

lakshmimsft temporarily deployed to latest July 25, 2024 16:30 — with GitHub Actions Inactive

lakshmimsft temporarily deployed to latest July 25, 2024 16:31 — with GitHub Actions Inactive

Reshrahim approved these changes Jul 25, 2024

View reviewed changes

Reshrahim merged commit d5c5e91 into radius-project:v0.36 Jul 25, 2024
9 checks passed

Reshrahim temporarily deployed to latest July 25, 2024 16:35 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HowTo tutorial to configure Terraform Custom Provider #1162

Add HowTo tutorial to configure Terraform Custom Provider #1162

lakshmimsft commented Jul 24, 2024

Reshrahim left a comment

Reshrahim Jul 24, 2024 •

edited by willtsai

Loading

willtsai Jul 24, 2024

lakshmimsft Jul 24, 2024

Reshrahim Jul 24, 2024

lakshmimsft Jul 24, 2024

willtsai Jul 24, 2024

willtsai Jul 24, 2024

lakshmimsft Jul 24, 2024

willtsai Jul 24, 2024

willtsai Jul 24, 2024

lakshmimsft Jul 24, 2024

willtsai Jul 24, 2024

Reshrahim commented Jul 24, 2024 •

edited by lakshmimsft

Loading

willtsai left a comment

willtsai Jul 24, 2024

willtsai left a comment

Reshrahim left a comment

Reshrahim left a comment


		This how-to guide will describe how to:

		- Configure a custom Terraform Provider and use it in a Terraform recipe.

	- Configure a custom Terraform Provider and use it in a Terraform recipe.
	- Configure a custom [Terraform provider](https://registry.terraform.io/browse/providers) in a Radius environment
	- Consume the terraform modules from a custom Terraform provider and use it in a Terraform recipe.

	In this example we're going to configure a PostgreSQL Terraform provider in a Radius environment and deploy a recipe.
	In this example we're going to configure a [PostgreSQL Terraform provider](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs) in a Radius environment and deploy a recipe.


		{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}}

		> In this example, we're creating a secret with keys `username` and `password` as sensitive inputs required by the Terraform Provider `cyrilgdn/postgresql`.

Add HowTo tutorial to configure Terraform Custom Provider #1162

Add HowTo tutorial to configure Terraform Custom Provider #1162

Conversation

lakshmimsft commented Jul 24, 2024

Description

6539

Reshrahim left a comment

Choose a reason for hiding this comment

Reshrahim Jul 24, 2024 • edited by willtsai Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Reshrahim commented Jul 24, 2024 • edited by lakshmimsft Loading

willtsai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willtsai left a comment

Choose a reason for hiding this comment

Reshrahim left a comment

Choose a reason for hiding this comment

Reshrahim left a comment

Choose a reason for hiding this comment

Reshrahim Jul 24, 2024 •

edited by willtsai

Loading

Reshrahim commented Jul 24, 2024 •

edited by lakshmimsft

Loading