-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
update generated docs action
committed
Mar 17, 2024
1 parent
71032c4
commit 6525c17
Showing
1 changed file
with
86 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "env0_environment_discovery_configuration Resource - terraform-provider-env0" | ||
subcategory: "" | ||
description: |- | ||
See https://docs.env0.com/docs/environment-discovery for additional details | ||
--- | ||
|
||
# env0_environment_discovery_configuration (Resource) | ||
|
||
See https://docs.env0.com/docs/environment-discovery for additional details | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "env0_project" "project" { | ||
name = "existing-project" | ||
} | ||
resource "env0_project" "new_project" { | ||
name = "new-project" | ||
} | ||
resource "env0_environment_discovery_configuration" "example" { | ||
project_id = data.env0_project.project.id | ||
glob_pattern = "**" | ||
repository = "https://github.com/env0/templates" | ||
opentofu_version = "1.6.7" | ||
github_installation_id = 12345 | ||
} | ||
resource "env0_environment_discovery_configuration" "terragrunt_example" { | ||
project_id = env0_project.new_project.id | ||
glob_pattern = "**" | ||
repository = "https://github.com/env0/blueprints" | ||
type = "terragrunt" | ||
terraform_version = "1.7.1" | ||
terragrunt_version = "0.67.4" | ||
terragrunt_tf_binary = "terraform" | ||
github_installation_id = 12345 | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `glob_pattern` (String) the environments glob pattern. Any match to this pattern will result in an Environment creation and plan | ||
- `project_id` (String) the project id | ||
- `repository` (String) the repository to run discovery on | ||
|
||
### Optional | ||
|
||
- `auto_deploy_by_custom_glob` (String) If specified, deploy/plan on changes matching the given pattern (glob). Otherwise, deploy on template folder changes only | ||
- `bitbucket_client_key` (String) bitbucket client | ||
- `environment_placement` (String) the environment placement strategy with the project (default: 'topProject') | ||
- `github_installation_id` (Number) github repository id | ||
- `gitlab_project_id` (Number) gitlab project id | ||
- `is_azure_devops` (Boolean) set to true if azure devops is used | ||
- `is_terragrunt_run_all` (Boolean) If set to 'true', execute terragrunt commands with 'run all' | ||
- `opentofu_version` (String) the Opentofu version to use (example: 1.6.1). Setting to `latest`, the version used will be the most recent one available for OpenTofu. | ||
- `retries_on_deploy` (Number) number of times to retry when deploy fails (between 1 and 3) | ||
- `retries_on_destroy` (Number) number of times to retry when destroy fails (between 1 and 3) | ||
- `retry_on_deploy_only_when_matches_regex` (String) retry (on deploy) if error matches the specified regex | ||
- `retry_on_destroy_only_when_matches_regex` (String) retry (on destroy) if error matches the specified regex | ||
- `ssh_key_id` (String) The ssh key id that will be available during deployment | ||
- `ssh_key_name` (String) The ssh key name that will be available during deployment | ||
- `terraform_version` (String) the Terraform version to use (example: 1.7.4). Setting to `RESOLVE_FROM_TERRAFORM_CODE` defaults to the version of `terraform.required_version` during run-time (resolve from terraform code). Setting to `latest`, the version used will be the most recent one available for Terraform. | ||
- `terragrunt_tf_binary` (String) The binary to use with Terragrunt. Valid values: 'opentofu' and 'terraform' (default: 'opentofu') | ||
- `terragrunt_version` (String) the Terragrunt version to use (example: 0.52.0) | ||
- `token_id` (String) a token id to be used with 'gitlab' or 'azure_devops' | ||
- `type` (String) the infrastructure type use. Valid values: 'opentofu', 'terraform', 'terragrunt', 'workflow' (default: 'opentofu') | ||
- `workspace_naming` (String) the Workspace namimg strategy (default: 'default') | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import env0_environment_discovery_configuration.by_project_id 29b8037a-f877-48f5-a60b-3152ae1a1405 | ||
``` |