From ba74475f66d39d364924c49f867709c7e8679512 Mon Sep 17 00:00:00 2001 From: update generated docs action Date: Wed, 13 Dec 2023 14:00:14 +0000 Subject: [PATCH] Update docs --- docs/data-sources/agent_values.md | 13 +++++++++++ docs/data-sources/agents.md | 10 +++++++++ docs/data-sources/aws_cost_credentials.md | 10 +++++++++ docs/data-sources/aws_credentials.md | 10 +++++++++ docs/data-sources/azure_cost_credentials.md | 10 +++++++++ docs/data-sources/azure_credentials.md | 10 +++++++++ docs/data-sources/cloud_credentials.md | 2 +- docs/data-sources/custom_flow.md | 10 +++++++++ docs/data-sources/gcp_credentials.md | 10 +++++++++ docs/data-sources/google_cost_credentials.md | 10 +++++++++ docs/data-sources/gpg_key.md | 10 +++++++++ docs/data-sources/project_policy.md | 10 +++++++++ docs/data-sources/provider.md | 6 +++++ docs/data-sources/team.md | 10 +++++++++ docs/resources/approval_policy_assignment.md | 22 ++++++++++++++++++- docs/resources/aws_cost_credentials.md | 17 ++++++++++++++ docs/resources/azure_cost_credentials.md | 21 +++++++++++++++++- .../cost_credentials_project_assignment.md | 21 +++++++++++++++++- docs/resources/custom_flow.md | 22 +++++++++++++++++++ docs/resources/gcp_cost_credentials.md | 17 ++++++++++++++ .../notification_project_assignment.md | 20 ++++++++++++++++- 21 files changed, 266 insertions(+), 5 deletions(-) diff --git a/docs/data-sources/agent_values.md b/docs/data-sources/agent_values.md index 6e835461..f585208e 100644 --- a/docs/data-sources/agent_values.md +++ b/docs/data-sources/agent_values.md @@ -10,7 +10,20 @@ description: |- +## Example Usage +```terraform +resource "env0_project" "project" { + name = "project" +} + +data "env0_agents" "agents" {} + +resource "env0_agent_project_assignment" "gent_project_assignment" { + agent_id = data.env0_agents.agents.0.agent_key + project_id = env0_project.project.id +} +``` ## Schema diff --git a/docs/data-sources/agents.md b/docs/data-sources/agents.md index 6c5f373c..fe64d891 100644 --- a/docs/data-sources/agents.md +++ b/docs/data-sources/agents.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_agent_values" "agent_values" { + agent_key = "pr12" +} + +output "values" { + value = data.env0_agent_values.agent_values.values +} +``` ## Schema diff --git a/docs/data-sources/aws_cost_credentials.md b/docs/data-sources/aws_cost_credentials.md index f9deaa74..fbc7d1b3 100644 --- a/docs/data-sources/aws_cost_credentials.md +++ b/docs/data-sources/aws_cost_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_aws_cost_credentials" "aws_cost_credentials_by_name" { + name = "aws cost credentials" +} + +data "env0_aws_cost_credentials" "aws_cost_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/aws_credentials.md b/docs/data-sources/aws_credentials.md index bd65c796..10f9147d 100644 --- a/docs/data-sources/aws_credentials.md +++ b/docs/data-sources/aws_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_aws_credentials" "aws_credentials_by_name" { + name = "aws credentials" +} + +data "env0_aws_credentials" "aws_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/azure_cost_credentials.md b/docs/data-sources/azure_cost_credentials.md index be3752d1..104a1c57 100644 --- a/docs/data-sources/azure_cost_credentials.md +++ b/docs/data-sources/azure_cost_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_azure_cost_credentials" "azure_cost_credentials_by_name" { + name = "azure cost credentials" +} + +data "env0_azure_cost_credentials" "azure_cost_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/azure_credentials.md b/docs/data-sources/azure_credentials.md index 56f09539..74015b09 100644 --- a/docs/data-sources/azure_credentials.md +++ b/docs/data-sources/azure_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_azure_credentials" "azure_credentials_by_name" { + name = "azure credentials" +} + +data "env0_azure_credentials" "azure_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/cloud_credentials.md b/docs/data-sources/cloud_credentials.md index ac347e5e..61a058ff 100644 --- a/docs/data-sources/cloud_credentials.md +++ b/docs/data-sources/cloud_credentials.md @@ -23,7 +23,7 @@ data "env0_aws_credentials" "aws_credentials" { } output "credentials_name" { - value = var.second_run ? data.env0_aws_credentials.aws_credentials["Test Role arn1"].name : "" + value = data.env0_aws_credentials.aws_credentials["Test Role arn1"].name } ``` diff --git a/docs/data-sources/custom_flow.md b/docs/data-sources/custom_flow.md index 7bcd7527..afee3445 100644 --- a/docs/data-sources/custom_flow.md +++ b/docs/data-sources/custom_flow.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_custom_flow" "custom_flow_by_name" { + name = "custom flow 12345" +} + +data "env0_custom_flow" "custom_flow_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/gcp_credentials.md b/docs/data-sources/gcp_credentials.md index 164f5d5e..a74cb3f2 100644 --- a/docs/data-sources/gcp_credentials.md +++ b/docs/data-sources/gcp_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_gcp_credentials" "gcp_credentials_by_name" { + name = "gcp credentials" +} + +data "env0_gcp_credentials" "gcp_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/google_cost_credentials.md b/docs/data-sources/google_cost_credentials.md index 473ca0d7..3a46c41d 100644 --- a/docs/data-sources/google_cost_credentials.md +++ b/docs/data-sources/google_cost_credentials.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_google_cost_credentials" "google_cost_credentials_by_name" { + name = "google cost credentials" +} + +data "env0_google_cost_credentials" "google_cost_credentials_by_id" { + id = "12345676safsd" +} +``` ## Schema diff --git a/docs/data-sources/gpg_key.md b/docs/data-sources/gpg_key.md index cce705bf..69c5c98b 100644 --- a/docs/data-sources/gpg_key.md +++ b/docs/data-sources/gpg_key.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_gpg_key" "gpg_key_by_name" { + name = "gpg key fegsdfg" +} + +data "env0_gpg_key" "gpg_key_by_id" { + id = "sdfsdxcvxc-sdfsd-fsdfsd-dsda" +} +``` ## Schema diff --git a/docs/data-sources/project_policy.md b/docs/data-sources/project_policy.md index b99fd06e..1de4021e 100644 --- a/docs/data-sources/project_policy.md +++ b/docs/data-sources/project_policy.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_project" "project" { + name = "project" +} + +data "env0_project_policy" "project_policy" { + project_id = data.env0_project.project.id +} +``` ## Schema diff --git a/docs/data-sources/provider.md b/docs/data-sources/provider.md index e33525fe..2b8efcf5 100644 --- a/docs/data-sources/provider.md +++ b/docs/data-sources/provider.md @@ -10,7 +10,13 @@ description: |- +## Example Usage +```terraform +data "env0_provider" "provider" { + id = "adsdasdasd-asdasdas" +} +``` ## Schema diff --git a/docs/data-sources/team.md b/docs/data-sources/team.md index c90e408e..ec33c150 100644 --- a/docs/data-sources/team.md +++ b/docs/data-sources/team.md @@ -10,7 +10,17 @@ description: |- +## Example Usage +```terraform +data "env0_team" "by_id" { + id = "asdasdas-asdas-dasdsa" +} + +data "env0_team" "by_name" { + name = "team-12345" +} +``` ## Schema diff --git a/docs/resources/approval_policy_assignment.md b/docs/resources/approval_policy_assignment.md index 4808cdcb..819d0fbc 100644 --- a/docs/resources/approval_policy_assignment.md +++ b/docs/resources/approval_policy_assignment.md @@ -10,7 +10,27 @@ description: |- - +## Example Usage + +```terraform +data "env0_project" "project" { + name = "project" +} + +resource "env0_approval_policy" "approval_policy" { + name = "approval policy" + repository = "reopository" + github_installation_id = 4234234234 + path = "misc/null-resource" + +} + +resource "env0_approval_policy_assignment" "approval_policy_assignment" { + scope = "PROJECT" + scope_id = data.env0_project.project.id + blueprint_id = env0_approval_policy.approval_policy.id +} +``` ## Schema diff --git a/docs/resources/aws_cost_credentials.md b/docs/resources/aws_cost_credentials.md index f91af3a5..f07e23c0 100644 --- a/docs/resources/aws_cost_credentials.md +++ b/docs/resources/aws_cost_credentials.md @@ -10,7 +10,15 @@ description: |- +## Example Usage +```terraform +resource "env0_aws_cost_credentials" "aws_cost_credentials" { + name = "cost credentials" + arn = "arn" + duration = 3600 +} +``` ## Schema @@ -27,3 +35,12 @@ description: |- ### Read-Only - `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_aws_cost_credentials.by_id d31a6b30-5f69-4d24-937c-22322754934e +terraform import env0_aws_cost_credentials.by_name "cost credentials name" +``` diff --git a/docs/resources/azure_cost_credentials.md b/docs/resources/azure_cost_credentials.md index 9c7ec01f..94af605d 100644 --- a/docs/resources/azure_cost_credentials.md +++ b/docs/resources/azure_cost_credentials.md @@ -10,7 +10,17 @@ description: |- - +## Example Usage + +```terraform +resource "env0_azure_cost_credentials" "azure_cost_credentials" { + name = "cost credentials" + client_id = "client id" + client_secret = "client secret" + subscription_id = "43242342dsdfsdfsdf" + tenant_id = "fsdf-fsdfdsfs-fsdfsdfsd-fsdfsd" +} +``` ## Schema @@ -26,3 +36,12 @@ description: |- ### Read-Only - `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_azure_cost_credentials.by_id d31a6b30-5f69-4d24-937c-22322754934e +terraform import env0_azure_cost_credentials.by_name "cost credentials name" +``` diff --git a/docs/resources/cost_credentials_project_assignment.md b/docs/resources/cost_credentials_project_assignment.md index ff157e54..027fa6fc 100644 --- a/docs/resources/cost_credentials_project_assignment.md +++ b/docs/resources/cost_credentials_project_assignment.md @@ -10,7 +10,26 @@ description: |- - +## Example Usage + +```terraform +resource "env0_azure_cost_credentials" "azure_cost_credentials" { + name = "cost credentials" + client_id = "client id" + client_secret = "client secret" + subscription_id = "43242342dsdfsdfsdf" + tenant_id = "fsdf-fsdfdsfs-fsdfsdfsd-fsdfsd" +} + +resource "env0_project" "project" { + name = "project" +} + +resource "env0_cost_credentials_project_assignment" "cost_project_assignment" { + credential_id = env0_azure_cost_credentials.azure_cost_credentials.id + project_id = env0_project.project.id +} +``` ## Schema diff --git a/docs/resources/custom_flow.md b/docs/resources/custom_flow.md index 587667db..b7c5dcea 100644 --- a/docs/resources/custom_flow.md +++ b/docs/resources/custom_flow.md @@ -10,7 +10,20 @@ description: |- +## Example Usage +```terraform +data "env0_template" "github_template" { + name = "github_template" +} + +resource "env0_custom_flow" "custom_flow" { + name = "Custom Flow" + repository = data.env0_template.github_template.repository + github_installation_id = data.env0_template.github_template.github_installation_id + path = "custom-flows/opa.yaml" +} +``` ## Schema @@ -38,3 +51,12 @@ description: |- ### Read-Only - `id` (String) id of the custom flow + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_custom_flow.by_id 29b8037a-f877-48f5-a60b-3152ae1a1405 +terraform import env0_custom_flow.by_name custom-flow-name +``` diff --git a/docs/resources/gcp_cost_credentials.md b/docs/resources/gcp_cost_credentials.md index 9074bfed..e9983885 100644 --- a/docs/resources/gcp_cost_credentials.md +++ b/docs/resources/gcp_cost_credentials.md @@ -10,7 +10,15 @@ description: |- +## Example Usage +```terraform +resource "env0_gcp_cost_credentials" "gcp_cost_credentials" { + name = "cost credentials" + table_id = "table id" + secret = "sdfsdfsdfsd" +} +``` ## Schema @@ -24,3 +32,12 @@ description: |- ### Read-Only - `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_gcp_cost_credentials.by_id d31a6b30-5f69-4d24-937c-22322754934e +terraform import env0_gcp_cost_credentials.by_name "cost credentials name" +``` diff --git a/docs/resources/notification_project_assignment.md b/docs/resources/notification_project_assignment.md index 26cd2138..0a122ecc 100644 --- a/docs/resources/notification_project_assignment.md +++ b/docs/resources/notification_project_assignment.md @@ -10,7 +10,25 @@ description: |- - +## Example Usage + +```terraform +resource "env0_notification" "notification" { + name = "notification" + type = "Slack" + value = "https://someurl.com" +} + +resource "env0_project" "project" { + name = "project" +} + +resource "env0_notification_project_assignment" "notification_project_assignment" { + project_id = env0_project.project.id + notification_endpoint_id = env0_notification.notification.id + event_names = ["environmentMarkedForAutoDestroy"] +} +``` ## Schema