Infrastructure as Code via Terraform #28

lechnerc77 · 2023-01-21T10:45:24Z

Purpose

This Pr provides the changes in the repo to enable a setup of the infrastructure via Terraform as alternative to Bicep
See also issue [FEATURE] Add Terraform as IaC option #27

Does this introduce a breaking change?

[ ] Yes
[X] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[X] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

How to Test

Test the code

Open the Terraform Workspace
Execute azd up

Alternative:

Open the Terraform Workspace
Execute azd up

What to Check

Verify that the following are valid

The Infrastructure and the app are deployed to Azure

Other Information

closes #27

lechnerc77 · 2023-01-22T16:14:44Z

In case of successful review, please do a squash&merge as the commit history has no value for the provided content

MartinPankraz · 2023-01-23T13:11:08Z

README.md

 1. via template deployment and VS Code extension. This approach allows an quick deployment to Azure but does not necessarily reflect the best practices. You find more information on this option [here](documentation/DEPLOYMENT-VSCODE.md).
 2. via [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) using `azd up`. This approach enables a quick and easy deployment and already contains best practices. It serves as a perfect starting point for a production grade setup. You find more information on this option [here](documentation/DEPLOYMENT-AZD.md).

+> **Note** - If you choose to deploy to Azure via `azd` we provide two options to define the infrastructure as code, namely `Bicep` and `Terraform`. To make your life easier we provide two distinct [workspaces](https://code.visualstudio.com/docs/editor/workspaces#_multiroot-workspaces) for that to show you the relevant files and folders. If you want to go for `Bicep` you can open the workspace `workspaces/azd-bicep.code-workspace`, for Terraform go for the workspace `workspaces/azd-terraform.code-workspace`.


Can we make the bicep workspace flavor default somehow? Would make things easier on first run with gh codespaces and vsc.

Seems like no easy way present at the moment: microsoft/vscode#161414

I checked the documentation and did not find a way to define one workspace as default, neither via the workspace files nor via a vscode configuration we could attach.

MartinPankraz · 2023-01-23T13:13:28Z

documentation/DEPLOYMENT-AZD-TERRAFORM.md

+
+## Mind the differences
+
+The Terraform-based setup in the `azd` was introduced a later than the òne using Bicep. Due to that and due to the differences between them, some things work differently. Here are two things that we think are worth to mention.


typo the "one"

Fixed with commit c59ed5b

MartinPankraz · 2023-01-23T13:17:03Z

documentation/DEPLOYMENT-AZD.md


 Our setup follows those defaults and there no explicit configuration is necessary.

 ## Infrastructure as Code - alternatives


"alternatives" in the titel sounds as if there is an additional default path. How about dropping it? And maybe a sentence on bicep being default for azd.

Fixed with commit c59ed5b

MartinPankraz · 2023-01-23T13:46:29Z

add alwaysOn: false to bicep config too: https://azure.github.io/PSRule.Rules.Azure/rules/Azure.AppService.AlwaysOn/

MartinPankraz · 2023-01-23T15:01:44Z

@lechnerc77 azure cli dependency for terraform requires us to bring it back in after azd dropped it.

MartinPankraz

azure cli dependency for terraform deployment showed up while testing from gh codespace. Likely present in your local environment?

MartinPankraz · 2023-01-23T15:19:54Z

When adding azure cli to the gh codespace manually and re-iterating "azd up" leads to login prompt for azure cli as well as challenge with interactive login:

lechnerc77 · 2023-01-24T13:04:07Z

add alwaysOn: false to bicep config too: https://azure.github.io/PSRule.Rules.Azure/rules/Azure.AppService.AlwaysOn/

The PR already contains that change: https://github.com/Azure-Samples/app-service-javascript-sap-cloud-sdk-quickstart/pull/28/files#diff-83ad425a33f54d795513559dc5a18919b499e1377d3e018be27eb15e2f7170caR19

lechnerc77 · 2023-01-24T13:15:39Z

Added a discussion in the Azure Developer CLI repo to check if we need additional config for Terraform login flow:Azure/azure-dev#1448 (comment)

lechnerc77 · 2023-01-28T09:40:37Z

Enhanced the terraform instructions wrt to Azure CLI login flow in commit <Fixed with commit c59ed5b>

MartinPankraz · 2023-01-30T13:36:46Z

Do we still need the terraform feature in the default dev container, when the template is anticipated to make the switch?

MartinPankraz · 2023-01-30T13:42:17Z

Moved devcontainer.json.azcli and executed 'azd config set auth.useAzCliAuth true' but still having login issues with azd login and az login likewise.

lechnerc77 · 2023-01-30T13:47:13Z

Do we still need the terraform feature in the default dev container, when the template is anticipated to make the switch?

You are right, fixed this with commit 73d0301

lechnerc77 · 2023-02-04T16:14:26Z

Additional info: using az login in Codespaces causes issues (not an issue with azd but with login flow of Azure CLI). See these issues:

@MartinPankraz Can you verify that the workaround with exchanging the localhost redirect works?

lechnerc77 · 2023-02-04T16:46:58Z

Added health endpoint configuration with commit 08f039b

Fixes issue #34 for Terraform as IaC provider

lechnerc77 · 2023-02-05T10:44:07Z

As some changes require a local modified copy of the azd core modules, I opened PRs that would sync the change to the azd core templates:

Enhancement of Terraform modules for App Service - Enable free plan Azure/azure-dev#1496
Azure App Service - Enhancement to specify health check endpoint Azure/azure-dev#1497

If accepted and merged, we can remove our local copy of the modules.

lechnerc77 · 2023-02-10T14:57:25Z

@MartinPankraz : As discussed I added a disclaimer for the usage of codespaces in combination with the Terraform provider for Azure.

MartinPankraz

approved

initial terraform setup

5e505c1

lechnerc77 added the enhancement New feature or request label Jan 21, 2023

lechnerc77 added this to the vNext 2.0 milestone Jan 21, 2023

lechnerc77 self-assigned this Jan 21, 2023

lechnerc77 added 4 commits January 22, 2023 14:59

update terraform

bc030bc

bug fixes Terraform, workspaces

edbfa4d

finalization Terraform setup

dc7f46a

finalized documentation for Terraform

d1bb056

lechnerc77 marked this pull request as ready for review January 22, 2023 16:13

lechnerc77 requested a review from MartinPankraz January 22, 2023 16:13

MartinPankraz reviewed Jan 23, 2023

View reviewed changes

MartinPankraz requested changes Jan 23, 2023

View reviewed changes

review comments + terraform specifics

c59ed5b

Fix for devcontainer consistency

73d0301

restructuring for health endpoint

08f039b

Disclaimer for Codespaces

0f72897

MartinPankraz approved these changes Feb 10, 2023

View reviewed changes

MartinPankraz merged commit dd253ee into Azure-Samples:main Feb 10, 2023

lechnerc77 deleted the feat/iac-via-terraform branch February 10, 2023 15:25


		## Mind the differences

		The Terraform-based setup in the `azd` was introduced a later than the òne using Bicep. Due to that and due to the differences between them, some things work differently. Here are two things that we think are worth to mention.


		Our setup follows those defaults and there no explicit configuration is necessary.

		## Infrastructure as Code - alternatives

Infrastructure as Code via Terraform #28

Infrastructure as Code via Terraform #28

Uh oh!

Conversation

lechnerc77 commented Jan 21, 2023

Purpose

Does this introduce a breaking change?

Pull Request Type

How to Test

What to Check

Other Information

Uh oh!

lechnerc77 commented Jan 22, 2023

Uh oh!

MartinPankraz Jan 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lechnerc77 Jan 24, 2023

Choose a reason for hiding this comment

Uh oh!

MartinPankraz Jan 23, 2023

Choose a reason for hiding this comment

Uh oh!

lechnerc77 Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

MartinPankraz Jan 23, 2023

Choose a reason for hiding this comment

Uh oh!

lechnerc77 Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

MartinPankraz commented Jan 23, 2023

Uh oh!

MartinPankraz commented Jan 23, 2023

Uh oh!

MartinPankraz left a comment

Choose a reason for hiding this comment

Uh oh!

MartinPankraz commented Jan 23, 2023

Uh oh!

lechnerc77 commented Jan 24, 2023

Uh oh!

lechnerc77 commented Jan 24, 2023

Uh oh!

lechnerc77 commented Jan 28, 2023

Uh oh!

MartinPankraz commented Jan 30, 2023

Uh oh!

MartinPankraz commented Jan 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lechnerc77 commented Jan 30, 2023

Uh oh!

lechnerc77 commented Feb 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lechnerc77 commented Feb 4, 2023

Uh oh!

lechnerc77 commented Feb 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lechnerc77 commented Feb 10, 2023

Uh oh!

MartinPankraz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MartinPankraz Jan 23, 2023 •

edited

Loading

MartinPankraz commented Jan 30, 2023 •

edited

Loading

lechnerc77 commented Feb 4, 2023 •

edited

Loading

lechnerc77 commented Feb 5, 2023 •

edited

Loading