Skip to content

Commit

Permalink
Update docs with new terraform-plugin-docs version (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
johan3141592 authored Jun 22, 2022
1 parent 8f92099 commit 492037b
Show file tree
Hide file tree
Showing 10 changed files with 91 additions and 76 deletions.
17 changes: 7 additions & 10 deletions docs/data-sources/azure_permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


11 changes: 4 additions & 7 deletions docs/data-sources/gcp_permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
25 changes: 14 additions & 11 deletions docs/resources/aws_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,41 @@ 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.

<a id="nestedblock--cloud_native_protection"></a>
### 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.


<a id="nestedblock--exocompute"></a>
### Nested Schema for `exocompute`

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.


19 changes: 11 additions & 8 deletions docs/resources/aws_exocompute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


13 changes: 8 additions & 5 deletions docs/resources/azure_exocompute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


21 changes: 12 additions & 9 deletions docs/resources/azure_service_principal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


25 changes: 14 additions & 11 deletions docs/resources/azure_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,38 +50,41 @@ 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.

<a id="nestedblock--cloud_native_protection"></a>
### 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.


<a id="nestedblock--exocompute"></a>
### Nested Schema for `exocompute`

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.


23 changes: 13 additions & 10 deletions docs/resources/gcp_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a id="nestedblock--cloud_native_protection"></a>
### 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.


11 changes: 7 additions & 4 deletions docs/resources/gcp_service_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


0 comments on commit 492037b

Please sign in to comment.