doc: fix rdma_cluster_id desc (#130)

* doc: fix rdma_cluster_id desc

* build: update version in config and rssd example

Author: fioncat

CHANGELOG.md

@@ -1,4 +1,9 @@
 ## 1.33.0 (Unreleased)
+
+NOTES:
+
+* fix `rdma_cluster_id` doc.
+
 ## 1.32.0 (2022-09-19)
 
 FEATURES:

examples/rssd/README.md

@@ -0,0 +1,21 @@
+# RSSD Example
+
+The RSSD example that creates a RSSD udisk attaches to a `O` uhost.
+
+To run, configure your UCloud provider as described in https://www.terraform.io/docs/providers/ucloud/index.html
+
+## Requirements
+
+- [Terraform](https://www.terraform.io/downloads.html) 0.13.x
+
+## Setup Environment
+
+```sh
+export UCLOUD_PUBLIC_KEY="your public key"
+export UCLOUD_PRIVATE_KEY="your private key"
+export UCLOUD_PROJECT_ID="your project id"
+```
+
+## Running the example
+
+run `terraform apply`

examples/rssd/main.tf

@@ -2,6 +2,7 @@ terraform {
   required_providers {
     ucloud = {
       source = "ucloud/ucloud"
+      version = "~>1.32.1"
     }
   }
 }

ucloud/config.go

@@ -69,7 +69,7 @@ func (c *Config) Client() (*UCloudClient, error) {
 	// enable auto retry with http/connection error
 	cfg.MaxRetries = c.MaxRetries
 	cfg.LogLevel = log.PanicLevel
-	cfg.UserAgent = "Terraform-UCloud/1.32.0"
+	cfg.UserAgent = "Terraform-UCloud/1.32.1"
 	cfg.BaseUrl = c.BaseURL
 
 	cred := auth.NewCredential()

website/docs/d/disks.html.markdown

@@ -51,4 +51,3 @@ The attribute (`disks`) support the following:
 * `create_time` - The creation time of Disk, formatted in RFC3339 time string.
 * `expire_time` - The expiration time of disk, formatted in RFC3339 time string.
 * `status` - The status of disk. Possible values are: `Available`, `InUse`, `Detaching`, `Initializating`, `Failed`, `Cloning`, `Restoring`, `RestoreFailed`.
-* `rdma_cluster_id` - The RDMA Cluster ID of disk. This is only useful with disk type `rssd_data_disk`. If you need to attach a `rssd_data_disk`to an instance, the `rdma_cluster_id` MUST BE PAIRED.

website/docs/d/instances.html.markdown

@@ -73,4 +73,3 @@ The attribute (`ip_set`) supports the following:
 
 * `internet_type` - Type of Elastic IP routes.
 * `ip` - Elastic IP address.
-* `rdma_cluster_id` - The RDMA Cluster ID of instance. This is only useful for instance with machine type `O`.

website/docs/index.html.markdown

@@ -23,7 +23,7 @@ terraform {
   required_providers {
     ucloud = {
       source = "ucloud/ucloud"
-      version = "~>1.22.0"
+      version = "~>1.32.1"
     }
   }
 }
@@ -91,7 +91,7 @@ terraform {
   required_providers {
     ucloud = {
       source = "ucloud/ucloud"
-      version = "~>1.22.0"
+      version = "~>1.32.1"
     }
   }
 }

website/docs/r/disk.html.markdown

@@ -49,11 +49,12 @@ In addition to all arguments above, the following attributes are exported:
 * `create_time` - The time of creation of disk, formatted in RFC3339 time string.
 * `expire_time` - The expiration time of disk, formatted in RFC3339 time string.
 * `status` -  The status of disk. Possible values are: `Available`, `InUse`, `Detaching`, `Initializating`, `Failed`, `Cloning`, `Restoring`, `RestoreFailed`.
+* `rdma_cluster_id` - The RDMA Cluster ID of disk. This is only useful with disk type `rssd_data_disk`. If you need to attach a `rssd_data_disk`to an instance, the `rdma_cluster_id` MUST BE PAIRED.
 
 ## Import
 
 Disk can be imported using the `id`, e.g.
 
 ```
 $ terraform import ucloud_disk.example bsm-abcdefg
-```
+```

website/docs/r/instance.html.markdown

@@ -90,7 +90,7 @@ The following arguments are supported:
 - - -
 
 * `allow_stopping_for_update` - (Optional) If you try to update some properties which requires stopping the instance, you must set `allow_stopping_for_update` to `true` in your config to allows Terraform to stop the instance to update its properties like `instance_type`, `root_password`, `boot_disk_size`, `data_disk_size`.
- 
+
 * `root_password` - (Optional) The password for the instance, which contains 8-30 characters, and at least 2 items of capital letters, lower case letters, numbers and special characters. The special characters include <code>`()~!@#$%^&*-+=_|{}\[]:;'<>,.?/</code>. If not specified, terraform will auto-generate a password. 
 
     ~> **Note** If you want to update this value, you must set `allow_stopping_for_update`to `true`.
@@ -117,12 +117,10 @@ The following arguments are supported:
 * `delete_disks_with_instance` - (Optional, ForceNew, Required when set `data_disks`)  Whether the cloud data disks attached instance should be destroyed on instance termination.
 
  ~> **NOTE:** We recommend set `delete_disks_with_instance` to `true` means delete cloud data disks attached to instance when instance termination. Otherwise, the cloud data disks will be not managed by the terraform after instance termination.
- 
+
  * `network_interface` - (Optional, ForceNew) Additional network interface eips to attach to the instance. `network_interface` configurations only apply on resource creation. The count of `network_interface` can only be one. See [network_interface](#network_interface) below for details on attributes. When set `network_interface`, the argument `delete_eips_with_instance` must bet set.
  * `delete_eips_with_instance` - (Optional, ForceNew, Required when set `network_interface`)  Whether the network interface eips associated instance should be destroyed on instance termination.
- 
-* `min_cpu_platform` - (Optional) Specifies a minimum CPU platform for the the VM instance. (Default: `Intel/Auto`). You may refer to [product documentation](https://docs.ucloud.cn/uhost/introduction/uhost/type_new) and [API documentation](https://docs.ucloud.cn/api/uhost-api/create_uhost_instance).
-      
+* `min_cpu_platform` - (Optional) Specifies a minimum CPU platform for the the VM instance. (Default: `Intel/Auto`). You may refer to [product documentation](https://docs.ucloud.cn/uhost/introduction/uhost/type_new) and [API documentation](https://docs.ucloud.cn/api/uhost-api/create_uhost_instance).    
 ### data_disks
 
 The `data_disks` supports the following:
@@ -163,6 +161,7 @@ In addition to all arguments above, the following attributes are exported:
 * `status` - Instance current status. Possible values are `Initializing`, `Starting`, `Running`, `Stopping`, `Stopped`, `Install Fail`, `ResizeFail` and `Rebooting`.
 * `ip_set` - It is a nested type which documented below.
 * `disk_set` - It is a nested type which documented below.
+* `rdma_cluster_id` - The RDMA Cluster ID of instance. This is only available when machine type is `O`.
 
 - - -