Skip to content

Commit

Permalink
docs(GaussDB): fix docs issues (FlexibleEngineCloud#1013)
Browse files Browse the repository at this point in the history
  • Loading branch information
Zippo-Wang authored and Zhukun-Huawei committed Nov 20, 2023
1 parent 799354a commit 0e1c642
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 16 deletions.
29 changes: 23 additions & 6 deletions docs/data-sources/gaussdb_cassandra_instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,20 @@ data "flexibleengine_gaussdb_cassandra_instances" "this" {

* `subnet_id` - (Optional, String) Specifies the network ID of a subnet.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - Indicates the ID of the data source.

* `instances` - An array of available instances.
* `instances` - An array of available instances. The [instances](#gaussdb_instances) object structure is documented
below.

<a name="gaussdb_instances"></a>
The `instances` block supports:

* `id` - The id of the instance.

* `region` - The region of the instance.

* `name` - Indicates the name of the instance.
Expand Down Expand Up @@ -65,30 +69,43 @@ The `instances` block supports:

* `private_ips` - Indicates the list of private IP address of the nodes.

* `datastore` - Indicates the database information. Structure is documented below.
* `datastore` - Indicates the database information. The [datastore](#gaussdb_datastore) object structure is documented
below.

* `backup_strategy` - Indicates the advanced backup policy. Structure is documented below.
* `backup_strategy` - Indicates the advanced backup policy. The [backup_strategy](#gaussdb_backup_strategy) object
structure is documented below.

* `nodes` - Indicates the instance nodes information. Structure is documented below.
* `nodes` - Indicates the instance nodes information. The [nodes](#gaussdb_nodes) object structure is documented below.

* `tags` - Indicates the key/value tags of the instance.

<a name="gaussdb_datastore"></a>
The `datastore` block supports:

* `engine` - Indicates the database engine.

* `storage_engine` - Indicates the database storage engine.

* `version` - Indicates the database version.

<a name="gaussdb_backup_strategy"></a>
The `backup_strategy` block supports:

* `start_time` - Indicates the backup time window.

* `keep_days` - Indicates the number of days to retain the generated

The `nodes` block contains:
<a name="gaussdb_nodes"></a>
The `nodes` block supports:

* `id` - Indicates the node ID.

* `name` - Indicates the node name.

* `private_ip` - Indicates the private IP address of a node.

* `status` - Indicates the node status.

* `support_reduce` - Indicates whether the node support reduce.

* `availability_zone` - Indicates the availability zone where the node resides.
26 changes: 21 additions & 5 deletions docs/resources/gaussdb_cassandra_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,15 @@ The following arguments are supported:
* `force_import` - (Optional, Bool) If specified, try to import the instance instead of creating if the name already
existed.

* `datastore` - (Optional, List, ForceNew) Specifies the database information. Structure is documented below. Changing
this parameter will create a new resource.
* `datastore` - (Optional, List, ForceNew) Specifies the database information. The [datastore](#gaussdb_datastore)
object structure is documented below. Changing this parameter will create a new resource.

* `backup_strategy` - (Optional, List) Specifies the advanced backup policy. Structure is documented below.
* `backup_strategy` - (Optional, List) Specifies the advanced backup policy. The [backup_strategy](#gaussdb_backup_strategy)
object structure is documented below.

* `tags` - (Optional, Map) The key/value pairs to associate with the instance.

<a name="gaussdb_datastore"></a>
The `datastore` block supports:

* `engine` - (Required, String, ForceNew) Specifies the database engine. Only "GeminiDB-Cassandra" is supported now.
Expand All @@ -111,6 +113,7 @@ The `datastore` block supports:
* `storage_engine` - (Required, String, ForceNew) Specifies the storage engine. Only "rocksDB" is supported now.
Changing this parameter will create a new resource.

<a name="gaussdb_backup_strategy"></a>
The `backup_strategy` block supports:

* `start_time` - (Required, String) Specifies the backup time window. Automated backups will be triggered during the
Expand All @@ -127,21 +130,34 @@ The `backup_strategy` block supports:
In addition to all arguments above, the following attributes are exported:

* `id` - Indicates the DB instance ID.

* `status` - Indicates the DB instance status.

* `port` - Indicates the database port.

* `mode` - Indicates the instance type.

* `db_user_name` - Indicates the default username.
* `nodes` - Indicates the instance nodes information. Structure is documented below.

* `nodes` - Indicates the instance nodes information. The [nodes](#gaussdb_nodes) object structure is documented below.

* `private_ips` - Indicates the IP address list of the db.

* `lb_ip_address` - Indicates the LB IP address of the db.

* `lb_port` - Indicates the LB port of the db.

The `nodes` block contains:
<a name="gaussdb_nodes"></a>
The `nodes` block supports:

* `id` - Indicates the node ID.

* `name` - Indicates the node name.

* `status` - Indicates the node status.

* `support_reduce` - Indicates whether the node support reduce or not.

* `private_ip` - Indicates the private IP address of a node.

## Timeouts
Expand Down
26 changes: 21 additions & 5 deletions docs/resources/gaussdb_influx_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,15 @@ The following arguments are supported:
* `force_import` - (Optional, Bool) If specified, try to import the instance instead of creating if the name already
existed.

* `datastore` - (Optional, List, ForceNew) Specifies the database information. Structure is documented below. Changing
this parameter will create a new resource.
* `datastore` - (Optional, List, ForceNew) Specifies the database information. The [datastore](#gaussdb_datastore)
object structure is documented below. Changing this parameter will create a new resource.

* `backup_strategy` - (Optional, List) Specifies the advanced backup policy. Structure is documented below.
* `backup_strategy` - (Optional, List) Specifies the advanced backup policy. The [backup_strategy](#gaussdb_backup_strategy)
object structure is documented below.

* `tags` - (Optional, Map) The key/value pairs to associate with the instance.

<a name="gaussdb_datastore"></a>
The `datastore` block supports:

* `engine` - (Required, String, ForceNew) Specifies the database engine. Only **influxdb** is supported now.
Expand All @@ -112,6 +114,7 @@ The `datastore` block supports:
* `storage_engine` - (Required, String, ForceNew) Specifies the storage engine. Only **rocksDB** is supported now.
Changing this parameter will create a new resource.

<a name="gaussdb_backup_strategy"></a>
The `backup_strategy` block supports:

* `start_time` - (Required, String) Specifies the backup time window. Automated backups will be triggered during the
Expand All @@ -128,21 +131,34 @@ The `backup_strategy` block supports:
In addition to all arguments above, the following attributes are exported:

* `id` - Indicates the DB instance ID.

* `status` - Indicates the DB instance status.

* `port` - Indicates the database port.

* `mode` - Indicates the instance type.

* `db_user_name` - Indicates the default username.
* `nodes` - Indicates the instance nodes information. Structure is documented below.

* `nodes` - Indicates the instance nodes information. The [nodes](#gaussdb_nodes) object structure is documented below.

* `private_ips` - Indicates the IP address list of the db.

* `lb_ip_address` - Indicates the LB IP address of the db.

* `lb_port` - Indicates the LB port of the db.

The `nodes` block contains:
<a name="gaussdb_nodes"></a>
The `nodes` block supports:

* `id` - Indicates the node ID.

* `name` - Indicates the node name.

* `status` - Indicates the node status.

* `support_reduce` - Indicates whether the node support reduce or not.

* `private_ip` - Indicates the private IP address of a node.

## Timeouts
Expand Down

0 comments on commit 0e1c642

Please sign in to comment.