docs(css): fix docs issues.

FlexibleEngineCloud · Sep 13, 2023 · 8b81bf6 · 8b81bf6
1 parent 9d08db8
commit 8b81bf6
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 45 deletions.
diff --git a/docs/resources/css_cluster_v1.md b/docs/resources/css_cluster_v1.md
@@ -58,108 +58,110 @@ resource "flexibleengine_css_cluster_v1" "cluster" {
 
 The following arguments are supported:
 
-* `name` - (Required) Specifies the cluster name. It contains 4 to 32 characters. Only letters, digits,
-  hyphens (-), and underscores (_) are allowed. The value must start with a letter.
+* `name` - (Required, String, ForceNew) Specifies the cluster name. It contains 4 to 32 characters. Only letters,
+  digits,  hyphens (-), and underscores (_) are allowed. The value must start with a letter.
   Changing this parameter will create a new resource.
 
-* `engine_version` - (Required) Specifies the engine version. For example, `7.6.2` and `7.9.3`.
+* `engine_version` - (Required, String, ForceNew) Specifies the engine version. For example, `7.6.2` and `7.9.3`.
    For details, see CSS [Supported Cluster Versions](https://docs.prod-cloud-ocb.orange-business.com/api/css/css_03_0056.html).
    Changing this parameter will create a new resource.
 
-* `node_config` - (Required) Specifies the node configuration. [Structure](#css_node_config_object) is documented below.
-  Changing this parameter will create a new resource.
+* `node_config` - (Required, List, ForceNew) Specifies the node configuration. [node_config](#css_node_config_object)
+  object structure is documented below. Changing this parameter will create a new resource.
 
-* `node_number` - (Optional) Specifies the number of cluster instances. The value range is 1 to 32. Defaults to 1.
+* `node_number` - (Optional, Int) Specifies the number of cluster instances. The value range is 1 to 32. Defaults to 1.
 
-* `engine_type` - (Optional) Specifies the engine type. The default value is `elasticsearch`. Currently, the value
-  can only be "elasticsearch". Changing this parameter will create a new resource.
+* `engine_type` - (Optional, String, ForceNew) Specifies the engine type. The default value is `elasticsearch`.
+  Currently, the value can only be "elasticsearch". Changing this parameter will create a new resource.
 
-* `security_mode` - (Optional) Whether to enable communication encryption and security authentication.
+* `security_mode` - (Optional, Bool, ForceNew) Whether to enable communication encryption and security authentication.
   Available values include *true* and *false*. security_mode is disabled by default.
   Changing this parameter will create a new resource.
 
-* `password` - (Optional) Specifies the password of the cluster administrator admin in security mode.
-  This parameter is mandatory only when security_mode is set to true. Changing this parameter will create a new resource.
+* `password` - (Optional, String, ForceNew) Specifies the password of the cluster administrator admin in security mode.
+  This parameter is mandatory only when security_mode is set to true.Changing this parameter will create a new resource.
   The administrator password must meet the following requirements:
   - The password can contain 8 to 32 characters.
   - The password must contain at least 3 of the following character types: uppercase letters, lowercase letters,
     digits, and special characters (~!@#$%^&*()-_=+\\|[{}];:,<.>/?).
 
-* `backup_strategy` - (Optional) Specifies the advanced backup policy.
-  [Structure](#css_backup_strategy_object) is documented below.
+* `backup_strategy` - (Optional, List) Specifies the advanced backup policy.
+  [backup_strategy](#css_backup_strategy_object) object structure is documented below.
 
   -> **NOTE:** `backup_strategy` requires the authority of *OBS Bucket* and *IAM Agency*.
 
-* `tags` - (Optional) Specifies the key/value pairs to associate with the cluster.
+* `tags` - (Optional, Map) Specifies the key/value pairs to associate with the cluster.
 
 <a name="css_node_config_object"></a>
 The `node_config` block supports:
 
-* `flavor` - (Required) Specifies the instance flavor name. For example: value range of flavor `ess.spec-2u8g`:
+* `flavor` - (Required, String, ForceNew) Specifies the instance flavor name. For example: value range of flavor `ess.
+  spec-2u8g`:
   40 GB to 800 GB; value range of flavor `ess.spec-4u16g`: 40 GB to 1600 GB; value range of flavor `ess.spec-8u32g`:
   80 GB to 3200 GB; value range of flavor `ess.spec-16u64g`: 100 GB to 6400 GB; value range of flavor `ess.spec-32u128g`:
   100 GB to 10240 GB. Changing this parameter will create a new resource.
 
-* `network_info` - (Required) Specifies the network information. [Structure](#css_network_info_object) is documented below.
-  Changing this parameter will create a new resource.
+* `network_info` - (Required, List, ForceNew) Specifies the network information. [network_info](#css_network_info_object)
+  object structure is documented below. Changing this parameter will create a new resource.
 
-* `volume` - (Required) Specifies the information about the volume. [Structure]($css_volume_object) is documented below.
-  Changing this parameter will create a new resource.
+* `volume` - (Required, List, ForceNew) Specifies the information about the volume. [volume]($css_volume_object)
+  object structure is documented below. Changing this parameter will create a new resource.
 
-* `availability_zone` - (Optional) Specifies the availability zone(s). You can set multiple vailability zones,
-  and use commas (,) to separate one from another. Cluster instances will be evenly distributed to each AZ.
-  The `node_number` should be greater than or equal to the number of available zones.
+* `availability_zone` - (Optional, String, ForceNew) Specifies the availability zone(s). You can set multiple
+  vailability zones, and use commas (,) to separate one from another. Cluster instances will be evenly distributed to
+  each AZ. The `node_number` should be greater than or equal to the number of available zones.
   Changing this parameter will create a new resource.
 
 <a name="css_network_info_object"></a>
 The `network_info` block supports:
 
-* `vpc_id` - (Required) Specifies the VPC ID, which is used for configuring cluster network.
+* `vpc_id` - (Required, String, ForceNew) Specifies the VPC ID, which is used for configuring cluster network.
   Changing this parameter will create a new resource.
 
-* `subnet_id` -(Required) Specifies the ID of the VPC Subnet. All instances in a cluster must have the same
-  subnet which should be configured with a **DNS address**. Changing this parameter will create a new resource.
+* `subnet_id` -(Required, String, ForceNew) Specifies the ID of the VPC Subnet. All instances in a cluster must have
+  the same subnet which should be configured with a **DNS address**. Changing this parameter will create a new resource.
 
-* `security_group_id` - (Required) Specifies the security group ID. All instances in a cluster must have the same
-  security group. Changing this parameter will create a new resource.
+* `security_group_id` - (Required, String, ForceNew) Specifies the security group ID. All instances in a cluster must
+  have the same security group. Changing this parameter will create a new resource.
 
 <a name="css_volume_object"></a>
 The `volume` block supports:
 
-* `size` - (Required) Specifies the volume size in GB, which must be a multiple of 10.
+* `size` - (Required, Int) Specifies the volume size in GB, which must be a multiple of 10.
 
-* `volume_type` - (Required) Specifies the volume type. Changing this parameter will create a new resource. Supported value:
+* `volume_type` - (Required, String, ForceNew) Specifies the volume type. Changing this parameter will create a new
+  resource. Supported value:
   - **COMMON**: The SATA disk is used;
   - **HIGH**: The SAS disk is used;
   - **ULTRAHIGH**: The solid-state drive (SSD) is used.
 
 <a name="css_backup_strategy_object"></a>
 The `backup_strategy` block supports:
 
-* `start_time` - (Required) Specifies the time when a snapshot is automatically
+* `start_time` - (Required, String) Specifies the time when a snapshot is automatically
   created everyday. Snapshots can only be created on the hour. The time format is
   the time followed by the time zone, specifically, **HH:mm z**. In the format, HH:mm
   refers to the hour time and z refers to the time zone. For example, "00:00 GMT+01:00"
   and "01:00 GMT+03:00".
 
-* `keep_days` - (Optional) Specifies the number of days to retain the generated
+* `keep_days` - (Optional, Int) Specifies the number of days to retain the generated
    snapshots. Snapshots are reserved for seven days by default.
 
-* `prefix` - (Optional) Specifies the prefix of the snapshot that is automatically
+* `prefix` - (Optional, String) Specifies the prefix of the snapshot that is automatically
   created. The default value is "snapshot".
 
-## Attributes Reference
+## Attribute Reference
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
 * `endpoint` - Indicates the IP address and port number.
 
 * `created` - Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
 
-* `nodes` - List of node objects. [Structure](#css_al_nodes_object) is documented below.
+* `nodes` - List of node objects. [nodes](#css_al_nodes_object) object structure is documented below.
 
 <a name="css_al_nodes_object"></a>
-The `nodes` block contains:
+The `nodes` block supports:
 
 * `id` - Instance ID.
 
@@ -171,5 +173,5 @@ The `nodes` block contains:
 
 This resource provides the following timeouts configuration options:
 
-* `create` - Default is 60 minute.
-* `update` - Default is 60 minute.
+* `create` - Default is 60 minutes.
+* `update` - Default is 60 minutes.
diff --git a/docs/resources/css_snapshot_v1.md b/docs/resources/css_snapshot_v1.md
@@ -1,10 +1,10 @@
 ---
 subcategory: "Cloud Search Service (CSS)"
 description: ""
-page_title: "flexibleengine_css_cluster_v1"
+page_title: "flexibleengine_css_snapshot_v1"
 ---
 
-# flexibleengine_css_cluster_v1
+# flexibleengine_css_snapshot_v1
 
 CSS cluster snapshot management
 
@@ -23,26 +23,26 @@ resource "flexibleengine_css_snapshot_v1" "snapshot" {
 
 The following arguments are supported:
 
-* `name` - (Required) Specifies the snapshot name. The snapshot name must
+* `name` - (Required, String, ForceNew) Specifies the snapshot name. The snapshot name must
   start with a letter and contains 4 to 64 characters consisting of only
   lowercase letters, digits, hyphens (-), and underscores (_).
   Changing this parameter will create a new resource.
 
-* `cluster_id` - (Required) Specifies ID of the CSS cluster where index data is to be backed up.
+* `cluster_id` - (Required, String, ForceNew) Specifies ID of the CSS cluster where index data is to be backed up.
   Changing this parameter will create a new resource.
 
-* `indices` - (Optional) Specifies the name of the index to be backed up. Multiple index names
+* `indices` - (Optional, String, ForceNew) Specifies the name of the index to be backed up. Multiple index names
   are separated by commas (,). By default, data of all indices is backed up. You can use the
   asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then
   data of indices with the name prefix of 2018-06 will be backed up.
   The value contains 0 to 1024 characters. Uppercase letters, spaces, and certain special
   characters (including "\<|>/?) are not allowed.
   Changing this parameter will create a new resource.
 
-* `description` - (Optional) Specifies the description of a snapshot. The value contains 0 to 256 characters,
-  and angle brackets (<) and (>) are not allowed. Changing this parameter will create a new resource.
+* `description` - (Optional, String, ForceNew) Specifies the description of a snapshot. The value contains 0 to 256
+  characters, and angle brackets (<) and (>) are not allowed. Changing this parameter will create a new resource.
 
-## Attributes Reference
+## Attribute Reference
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
@@ -52,6 +52,13 @@ In addition to the arguments listed above, the following computed attributes are
 
 * `backup_type` - Indicates the snapshot creation mode, the value should be "manual" or "automated".
 
+## Timeouts
+
+This resource provides the following timeouts configuration options:
+
+* `create` - Default is 10 minutes.
+* `delete` - Default is 3 minutes.
+
 ## Import
 
 This resource can be imported by specifying the CSS cluster ID and snapshot ID