From 492037bc45537285246b9be3789ff5cb9c8c4ca0 Mon Sep 17 00:00:00 2001 From: Johan Andersson Date: Wed, 22 Jun 2022 14:29:01 +0200 Subject: [PATCH] Update docs with new terraform-plugin-docs version (#50) --- docs/data-sources/azure_permissions.md | 17 +++++++-------- docs/data-sources/gcp_permissions.md | 11 ++++------ docs/index.md | 2 +- docs/resources/aws_account.md | 25 +++++++++++++---------- docs/resources/aws_exocompute.md | 19 +++++++++-------- docs/resources/azure_exocompute.md | 13 +++++++----- docs/resources/azure_service_principal.md | 21 +++++++++++-------- docs/resources/azure_subscription.md | 25 +++++++++++++---------- docs/resources/gcp_project.md | 23 ++++++++++++--------- docs/resources/gcp_service_account.md | 11 ++++++---- 10 files changed, 91 insertions(+), 76 deletions(-) diff --git a/docs/data-sources/azure_permissions.md b/docs/data-sources/azure_permissions.md index ccff0fd..b0f6927 100644 --- a/docs/data-sources/azure_permissions.md +++ b/docs/data-sources/azure_permissions.md @@ -25,18 +25,15 @@ data "polaris_azure_permissions" "default" { ### Required -- **features** (Set of String) Enabled features. - -### Optional - -- **id** (String) The ID of this resource. +- `features` (Set of String) Enabled features. ### Read-Only -- **actions** (List of String) Allowed actions. -- **data_actions** (List of String) Allowed data actions. -- **hash** (String) SHA-256 hash of the permissions, can be used to detect changes to the permissions. -- **not_actions** (List of String) Disallowed actions. -- **not_data_actions** (List of String) Disallowed data actions. +- `actions` (List of String) Allowed actions. +- `data_actions` (List of String) Allowed data actions. +- `hash` (String) SHA-256 hash of the permissions, can be used to detect changes to the permissions. +- `id` (String) The ID of this resource. +- `not_actions` (List of String) Disallowed actions. +- `not_data_actions` (List of String) Disallowed data actions. diff --git a/docs/data-sources/gcp_permissions.md b/docs/data-sources/gcp_permissions.md index 3b5ec05..f8aab23 100644 --- a/docs/data-sources/gcp_permissions.md +++ b/docs/data-sources/gcp_permissions.md @@ -25,15 +25,12 @@ data "polaris_gcp_permissions" "default" { ### Required -- **features** (Set of String) Enabled features. - -### Optional - -- **id** (String) The ID of this resource. +- `features` (Set of String) Enabled features. ### Read-Only -- **hash** (String) SHA-256 hash of the permissions, can be used to detect changes to the permissions. -- **permissions** (List of String) Permissions required for the features enabled. +- `hash` (String) SHA-256 hash of the permissions, can be used to detect changes to the permissions. +- `id` (String) The ID of this resource. +- `permissions` (List of String) Permissions required for the features enabled. diff --git a/docs/index.md b/docs/index.md index 138e5e7..e4337cc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -77,4 +77,4 @@ provider "polaris" { ### Required -- **credentials** (String) The local user account name or service account file to use when accessing Rubrik Polaris. +- `credentials` (String) The local user account name or service account file to use when accessing Rubrik Polaris. diff --git a/docs/resources/aws_account.md b/docs/resources/aws_account.md index 0aadc90..7f9204a 100644 --- a/docs/resources/aws_account.md +++ b/docs/resources/aws_account.md @@ -48,27 +48,30 @@ resource "polaris_aws_account" "default" { ### Required -- **cloud_native_protection** (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) -- **profile** (String) AWS named profile. +- `cloud_native_protection` (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) +- `profile` (String) AWS named profile. ### Optional -- **delete_snapshots_on_destroy** (Boolean) Should snapshots be deleted when the resource is destroyed. -- **exocompute** (Block List, Max: 1) Enable the exocompute feature for the account. (see [below for nested schema](#nestedblock--exocompute)) -- **id** (String) The ID of this resource. -- **name** (String) Account name in Polaris. If not given the name is taken from AWS Organizations or, if the required permissions are missing, is derived from the AWS account ID and the named profile. -- **permissions** (String) When set to 'update' feature permissions can be updated by applying the configuration. +- `delete_snapshots_on_destroy` (Boolean) Should snapshots be deleted when the resource is destroyed. +- `exocompute` (Block List, Max: 1) Enable the exocompute feature for the account. (see [below for nested schema](#nestedblock--exocompute)) +- `name` (String) Account name in Polaris. If not given the name is taken from AWS Organizations or, if the required permissions are missing, is derived from the AWS account ID and the named profile. +- `permissions` (String) When set to 'update' feature permissions can be updated by applying the configuration. + +### Read-Only + +- `id` (String) The ID of this resource. ### Nested Schema for `cloud_native_protection` Required: -- **regions** (Set of String) Regions that Polaris will monitor for instances to automatically protect. +- `regions` (Set of String) Regions that Polaris will monitor for instances to automatically protect. Read-Only: -- **status** (String) Status of the Cloud Native Protection feature. +- `status` (String) Status of the Cloud Native Protection feature. @@ -76,10 +79,10 @@ Read-Only: Required: -- **regions** (Set of String) Regions to enable the Exocompute feature in. +- `regions` (Set of String) Regions to enable the Exocompute feature in. Read-Only: -- **status** (String) Status of the Exocompute feature. +- `status` (String) Status of the Exocompute feature. diff --git a/docs/resources/aws_exocompute.md b/docs/resources/aws_exocompute.md index 16ad8da..056ec7b 100644 --- a/docs/resources/aws_exocompute.md +++ b/docs/resources/aws_exocompute.md @@ -45,16 +45,19 @@ resource "polaris_aws_exocompute" "default" { ### Required -- **account_id** (String) Polaris account id -- **region** (String) AWS region to run the exocompute instance in. -- **subnets** (Set of String) AWS subnet ids for the cluster subnets. -- **vpc_id** (String) AWS VPC id for the cluster network. +- `account_id` (String) Polaris account id +- `region` (String) AWS region to run the exocompute instance in. +- `subnets` (Set of String) AWS subnet ids for the cluster subnets. +- `vpc_id` (String) AWS VPC id for the cluster network. ### Optional -- **cluster_security_group_id** (String) AWS security group id for the cluster. -- **id** (String) The ID of this resource. -- **node_security_group_id** (String) AWS security group id for the nodes. -- **polaris_managed** (Boolean) If true the security groups are managed by Polaris. +- `cluster_security_group_id` (String) AWS security group id for the cluster. +- `node_security_group_id` (String) AWS security group id for the nodes. +- `polaris_managed` (Boolean) If true the security groups are managed by Polaris. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/azure_exocompute.md b/docs/resources/azure_exocompute.md index 8db7a14..8887bdf 100644 --- a/docs/resources/azure_exocompute.md +++ b/docs/resources/azure_exocompute.md @@ -25,13 +25,16 @@ resource "polaris_azure_exocompute" "default" { ### Required -- **region** (String) Azure region to run the exocompute instance in. -- **subnet** (String) Azure subnet id. -- **subscription_id** (String) Polaris subscription id +- `region` (String) Azure region to run the exocompute instance in. +- `subnet` (String) Azure subnet id. +- `subscription_id` (String) Polaris subscription id ### Optional -- **id** (String) The ID of this resource. -- **polaris_managed** (Boolean) If true the security groups are managed by Polaris. +- `polaris_managed` (Boolean) If true the security groups are managed by Polaris. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/azure_service_principal.md b/docs/resources/azure_service_principal.md index 71e69fc..80332bf 100644 --- a/docs/resources/azure_service_principal.md +++ b/docs/resources/azure_service_principal.md @@ -41,17 +41,20 @@ resource "polaris_azure_service_principal" "default" { ### Required -- **tenant_domain** (String) Tenant directory/domain name. +- `tenant_domain` (String) Tenant directory/domain name. ### Optional -- **app_id** (String) App registration application id. -- **app_name** (String) App registration display name. -- **app_secret** (String, Sensitive) App registration client secret. -- **credentials** (String) Path to Azure service principal file. -- **id** (String) The ID of this resource. -- **permissions_hash** (String) Signals that the permissions has been updated. -- **sdk_auth** (String) Path to Azure service principal created with the Azure SDK using the --sdk-auth parameter -- **tenant_id** (String) Tenant/domain id. +- `app_id` (String) App registration application id. +- `app_name` (String) App registration display name. +- `app_secret` (String, Sensitive) App registration client secret. +- `credentials` (String) Path to Azure service principal file. +- `permissions_hash` (String) Signals that the permissions has been updated. +- `sdk_auth` (String) Path to Azure service principal created with the Azure SDK using the --sdk-auth parameter +- `tenant_id` (String) Tenant/domain id. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/azure_subscription.md b/docs/resources/azure_subscription.md index 2f93168..f6ba544 100644 --- a/docs/resources/azure_subscription.md +++ b/docs/resources/azure_subscription.md @@ -50,27 +50,30 @@ resource "polaris_azure_subscription" "default" { ### Required -- **cloud_native_protection** (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) -- **subscription_id** (String) Subscription id. -- **tenant_domain** (String) Tenant directory/domain name. +- `cloud_native_protection` (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) +- `subscription_id` (String) Subscription id. +- `tenant_domain` (String) Tenant directory/domain name. ### Optional -- **delete_snapshots_on_destroy** (Boolean) Should snapshots be deleted when the resource is destroyed. -- **exocompute** (Block List, Max: 1) Enable the exocompute feature for the account. (see [below for nested schema](#nestedblock--exocompute)) -- **id** (String) The ID of this resource. -- **subscription_name** (String) Subscription name. +- `delete_snapshots_on_destroy` (Boolean) Should snapshots be deleted when the resource is destroyed. +- `exocompute` (Block List, Max: 1) Enable the exocompute feature for the account. (see [below for nested schema](#nestedblock--exocompute)) +- `subscription_name` (String) Subscription name. + +### Read-Only + +- `id` (String) The ID of this resource. ### Nested Schema for `cloud_native_protection` Required: -- **regions** (Set of String) Regions that Polaris will monitor for instances to automatically protect. +- `regions` (Set of String) Regions that Polaris will monitor for instances to automatically protect. Read-Only: -- **status** (String) Status of the Cloud Native Protection feature. +- `status` (String) Status of the Cloud Native Protection feature. @@ -78,10 +81,10 @@ Read-Only: Required: -- **regions** (Set of String) Regions to enable the exocompute feature in. +- `regions` (Set of String) Regions to enable the exocompute feature in. Read-Only: -- **status** (String) Status of the Exocompute feature. +- `status` (String) Status of the Exocompute feature. diff --git a/docs/resources/gcp_project.md b/docs/resources/gcp_project.md index 30687ea..c102e25 100644 --- a/docs/resources/gcp_project.md +++ b/docs/resources/gcp_project.md @@ -30,24 +30,27 @@ resource "polaris_gcp_project" "default" { ### Required -- **cloud_native_protection** (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) +- `cloud_native_protection` (Block List, Min: 1, Max: 1) Enable the Cloud Native Protection feature for the GCP project. (see [below for nested schema](#nestedblock--cloud_native_protection)) ### Optional -- **credentials** (String) Path to GCP service account key file. -- **delete_snapshots_on_destroy** (Boolean) Should snapshots be deleted when the resource is destroyed. -- **id** (String) The ID of this resource. -- **organization_name** (String) Organization name. -- **permissions_hash** (String) Signals that the permissions has been updated. -- **project** (String) Project id. -- **project_name** (String) Project name. -- **project_number** (String) Project number. +- `credentials` (String) Path to GCP service account key file. +- `delete_snapshots_on_destroy` (Boolean) Should snapshots be deleted when the resource is destroyed. +- `organization_name` (String) Organization name. +- `permissions_hash` (String) Signals that the permissions has been updated. +- `project` (String) Project id. +- `project_name` (String) Project name. +- `project_number` (String) Project number. + +### Read-Only + +- `id` (String) The ID of this resource. ### Nested Schema for `cloud_native_protection` Read-Only: -- **status** (String) Status of the Cloud Native Protection feature. +- `status` (String) Status of the Cloud Native Protection feature. diff --git a/docs/resources/gcp_service_account.md b/docs/resources/gcp_service_account.md index 4eeafb8..106909d 100644 --- a/docs/resources/gcp_service_account.md +++ b/docs/resources/gcp_service_account.md @@ -23,12 +23,15 @@ resource "polaris_gcp_service_account" "default" { ### Required -- **credentials** (String) Path to GCP service account key file. +- `credentials` (String) Path to GCP service account key file. ### Optional -- **id** (String) The ID of this resource. -- **name** (String) Service account name in Polaris. If not given the name of the service account key file is used. -- **permissions_hash** (String) Signals that the permissions has been updated. +- `name` (String) Service account name in Polaris. If not given the name of the service account key file is used. +- `permissions_hash` (String) Signals that the permissions has been updated. + +### Read-Only + +- `id` (String) The ID of this resource.