-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Aleksander Zaruczewski <[email protected]>
- Loading branch information
1 parent
9903742
commit ae8010a
Showing
8 changed files
with
571 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "aiven_dragonfly Data Source - terraform-provider-aiven" | ||
| subcategory: "" | ||
| description: |- | ||
| The Dragonfly data source provides information about the existing Aiven Dragonfly service. | ||
| --- | ||
|
|
||
| # aiven_dragonfly (Data Source) | ||
|
|
||
| The Dragonfly data source provides information about the existing Aiven Dragonfly service. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. | ||
| - `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `additional_disk_space` (String) Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. | ||
| - `cloud_name` (String) Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (`aws`, `azure`, `do` `google`, `upcloud`, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like [here for Google](https://cloud.google.com/compute/docs/regions-zones/) and [here for AWS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). | ||
| - `components` (List of Object) Service component information objects (see [below for nested schema](#nestedatt--components)) | ||
| - `disk_space` (String) Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing. | ||
| - `disk_space_cap` (String) The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project. | ||
| - `disk_space_default` (String) The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for `disk_space` | ||
| - `disk_space_step` (String) The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. `disk_space` needs to increment from `disk_space_default` by increments of this size. | ||
| - `disk_space_used` (String) Disk space that service is currently using | ||
| - `dragonfly` (List of Object) Dragonfly server provided values (see [below for nested schema](#nestedatt--dragonfly)) | ||
| - `dragonfly_user_config` (List of Object) Dragonfly user configurable settings (see [below for nested schema](#nestedatt--dragonfly_user_config)) | ||
| - `id` (String) The ID of this resource. | ||
| - `maintenance_window_dow` (String) Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc. | ||
| - `maintenance_window_time` (String) Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format. | ||
| - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). | ||
| - `project_vpc_id` (String) Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data. | ||
| - `service_host` (String) The hostname of the service. | ||
| - `service_integrations` (List of Object) Service integrations to specify when creating a service. Not applied after initial service creation (see [below for nested schema](#nestedatt--service_integrations)) | ||
| - `service_password` (String, Sensitive) Password used for connecting to the service, if applicable | ||
| - `service_port` (Number) The port of the service | ||
| - `service_type` (String) Aiven internal service type code | ||
| - `service_uri` (String, Sensitive) URI for connecting to the service. Service specific info is under "kafka", "pg", etc. | ||
| - `service_username` (String) Username used for connecting to the service, if applicable | ||
| - `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)) | ||
| - `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. | ||
|
|
||
| <a id="nestedatt--components"></a> | ||
| ### Nested Schema for `components` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `component` (String) | ||
| - `connection_uri` (String) | ||
| - `host` (String) | ||
| - `kafka_authentication_method` (String) | ||
| - `port` (Number) | ||
| - `route` (String) | ||
| - `ssl` (Boolean) | ||
| - `usage` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--dragonfly"></a> | ||
| ### Nested Schema for `dragonfly` | ||
|
|
||
| Read-Only: | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--dragonfly_user_config"></a> | ||
| ### Nested Schema for `dragonfly_user_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `cache_mode` (Boolean) | ||
| - `dragonfly_ssl` (Boolean) | ||
| - `ip_filter` (Set of String) | ||
| - `ip_filter_object` (Set of Object) (see [below for nested schema](#nestedobjatt--dragonfly_user_config--ip_filter_object)) | ||
| - `ip_filter_string` (Set of String) | ||
| - `migration` (List of Object) (see [below for nested schema](#nestedobjatt--dragonfly_user_config--migration)) | ||
| - `private_access` (List of Object) (see [below for nested schema](#nestedobjatt--dragonfly_user_config--private_access)) | ||
| - `privatelink_access` (List of Object) (see [below for nested schema](#nestedobjatt--dragonfly_user_config--privatelink_access)) | ||
| - `project_to_fork_from` (String) | ||
| - `public_access` (List of Object) (see [below for nested schema](#nestedobjatt--dragonfly_user_config--public_access)) | ||
| - `recovery_basebackup_name` (String) | ||
| - `service_log` (Boolean) | ||
| - `service_to_fork_from` (String) | ||
| - `static_ips` (Boolean) | ||
|
|
||
| <a id="nestedobjatt--dragonfly_user_config--ip_filter_object"></a> | ||
| ### Nested Schema for `dragonfly_user_config.ip_filter_object` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `description` (String) | ||
| - `network` (String) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--dragonfly_user_config--migration"></a> | ||
| ### Nested Schema for `dragonfly_user_config.migration` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `dbname` (String) | ||
| - `host` (String) | ||
| - `ignore_dbs` (String) | ||
| - `method` (String) | ||
| - `password` (String) | ||
| - `port` (Number) | ||
| - `ssl` (Boolean) | ||
| - `username` (String) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--dragonfly_user_config--private_access"></a> | ||
| ### Nested Schema for `dragonfly_user_config.private_access` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `dragonfly` (Boolean) | ||
| - `prometheus` (Boolean) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--dragonfly_user_config--privatelink_access"></a> | ||
| ### Nested Schema for `dragonfly_user_config.privatelink_access` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `dragonfly` (Boolean) | ||
| - `prometheus` (Boolean) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--dragonfly_user_config--public_access"></a> | ||
| ### Nested Schema for `dragonfly_user_config.public_access` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `dragonfly` (Boolean) | ||
| - `prometheus` (Boolean) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--service_integrations"></a> | ||
| ### Nested Schema for `service_integrations` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `integration_type` (String) | ||
| - `source_service_name` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--tag"></a> | ||
| ### Nested Schema for `tag` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `key` (String) | ||
| - `value` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--tech_emails"></a> | ||
| ### Nested Schema for `tech_emails` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `email` (String) |
Oops, something went wrong.