Skip to content

Commit d1bcf08

Browse files
avnerenv0avnerenv0
committed
adding auto-generated docs
1 parent 7a0b9ae commit d1bcf08

File tree

13 files changed

+353
-0
lines changed

13 files changed

+353
-0
lines changed

‎docs/data-sources/configuration_variable.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_configuration_variable Data Source - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_configuration_variable (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **deployment_log_id** (String) search for the variable under this deployment log, not globally
21+
- **environment_id** (String) search for the variable under this environment, not globally
22+
- **id** (String) id of the configuration variable
23+
- **name** (String) the name of the configuration variable
24+
- **project_id** (String) search for the variable under this project, not globally
25+
- **template_id** (String) search for the variable under this template, not globally
26+
- **type** (String) 'terraform' or 'environment'. If specified as an argument, limits searching by variable name only to variables of this type.
27+
28+
### Read-Only
29+
30+
- **is_sensitive** (Boolean) is the variable defined as sensitive
31+
- **scope** (String) scope of the variable
32+
- **value** (String) value stored in the variable
33+
34+

‎docs/data-sources/organization.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_organization Data Source - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_organization (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **id** (String) The ID of this resource.
21+
22+
### Read-Only
23+
24+
- **created_by** (String) textual description of the entity who created the organization
25+
- **is_self_hosted** (Boolean) is the organization self hosted
26+
- **name** (String) the name of the organization
27+
- **role** (String) role of the authenticated user (through api key) in the organization
28+
29+

‎docs/data-sources/project.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_project Data Source - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_project (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **id** (String) id of the project
21+
- **name** (String) the name of the project
22+
23+
### Read-Only
24+
25+
- **created_by** (String) textual description of the entity who created the project
26+
- **role** (String) role of the authenticated user (through api key) in the project
27+
28+

‎docs/data-sources/ssh_key.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_ssh_key Data Source - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_ssh_key (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **id** (String) id of the ssh key
21+
- **name** (String) the name of the ssh key
22+
23+

‎docs/data-sources/template.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_template Data Source - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_template (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **github_installation_id** (Number) The env0 application installation id on the relevant github repository
21+
- **id** (String) id of the template
22+
- **name** (String) the name of the template
23+
24+
### Read-Only
25+
26+
- **path** (String) terraform / terrgrunt folder inside source code repository
27+
- **project_ids** (List of String) which projects may access this template (id of project)
28+
- **repository** (String) template source code repository url
29+
- **retries_on_deploy** (Number) number of times to retry when deploying an environment based on this template
30+
- **retries_on_destroy** (Number) number of times to retry when destroying an environment based on this template
31+
- **retry_on_deploy_only_when_matches_regex** (String) if specified, will only retry (on deploy) if error matches specified regex
32+
- **retry_on_destroy_only_when_matches_regex** (String) if specified, will only retry (on destroy) if error matches specified regex
33+
- **revision** (String) source code revision (branch / tag) to use
34+
- **ssh_keys** (List of Map of String) which ssh keys are used for accessing git over ssh
35+
- **type** (String) 'terraform' or 'terragrunt'
36+
37+

‎docs/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0 Provider"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0 Provider
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- **api_endpoint** (String) override api endpoint (used for testing)
21+
- **api_key** (String, Sensitive) env0 api key (https://docs.env0.com/reference#authentication)
22+
- **api_secret** (String, Sensitive) env0 api key secret

‎docs/resources/configuration_variable.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_configuration_variable Resource - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_configuration_variable (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) name to give the configuration variable
21+
- **value** (String) value for the configuration variable
22+
23+
### Optional
24+
25+
- **enum** (List of String) limit possible values to values from this list
26+
- **environment_id** (String) create the variable under this environment, not globally
27+
- **id** (String) The ID of this resource.
28+
- **is_sensitive** (Boolean) is the variable sensitive, defaults to false
29+
- **project_id** (String) create the variable under this project, not globally
30+
- **template_id** (String) create the variable under this template, not globally
31+
- **type** (String) default 'environment'. set to 'terraform' to create a terraform variable
32+
33+

‎docs/resources/project.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_project Resource - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_project (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) name to give the project
21+
22+
### Read-Only
23+
24+
- **id** (String) id of the project
25+
26+

‎docs/resources/ssh_key.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_ssh_key Resource - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_ssh_key (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) name to give the ssh key
21+
- **value** (String) value is a private key in PEM format (first line usually looks like -----BEGIN OPENSSH PRIVATE KEY-----)
22+
23+
### Optional
24+
25+
- **id** (String) The ID of this resource.
26+
27+

‎docs/resources/template.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "env0_template Resource - terraform-provider-env0"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# env0_template (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) name to give the template
21+
- **repository** (String) git repository for the template source code
22+
23+
### Optional
24+
25+
- **description** (String) description for the template
26+
- **github_installation_id** (Number) The env0 application installation id on the relevant github repository
27+
- **id** (String) The ID of this resource.
28+
- **path** (String) terraform / terragrunt file folder inside source code
29+
- **project_ids** (List of String) which projects may access this template (id of project)
30+
- **retries_on_deploy** (Number) number of times to retry when deploying an environment based on this template
31+
- **retries_on_destroy** (Number) number of times to retry when destroying an environment based on this template
32+
- **retry_on_deploy_only_when_matches_regex** (String) if specified, will only retry (on deploy) if error matches specified regex
33+
- **retry_on_destroy_only_when_matches_regex** (String) if specified, will only retry (on destroy) if error matches specified regex
34+
- **revision** (String) source code revision (branch / tag) to use
35+
- **ssh_keys** (List of Map of String) an array of references to 'data_ssh_key' to use when accessing git over ssh
36+
- **type** (String) 'terraform' or 'terragrunt'
37+
38+

0 commit comments

Comments
 (0)