From 3e55ad51a6f69fc6135852b052dbef08b3dae9ae Mon Sep 17 00:00:00 2001 From: update generated docs action Date: Wed, 9 Aug 2023 18:47:14 +0000 Subject: [PATCH] Update docs --- docs/resources/approval_policy.md | 68 ++++++++++++++++++++ docs/resources/approval_policy_assignment.md | 31 +++++++++ docs/resources/custom_flow.md | 2 +- 3 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 docs/resources/approval_policy.md create mode 100644 docs/resources/approval_policy_assignment.md diff --git a/docs/resources/approval_policy.md b/docs/resources/approval_policy.md new file mode 100644 index 00000000..365c744c --- /dev/null +++ b/docs/resources/approval_policy.md @@ -0,0 +1,68 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "env0_approval_policy Resource - terraform-provider-env0" +subcategory: "" +description: |- + +--- + +# env0_approval_policy (Resource) + + + +## Example Usage + +```terraform +resource "env0_project" "project" { + name = "project-name" + description = "project-description" +} + +resource "env0_approval_policy" "approval-policy" { + name = "approval-policy-PROJECT-${env0_project.project.id}" + repository = "repo" + github_installation_id = 1234 +} + +resource "env0_approval_policy_assignment" "assignment" { + scope_id = env0_project.project.id + scope = "PROJECT" + blueprint_id = env0_approval_policy.approval-policy.id +} +``` + + +## Schema + +### Required + +- `name` (String) name for the approval policy +- `repository` (String) repository url for the approval policy source code + +### Optional + +- `bitbucket_client_key` (String) the bitbucket client key used for integration +- `github_installation_id` (Number) the env0 application installation id on the relevant github repository +- `gitlab_project_id` (Number) the project id of the relevant repository +- `is_azure_devops` (Boolean) true if this approval policy integrates with azure dev ops repository +- `is_bitbucket_server` (Boolean) true if this approval policy uses bitbucket server repository +- `is_github_enterprise` (Boolean) true if this approval policy uses github enterprise repository +- `is_gitlab` (Boolean) true if this approval policy integrates with gitlab repository +- `is_gitlab_enterprise` (Boolean) true if this approval policy uses gitlab enterprise repository +- `path` (String) terraform / terragrunt file folder inside source code. Should be the full path including the .yaml/.yml file +- `revision` (String) source code revision (branch / tag) to use +- `ssh_keys` (List of Map of String) an array of references to 'data_ssh_key' to use when accessing git over ssh +- `token_id` (String) the git token id to be used + +### Read-Only + +- `id` (String) id of the approval policy + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_approval_policy.by_id ddda7b30-6789-4d24-937c-22322754934e +terraform import env0_approval_policy.by_name "approval-policy-PROJECT-aaaa7b30-5784-4d24-937c-223227541111" +``` diff --git a/docs/resources/approval_policy_assignment.md b/docs/resources/approval_policy_assignment.md new file mode 100644 index 00000000..e2174965 --- /dev/null +++ b/docs/resources/approval_policy_assignment.md @@ -0,0 +1,31 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "env0_approval_policy_assignment Resource - terraform-provider-env0" +subcategory: "" +description: |- + +--- + +# env0_approval_policy_assignment (Resource) + + + + + + +## Schema + +### Required + +- `blueprint_id` (String) the id of the approval policy +- `scope_id` (String) the id of the scope (E.g. project id) + +### Optional + +- `scope` (String) the type of the scope. Valid values: PROJECT. Default value: PROJECT + +### Read-Only + +- `id` (String) The ID of this resource. + + diff --git a/docs/resources/custom_flow.md b/docs/resources/custom_flow.md index 96351125..e2017a31 100644 --- a/docs/resources/custom_flow.md +++ b/docs/resources/custom_flow.md @@ -17,7 +17,7 @@ description: |- ### Required -- `name` (String) name for the custom flow. note: for the UI to render the custom-flow please use `project-` +- `name` (String) name for the custom flow - `repository` (String) repository url for the custom flow source code ### Optional