From 4090b8331c12fac499a867d1fa9881921e8b0906 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Mon, 25 Mar 2024 17:02:19 +0100 Subject: [PATCH] docs: update project and billing group resources --- docs/data-sources/billing_group.md | 8 ++--- docs/data-sources/cassandra.md | 2 +- docs/data-sources/clickhouse.md | 2 +- docs/data-sources/dragonfly.md | 2 +- docs/data-sources/flink.md | 2 +- docs/data-sources/grafana.md | 2 +- docs/data-sources/kafka.md | 2 +- docs/data-sources/kafka_connect.md | 2 +- docs/data-sources/kafka_mirrormaker.md | 2 +- docs/data-sources/m3aggregator.md | 2 +- docs/data-sources/m3db.md | 2 +- docs/data-sources/mysql.md | 2 +- docs/data-sources/opensearch.md | 2 +- docs/data-sources/pg.md | 2 +- docs/data-sources/project.md | 30 ++++++++-------- docs/data-sources/redis.md | 2 +- docs/resources/billing_group.md | 17 +++++----- docs/resources/cassandra.md | 2 +- docs/resources/clickhouse.md | 2 +- docs/resources/dragonfly.md | 2 +- docs/resources/flink.md | 2 +- docs/resources/grafana.md | 2 +- docs/resources/kafka.md | 2 +- docs/resources/kafka_connect.md | 2 +- docs/resources/kafka_mirrormaker.md | 2 +- docs/resources/m3aggregator.md | 2 +- docs/resources/m3db.md | 2 +- docs/resources/mysql.md | 2 +- docs/resources/opensearch.md | 2 +- docs/resources/organization_group_project.md | 2 +- docs/resources/pg.md | 2 +- docs/resources/project.md | 34 +++++++++---------- docs/resources/redis.md | 2 +- .../aiven_billing_group/data-source.tf | 4 +-- .../data-sources/aiven_project/data-source.tf | 4 +-- .../resources/aiven_billing_group/import.sh | 2 +- .../resources/aiven_billing_group/resource.tf | 11 +++--- .../resource.tf | 2 +- examples/resources/aiven_project/import.sh | 2 +- examples/resources/aiven_project/resource.tf | 2 +- internal/schemautil/service.go | 2 +- .../service/project/billing_group.go | 2 +- .../project/billing_group_data_source.go | 2 +- .../sdkprovider/service/project/project.go | 28 +++++++-------- .../service/project/project_data_source.go | 2 +- 45 files changed, 106 insertions(+), 104 deletions(-) diff --git a/docs/data-sources/billing_group.md b/docs/data-sources/billing_group.md index 9ebf8c8f5..1b7e81435 100644 --- a/docs/data-sources/billing_group.md +++ b/docs/data-sources/billing_group.md @@ -3,18 +3,18 @@ page_title: "aiven_billing_group Data Source - terraform-provider-aiven" subcategory: "" description: |- - Provides information about an existing billing group. + Gets information about a billing group. --- # aiven_billing_group (Data Source) -Provides information about an existing billing group. +Gets information about a billing group. ## Example Usage ```terraform -data "aiven_billing_group" "foo" { - name = "" +data "aiven_billing_group" "example_billing_group" { + name = "example-billing-group" } ``` diff --git a/docs/data-sources/cassandra.md b/docs/data-sources/cassandra.md index 0c519757a..ef86d4f82 100644 --- a/docs/data-sources/cassandra.md +++ b/docs/data-sources/cassandra.md @@ -54,7 +54,7 @@ data "aiven_cassandra" "bar" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/clickhouse.md b/docs/data-sources/clickhouse.md index 6587bec69..1040faf2f 100644 --- a/docs/data-sources/clickhouse.md +++ b/docs/data-sources/clickhouse.md @@ -54,7 +54,7 @@ data "aiven_clickhouse" "clickhouse" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/dragonfly.md b/docs/data-sources/dragonfly.md index 2c11fb0c5..92c6866d8 100644 --- a/docs/data-sources/dragonfly.md +++ b/docs/data-sources/dragonfly.md @@ -54,7 +54,7 @@ data "aiven_dragonfly" "example_dragonfly" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/flink.md b/docs/data-sources/flink.md index f7c48a4d5..884b702ac 100644 --- a/docs/data-sources/flink.md +++ b/docs/data-sources/flink.md @@ -54,7 +54,7 @@ data "aiven_flink" "flink" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/grafana.md b/docs/data-sources/grafana.md index 745658c15..3cd827468 100644 --- a/docs/data-sources/grafana.md +++ b/docs/data-sources/grafana.md @@ -54,7 +54,7 @@ data "aiven_grafana" "gr1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/kafka.md b/docs/data-sources/kafka.md index 52e612b39..728df5dde 100644 --- a/docs/data-sources/kafka.md +++ b/docs/data-sources/kafka.md @@ -56,7 +56,7 @@ data "aiven_kafka" "kafka1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/kafka_connect.md b/docs/data-sources/kafka_connect.md index 1838b77cd..8c041b16d 100644 --- a/docs/data-sources/kafka_connect.md +++ b/docs/data-sources/kafka_connect.md @@ -54,7 +54,7 @@ data "aiven_kafka_connect" "kc1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/kafka_mirrormaker.md b/docs/data-sources/kafka_mirrormaker.md index 5666d81d5..eeb5d236f 100644 --- a/docs/data-sources/kafka_mirrormaker.md +++ b/docs/data-sources/kafka_mirrormaker.md @@ -54,7 +54,7 @@ data "aiven_kafka_mirrormaker" "mm1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/m3aggregator.md b/docs/data-sources/m3aggregator.md index e220a89d7..8b71b96e6 100644 --- a/docs/data-sources/m3aggregator.md +++ b/docs/data-sources/m3aggregator.md @@ -54,7 +54,7 @@ data "aiven_m3aggregator" "m3a" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/m3db.md b/docs/data-sources/m3db.md index a73259802..782a5d4de 100644 --- a/docs/data-sources/m3db.md +++ b/docs/data-sources/m3db.md @@ -54,7 +54,7 @@ data "aiven_m3db" "m3" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/mysql.md b/docs/data-sources/mysql.md index dbb03d8b1..6da7632f7 100644 --- a/docs/data-sources/mysql.md +++ b/docs/data-sources/mysql.md @@ -54,7 +54,7 @@ data "aiven_mysql" "mysql1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/opensearch.md b/docs/data-sources/opensearch.md index 9e6ccf8c9..f332d28a7 100644 --- a/docs/data-sources/opensearch.md +++ b/docs/data-sources/opensearch.md @@ -54,7 +54,7 @@ data "aiven_opensearch" "os1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/pg.md b/docs/data-sources/pg.md index 6549b4872..2936c11c6 100644 --- a/docs/data-sources/pg.md +++ b/docs/data-sources/pg.md @@ -54,7 +54,7 @@ data "aiven_pg" "pg" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md index dd403526c..dc3710298 100644 --- a/docs/data-sources/project.md +++ b/docs/data-sources/project.md @@ -3,18 +3,18 @@ page_title: "aiven_project Data Source - terraform-provider-aiven" subcategory: "" description: |- - The Project data source provides information about the existing Aiven Project. + Gets information about an Aiven project. --- # aiven_project (Data Source) -The Project data source provides information about the existing Aiven Project. +Gets information about an Aiven project. ## Example Usage ```terraform -data "aiven_project" "myproject" { - project = "" +data "aiven_project" "example_project" { + project = "example-project" } ``` @@ -23,23 +23,23 @@ data "aiven_project" "myproject" { ### Required -- `project` (String) Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources. +- `project` (String) The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources. ### Read-Only -- `account_id` (String) An optional property to link a project to an already existing account by using account ID. To set up proper dependencies please refer to this variable as a reference. +- `account_id` (String) Link a project to an existing account using its account ID. This field is deprecated. Use `parent_id` instead. To set up proper dependencies please refer to this variable as a reference. - `add_account_owners_admin_access` (Boolean) If parent_id is set, grant account owner team admin access to the new project. The default value is `true`. -- `available_credits` (String) The amount of platform credits available to the project. This could be your free trial or other promotional credits. -- `billing_group` (String) The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference. -- `ca_cert` (String, Sensitive) The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka. -- `copy_from_project` (String) is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference. -- `default_cloud` (String) Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services. -- `estimated_balance` (String) The current accumulated bill for this project in the current billing period. +- `available_credits` (String) The number of trial or promotional credits remaining for this project. +- `billing_group` (String) The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference. +- `ca_cert` (String, Sensitive) The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka. +- `copy_from_project` (String) The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference. +- `default_cloud` (String) Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services. +- `estimated_balance` (String) The monthly running estimate for this project for the current billing period. - `id` (String) The ID of this resource. -- `parent_id` (String) An optional property to link a project to an already existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference. -- `payment_method` (String) The method of invoicing used for payments for this project, e.g. `card`. +- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID. To set up proper dependencies please refer to this variable as a reference. +- `payment_method` (String) The payment type used for this project. For example,`card`. - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize projects. (see [below for nested schema](#nestedatt--tag)) -- `technical_emails` (Set of String) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is a good practice to keep this up-to-date to be aware of any potential issues with your project. +- `technical_emails` (Set of String) The email addresses for [project contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project. - `use_source_project_billing_group` (Boolean) Use the same billing group that is used in source project. diff --git a/docs/data-sources/redis.md b/docs/data-sources/redis.md index 3768f27a2..3462617ee 100644 --- a/docs/data-sources/redis.md +++ b/docs/data-sources/redis.md @@ -54,7 +54,7 @@ data "aiven_redis" "redis1" { - `state` (String) Service state. One of `POWEROFF`, `REBALANCING`, `REBUILDING` or `RUNNING` - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Set of Object) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedatt--tag)) -- `tech_emails` (Set of Object) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedatt--tech_emails)) +- `tech_emails` (Set of Object) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedatt--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. diff --git a/docs/resources/billing_group.md b/docs/resources/billing_group.md index 4052a0eed..29e1ea46b 100644 --- a/docs/resources/billing_group.md +++ b/docs/resources/billing_group.md @@ -3,25 +3,26 @@ page_title: "aiven_billing_group Resource - terraform-provider-aiven" subcategory: "" description: |- - Creates and manages billing groups and assigns them to projects. + Creates and manages billing groups https://aiven.io/docs/platform/concepts/billing-groups and assigns them to projects. --- # aiven_billing_group (Resource) -Creates and manages billing groups and assigns them to projects. +Creates and manages [billing groups](https://aiven.io/docs/platform/concepts/billing-groups) and assigns them to projects. ## Example Usage ```terraform -resource "aiven_billing_group" "bybg1" { - name = "bybg1" +resource "aiven_billing_group" "example_billing_group" { + name = "example-billing-group" billing_currency = "USD" vat_id = "123ABC" + parent_id = data.aiven_organization.main.id } -resource "aiven_project" "pr1" { - project = "pr1" - billing_group = aiven_billing_group.bybg1.id +resource "aiven_project" "example_project" { + project = "example-project" + billing_group = aiven_billing_group.example_billing_group.id } ``` @@ -70,5 +71,5 @@ Optional: Import is supported using the following syntax: ```shell -terraform import aiven_billing_group.bybg1 id +terraform import aiven_billing_group.example_billing_group ID ``` diff --git a/docs/resources/cassandra.md b/docs/resources/cassandra.md index 7dc335d05..cde755d07 100644 --- a/docs/resources/cassandra.md +++ b/docs/resources/cassandra.md @@ -52,7 +52,7 @@ resource "aiven_cassandra" "bar" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/clickhouse.md b/docs/resources/clickhouse.md index 39cae897d..924eeea42 100644 --- a/docs/resources/clickhouse.md +++ b/docs/resources/clickhouse.md @@ -44,7 +44,7 @@ resource "aiven_clickhouse" "clickhouse" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/dragonfly.md b/docs/resources/dragonfly.md index 55d9b2f3f..4ca3ddcaf 100644 --- a/docs/resources/dragonfly.md +++ b/docs/resources/dragonfly.md @@ -46,7 +46,7 @@ resource "aiven_dragonfly" "example_dragonfly" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/flink.md b/docs/resources/flink.md index 519592370..527559b5d 100644 --- a/docs/resources/flink.md +++ b/docs/resources/flink.md @@ -49,7 +49,7 @@ resource "aiven_flink" "flink" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/grafana.md b/docs/resources/grafana.md index 2bdd57da9..550c600b7 100644 --- a/docs/resources/grafana.md +++ b/docs/resources/grafana.md @@ -52,7 +52,7 @@ resource "aiven_grafana" "gr1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/kafka.md b/docs/resources/kafka.md index f1d59a0d9..053691d05 100644 --- a/docs/resources/kafka.md +++ b/docs/resources/kafka.md @@ -63,7 +63,7 @@ resource "aiven_kafka" "kafka1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/kafka_connect.md b/docs/resources/kafka_connect.md index 264fe44f7..39c1e1140 100644 --- a/docs/resources/kafka_connect.md +++ b/docs/resources/kafka_connect.md @@ -54,7 +54,7 @@ resource "aiven_kafka_connect" "kc1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/kafka_mirrormaker.md b/docs/resources/kafka_mirrormaker.md index c89b9e8d1..3037933b8 100644 --- a/docs/resources/kafka_mirrormaker.md +++ b/docs/resources/kafka_mirrormaker.md @@ -52,7 +52,7 @@ resource "aiven_kafka_mirrormaker" "mm1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/m3aggregator.md b/docs/resources/m3aggregator.md index 598273015..74824d7a0 100644 --- a/docs/resources/m3aggregator.md +++ b/docs/resources/m3aggregator.md @@ -48,7 +48,7 @@ resource "aiven_m3aggregator" "m3a" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/m3db.md b/docs/resources/m3db.md index 788c25a64..cf63155d2 100644 --- a/docs/resources/m3db.md +++ b/docs/resources/m3db.md @@ -53,7 +53,7 @@ resource "aiven_m3db" "m3" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/mysql.md b/docs/resources/mysql.md index 33780a4c7..7fc92a19d 100644 --- a/docs/resources/mysql.md +++ b/docs/resources/mysql.md @@ -57,7 +57,7 @@ resource "aiven_mysql" "mysql1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/opensearch.md b/docs/resources/opensearch.md index e21b6fc16..35f27f5c2 100644 --- a/docs/resources/opensearch.md +++ b/docs/resources/opensearch.md @@ -58,7 +58,7 @@ resource "aiven_opensearch" "os1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/organization_group_project.md b/docs/resources/organization_group_project.md index 314510967..9bedf58d5 100644 --- a/docs/resources/organization_group_project.md +++ b/docs/resources/organization_group_project.md @@ -14,7 +14,7 @@ Adds and manages a [group](https://aiven.io/docs/platform/concepts/projects_acco ```terraform resource "aiven_project" "example_project" { - project = "Example project" + project = "example-project" parent_id = aiven_organization.main.id } diff --git a/docs/resources/pg.md b/docs/resources/pg.md index 1af9baab3..95e811742 100644 --- a/docs/resources/pg.md +++ b/docs/resources/pg.md @@ -72,7 +72,7 @@ resource "aiven_pg" "pg" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/project.md b/docs/resources/project.md index f9b3a3019..20604525f 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -3,18 +3,18 @@ page_title: "aiven_project Resource - terraform-provider-aiven" subcategory: "" description: |- - The Project resource allows the creation and management of Aiven Projects. + Creates and manages an Aiven project https://aiven.io/docs/platform/concepts/projects_accounts_access#projects. --- # aiven_project (Resource) -The Project resource allows the creation and management of Aiven Projects. +Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/projects_accounts_access#projects). ## Example Usage ```terraform resource "aiven_project" "example_project" { - project = "Example project" + project = "example-project" parent_id = aiven_organization.main.id } ``` @@ -24,36 +24,36 @@ resource "aiven_project" "example_project" { ### Required -- `project` (String) Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources. +- `project` (String) The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources. ### Optional -- `account_id` (String, Deprecated) An optional property to link a project to an already existing account by using account ID. To set up proper dependencies please refer to this variable as a reference. +- `account_id` (String, Deprecated) Link a project to an existing account using its account ID. This field is deprecated. Use `parent_id` instead. To set up proper dependencies please refer to this variable as a reference. - `add_account_owners_admin_access` (Boolean, Deprecated) If parent_id is set, grant account owner team admin access to the new project. The default value is `true`. -- `billing_group` (String) The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference. -- `copy_from_project` (String) is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference. -- `default_cloud` (String) Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services. -- `parent_id` (String) An optional property to link a project to an already existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference. +- `billing_group` (String) The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference. +- `copy_from_project` (String) The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference. +- `default_cloud` (String) Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services. +- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID. To set up proper dependencies please refer to this variable as a reference. - `tag` (Block Set) Tags are key-value pairs that allow you to categorize projects. (see [below for nested schema](#nestedblock--tag)) -- `technical_emails` (Set of String) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is a good practice to keep this up-to-date to be aware of any potential issues with your project. +- `technical_emails` (Set of String) The email addresses for [project contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) - `use_source_project_billing_group` (Boolean, Deprecated) Use the same billing group that is used in source project. ### Read-Only -- `available_credits` (String) The amount of platform credits available to the project. This could be your free trial or other promotional credits. -- `ca_cert` (String, Sensitive) The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka. -- `estimated_balance` (String) The current accumulated bill for this project in the current billing period. +- `available_credits` (String) The number of trial or promotional credits remaining for this project. +- `ca_cert` (String, Sensitive) The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka. +- `estimated_balance` (String) The monthly running estimate for this project for the current billing period. - `id` (String) The ID of this resource. -- `payment_method` (String) The method of invoicing used for payments for this project, e.g. `card`. +- `payment_method` (String) The payment type used for this project. For example,`card`. ### Nested Schema for `tag` Required: -- `key` (String) Project tag key -- `value` (String) Project tag value +- `key` (String) Project tag key. +- `value` (String) Project tag value. @@ -72,5 +72,5 @@ Optional: Import is supported using the following syntax: ```shell -terraform import aiven_project.myproject project +terraform import aiven_project.example_project PROJECT ``` diff --git a/docs/resources/redis.md b/docs/resources/redis.md index 0ceac60e5..77cc7c40b 100644 --- a/docs/resources/redis.md +++ b/docs/resources/redis.md @@ -52,7 +52,7 @@ resource "aiven_redis" "redis1" { - `service_integrations` (Block List) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedblock--service_integrations)) - `static_ips` (Set of String) Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again - `tag` (Block Set) Tags are key-value pairs that allow you to categorize services. (see [below for nested schema](#nestedblock--tag)) -- `tech_emails` (Block Set) Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. (see [below for nested schema](#nestedblock--tech_emails)) +- `tech_emails` (Block Set) The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level. (see [below for nested schema](#nestedblock--tech_emails)) - `termination_protection` (Boolean) Prevents the service from being deleted. It is recommended to set this to `true` for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/examples/data-sources/aiven_billing_group/data-source.tf b/examples/data-sources/aiven_billing_group/data-source.tf index 35b37f0d1..f38fbb216 100644 --- a/examples/data-sources/aiven_billing_group/data-source.tf +++ b/examples/data-sources/aiven_billing_group/data-source.tf @@ -1,3 +1,3 @@ -data "aiven_billing_group" "foo" { - name = "" +data "aiven_billing_group" "example_billing_group" { + name = "example-billing-group" } diff --git a/examples/data-sources/aiven_project/data-source.tf b/examples/data-sources/aiven_project/data-source.tf index 8ee619080..531435995 100644 --- a/examples/data-sources/aiven_project/data-source.tf +++ b/examples/data-sources/aiven_project/data-source.tf @@ -1,4 +1,4 @@ -data "aiven_project" "myproject" { - project = "" +data "aiven_project" "example_project" { + project = "example-project" } diff --git a/examples/resources/aiven_billing_group/import.sh b/examples/resources/aiven_billing_group/import.sh index 30338ebe4..0aea68dc3 100644 --- a/examples/resources/aiven_billing_group/import.sh +++ b/examples/resources/aiven_billing_group/import.sh @@ -1 +1 @@ -terraform import aiven_billing_group.bybg1 id +terraform import aiven_billing_group.example_billing_group ID \ No newline at end of file diff --git a/examples/resources/aiven_billing_group/resource.tf b/examples/resources/aiven_billing_group/resource.tf index 6560dbab1..3ae199ef6 100644 --- a/examples/resources/aiven_billing_group/resource.tf +++ b/examples/resources/aiven_billing_group/resource.tf @@ -1,10 +1,11 @@ -resource "aiven_billing_group" "bybg1" { - name = "bybg1" +resource "aiven_billing_group" "example_billing_group" { + name = "example-billing-group" billing_currency = "USD" vat_id = "123ABC" + parent_id = data.aiven_organization.main.id } -resource "aiven_project" "pr1" { - project = "pr1" - billing_group = aiven_billing_group.bybg1.id +resource "aiven_project" "example_project" { + project = "example-project" + billing_group = aiven_billing_group.example_billing_group.id } diff --git a/examples/resources/aiven_organization_group_project/resource.tf b/examples/resources/aiven_organization_group_project/resource.tf index 23b5356fb..9bbd4d4ca 100644 --- a/examples/resources/aiven_organization_group_project/resource.tf +++ b/examples/resources/aiven_organization_group_project/resource.tf @@ -1,5 +1,5 @@ resource "aiven_project" "example_project" { - project = "Example project" + project = "example-project" parent_id = aiven_organization.main.id } diff --git a/examples/resources/aiven_project/import.sh b/examples/resources/aiven_project/import.sh index f82bbdd59..d2634ef97 100644 --- a/examples/resources/aiven_project/import.sh +++ b/examples/resources/aiven_project/import.sh @@ -1 +1 @@ -terraform import aiven_project.myproject project +terraform import aiven_project.example_project PROJECT diff --git a/examples/resources/aiven_project/resource.tf b/examples/resources/aiven_project/resource.tf index 6e4ffdf0e..67cf2622a 100644 --- a/examples/resources/aiven_project/resource.tf +++ b/examples/resources/aiven_project/resource.tf @@ -1,4 +1,4 @@ resource "aiven_project" "example_project" { - project = "Example project" + project = "example-project" parent_id = aiven_organization.main.id } diff --git a/internal/schemautil/service.go b/internal/schemautil/service.go index b28794903..b414d59b2 100644 --- a/internal/schemautil/service.go +++ b/internal/schemautil/service.go @@ -297,7 +297,7 @@ func ServiceCommonSchema() map[string]*schema.Schema { Type: schema.TypeSet, Elem: TechEmailsResourceSchema, Optional: true, - Description: "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + Description: " The email addresses for [service contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this service. You can also set email contacts at the project level.", }, } } diff --git a/internal/sdkprovider/service/project/billing_group.go b/internal/sdkprovider/service/project/billing_group.go index 87ed4640e..daa5023ca 100644 --- a/internal/sdkprovider/service/project/billing_group.go +++ b/internal/sdkprovider/service/project/billing_group.go @@ -112,7 +112,7 @@ var aivenBillingGroupSchema = map[string]*schema.Schema{ func ResourceBillingGroup() *schema.Resource { return &schema.Resource{ - Description: "Creates and manages billing groups and assigns them to projects.", + Description: "Creates and manages [billing groups](https://aiven.io/docs/platform/concepts/billing-groups) and assigns them to projects.", CreateContext: resourceBillingGroupCreate, ReadContext: resourceBillingGroupRead, UpdateContext: resourceBillingGroupUpdate, diff --git a/internal/sdkprovider/service/project/billing_group_data_source.go b/internal/sdkprovider/service/project/billing_group_data_source.go index 8a96168c7..35a44458a 100644 --- a/internal/sdkprovider/service/project/billing_group_data_source.go +++ b/internal/sdkprovider/service/project/billing_group_data_source.go @@ -23,7 +23,7 @@ func DatasourceBillingGroup() *schema.Resource { return &schema.Resource{ ReadContext: datasourceBillingGroupRead, - Description: "Provides information about an existing billing group.", + Description: "Gets information about a billing group.", Schema: s, } } diff --git a/internal/sdkprovider/service/project/project.go b/internal/sdkprovider/service/project/project.go index 2f646cad4..556e7f96a 100644 --- a/internal/sdkprovider/service/project/project.go +++ b/internal/sdkprovider/service/project/project.go @@ -25,12 +25,12 @@ var aivenProjectSchema = map[string]*schema.Schema{ Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.", + Description: "The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.", }, "account_id": { Type: schema.TypeString, Optional: true, - Description: userconfig.Desc("An optional property to link a project to an already existing account by using account ID.").Referenced().Build(), + Description: userconfig.Desc("Link a project to an existing account using its account ID. This field is deprecated. Use `parent_id` instead.").Referenced().Build(), Deprecated: "Use parent_id instead. This field will be removed in the next major release.", DiffSuppressFunc: func(_, _, _ string, d *schema.ResourceData) bool { _, ok := d.GetOk("parent_id") @@ -41,7 +41,7 @@ var aivenProjectSchema = map[string]*schema.Schema{ Type: schema.TypeString, Optional: true, Description: userconfig.Desc( - "An optional property to link a project to an already existing organization or account by using its ID.", + "Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID.", ).Referenced().Build(), DiffSuppressFunc: func(_, _, _ string, d *schema.ResourceData) bool { _, ok := d.GetOk("account_id") @@ -52,7 +52,7 @@ var aivenProjectSchema = map[string]*schema.Schema{ Type: schema.TypeString, Optional: true, DiffSuppressFunc: schemautil.CreateOnlyDiffSuppressFunc, - Description: userconfig.Desc("is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created.").Referenced().Build(), + Description: userconfig.Desc("The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing.").Referenced().Build(), }, "use_source_project_billing_group": { Type: schema.TypeBool, @@ -74,24 +74,24 @@ var aivenProjectSchema = map[string]*schema.Schema{ "project": { Type: schema.TypeString, Required: true, - Description: "Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.", + Description: "The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.", }, "technical_emails": { Type: schema.TypeSet, Elem: &schema.Schema{Type: schema.TypeString}, Optional: true, - Description: "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is a good practice to keep this up-to-date to be aware of any potential issues with your project.", + Description: "The email addresses for [project contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.", }, "default_cloud": { Type: schema.TypeString, Optional: true, DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc, - Description: "Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.", + Description: "Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.", }, "billing_group": { Type: schema.TypeString, Optional: true, - Description: userconfig.Desc("The id of the billing group that is linked to this project.").Referenced().Build(), + Description: userconfig.Desc("The ID of the billing group this project is assigned to.").Referenced().Build(), DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc, }, "tag": { @@ -101,12 +101,12 @@ var aivenProjectSchema = map[string]*schema.Schema{ Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "key": { - Description: "Project tag key", + Description: "Project tag key.", Type: schema.TypeString, Required: true, }, "value": { - Description: "Project tag value", + Description: "Project tag value.", Type: schema.TypeString, Required: true, }, @@ -118,23 +118,23 @@ var aivenProjectSchema = map[string]*schema.Schema{ "payment_method": { Type: schema.TypeString, Computed: true, - Description: "The method of invoicing used for payments for this project, e.g. `card`.", + Description: "The payment type used for this project. For example,`card`.", }, "available_credits": { Type: schema.TypeString, Computed: true, - Description: "The amount of platform credits available to the project. This could be your free trial or other promotional credits.", + Description: "The number of trial or promotional credits remaining for this project.", }, "estimated_balance": { Type: schema.TypeString, Computed: true, - Description: "The current accumulated bill for this project in the current billing period.", + Description: "The monthly running estimate for this project for the current billing period.", }, } func ResourceProject() *schema.Resource { return &schema.Resource{ - Description: "The Project resource allows the creation and management of Aiven Projects.", + Description: "Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/projects_accounts_access#projects).", CreateContext: resourceProjectCreate, ReadContext: resourceProjectRead, UpdateContext: resourceProjectUpdate, diff --git a/internal/sdkprovider/service/project/project_data_source.go b/internal/sdkprovider/service/project/project_data_source.go index 3950a28e1..391f4c1c7 100644 --- a/internal/sdkprovider/service/project/project_data_source.go +++ b/internal/sdkprovider/service/project/project_data_source.go @@ -13,7 +13,7 @@ import ( func DatasourceProject() *schema.Resource { return &schema.Resource{ ReadContext: datasourceProjectRead, - Description: "The Project data source provides information about the existing Aiven Project.", + Description: "Gets information about an Aiven project.", Schema: schemautil.ResourceSchemaAsDatasourceSchema(aivenProjectSchema, "project"), } }