Skip to content

Commit

Permalink
docs: update troubleshooting guide and add parallelism settings (#245)
Browse files Browse the repository at this point in the history
# πŸ“₯ Pull Request

## ❓ What are you trying to address

This pull request includes changes to improve Terraform execution
parallelism and documentation updates. The most important changes
include setting Terraform CLI arguments for parallelism, updating
troubleshooting guides, and correcting a documentation typo.

Terraform execution improvements:

*
[`Taskfile.yml`](diffhunk://#diff-cd2d359855d0301ce190f1ec3b4c572ea690c83747f6df61c9340720e3d2425eR26-R28):
Added `TF_CLI_ARGS_plan`, `TF_CLI_ARGS_apply`, and `TF_CLI_ARGS_destroy`
to set parallelism to 3 for Terraform operations.

Documentation updates:

*
[`docs/guides/troubleshooting.md`](diffhunk://#diff-05fa5078290d9319b91e520b8d624cd018e97d963be0d0e1cd22ca7e37e899e9L58-R59):
Added a suggestion to change Terraform parallelism to a lower number
than the default (10) to help with long-running operations.
*
[`templates/guides/troubleshooting.md`](diffhunk://#diff-05fa5078290d9319b91e520b8d624cd018e97d963be0d0e1cd22ca7e37e899e9L58-R59):
Renamed the file and added a similar suggestion to change Terraform
parallelism.

Typo correction:

*
[`docs/index.md`](diffhunk://#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6L107-R107):
Corrected the section title from "Know limitations" to "Known
limitations."
*
[`templates/index.md.tmpl`](diffhunk://#diff-2787aac6ad1510c9157d238b7b366aa4a6abdeba2429c28affad380e0bd3df26L53-R53):
Corrected the section title from "Know limitations" to "Known
limitations."
  • Loading branch information
DariuszPorowski authored Feb 12, 2025
1 parent 5ba6f57 commit 4ee651a
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
4 changes: 4 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ vars:

env:
FABRIC_PREVIEW: true
TFE_PARALLELISM: 3
TF_CLI_ARGS_plan: "-parallelism=3"
TF_CLI_ARGS_apply: "-parallelism=3"
TF_CLI_ARGS_destroy: "-parallelism=3"

tasks:
# ----------------------
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ For more information about Terraform logging, see [Debugging Terraform](https://

You can observe some Terraform operations take time to complete with the messages like `Still creating...`, `Still reading...`, etc. or end up with a timeout error. This can happen due to various reasons such as network latency or [Fabric API throttling](https://learn.microsoft.com/rest/api/fabric/articles/throttling).

Try to increase the global timeout for the operations by setting the [`timeout`](../index.md#timeout) attribute in the Provider block, or you can set the timeout for the specific Resource or Data-Source using the `timeouts` attribute.
- Try to increase the global timeout for the operations by setting the [`timeout`](../index.md#timeout) attribute in the Provider block, or you can set the timeout for the specific Resource or Data-Source using the `timeouts` attribute.
- Change [Terraform parallelism](https://developer.hashicorp.com/terraform/internals/graph#walking-the-graph) to lower number than default (10x).
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ You can find more information on how to do this in the following guides:
- `use_msi` (Boolean) Allow Managed Service Identity (MSI) to be used for authentication.
- `use_oidc` (Boolean) Allow OpenID Connect to be used for authentication.

## Know limitations
## Known limitations

- **Capacity**: [Microsoft Fabric trial capacity](https://learn.microsoft.com/fabric/get-started/fabric-trial) is not supported. Only self-provisioned [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/plan-capacity) on Azure is supported. You can setup your capacity in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities).
- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](guides/auth_app_reg_user.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ For more information about Terraform logging, see [Debugging Terraform](https://

You can observe some Terraform operations take time to complete with the messages like `Still creating...`, `Still reading...`, etc. or end up with a timeout error. This can happen due to various reasons such as network latency or [Fabric API throttling](https://learn.microsoft.com/rest/api/fabric/articles/throttling).

Try to increase the global timeout for the operations by setting the [`timeout`](../index.md#timeout) attribute in the Provider block, or you can set the timeout for the specific Resource or Data-Source using the `timeouts` attribute.
- Try to increase the global timeout for the operations by setting the [`timeout`](../index.md#timeout) attribute in the Provider block, or you can set the timeout for the specific Resource or Data-Source using the `timeouts` attribute.
- Change [Terraform parallelism](https://developer.hashicorp.com/terraform/internals/graph#walking-the-graph) to lower number than default (10x).
2 changes: 1 addition & 1 deletion templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can find more information on how to do this in the following guides:

{{ .SchemaMarkdown | trimspace }}

## Know limitations
## Known limitations

- **Capacity**: [Microsoft Fabric trial capacity](https://learn.microsoft.com/fabric/get-started/fabric-trial) is not supported. Only self-provisioned [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/plan-capacity) on Azure is supported. You can setup your capacity in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities).
- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](guides/auth_app_reg_user.md).
Expand Down

0 comments on commit 4ee651a

Please sign in to comment.