fixed instance, instance template documents, alignment (IBM-Cloud#5850)

* fixed instance, instance template documents, alignment * document fix for cluster_network_attachments name
powervs-ibm · Dec 6, 2024 · 359d919 · 359d919
1 parent 442b4c3
commit 359d919
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 48 deletions.
diff --git a/website/docs/r/is_instance.html.markdown b/website/docs/r/is_instance.html.markdown
@@ -639,10 +639,30 @@ Cluster Networks for VPC is available for select customers only. Contact IBM Sup
 - `cluster_network_attachments` - (Optional, List) The cluster network attachments for this virtual server instance.The cluster network attachments are ordered for consistent instance configuration.
 
   Nested schema for **cluster_network_attachments**:
-	- `href` - (Required, String) The URL for this instance cluster network attachment.
-	- `id` - (Required, String) The unique identifier for this instance cluster network attachment.
-	- `name` - (Required, String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
-	- `resource_type` - (Required, String) The resource type.
+	- `name` - (Required, String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance. (`name` is a apply once attribute, changing it will not be detected by terraform)
+  - `cluster_network_interface` - (Required, List) The cluster network interface for this instance cluster network attachment.
+
+      Nested schema for **cluster_network_interface**:
+      - `id` - (Required, String) The unique identifier for this cluster network interface.
+      - `name` - (Required, String) The name for this cluster network interface. The name is unique across all interfaces in the cluster network.
+      - `primary_ip` - (Required, List) The primary IP for this cluster network interface.
+
+          Nested schema for **primary_ip**:
+          - `address` - (Required, String) The IP address.If the address is pending allocation, the value will be `0.0.0.0`.This property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) to support IPv6 addresses in the future.
+          - `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
+
+          - `href` - (Required, String) The URL for this cluster network subnet reserved IP.
+          - `id` - (Required, String) The unique identifier for this cluster network subnet reserved IP.
+          - `name` - (Required, String) The name for this cluster network subnet reserved IP. The name is unique across all reserved IPs in a cluster network subnet.
+          - `resource_type` - (Computed, String) The resource type.
+      - `subnet` - (Required, List)
+
+          Nested schema for **subnet**:
+          - `id` - (Required, String) The unique identifier for this cluster network subnet.
+
+  ~> **Note:** 
+  **&#x2022;** `cluster_network_attachments` updation requires the instance to be in stopped state. Use `action` attribute or `ibm_is_instance_action` resource accordingly to stop/start the instance.</br>
+  **&#x2022;** Using cluster_network_attachments in `ibm_is_instance` and `ibm_is_instance_cluster_network_attachment` resource together would result in changes shown in both resources alternatively, use either of them or use meta lifecycle argument `ignore_changes` on `cluster_network_attachments`</br>
 
 - `confidential_compute_mode` - (Optional, String) The confidential compute mode to use for this virtual server instance.If unspecified, the default confidential compute mode from the profile will be used. **Constraints: Allowable values are: `disabled`, `sgx`** {Select Availability}
 
@@ -870,6 +890,14 @@ In addition to all argument reference list, you can access the following attribu
 		  Nested schema for `deleted`:
       - `more_info`  - (String) Link to documentation about deleted resources.
 
+- `cluster_network_attachments` - (List) The cluster network attachments for this virtual server instance.The cluster network attachments are ordered for consistent instance configuration.
+    Nested schema for **cluster_network_attachments**:
+    - `href` - (String) The URL for this instance cluster network attachment.
+    - `id` - (String) The unique identifier for this instance cluster network attachment.
+    - `name` - (String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
+    - `resource_type` - (String) The resource type.
+
+
 - `cluster_network` - (List) If present, the cluster network that this virtual server instance resides in.
   Nested schema for **cluster_network**:
 	- `crn` - (String) The CRN for this cluster network.

diff --git a/website/docs/r/is_instance_cluster_network_attachment.html.markdown b/website/docs/r/is_instance_cluster_network_attachment.html.markdown
@@ -145,62 +145,84 @@ resource "ibm_is_instance_action" "is_instance_start_after" {
 
 You can specify the following arguments for this resource.
 
+  ~> **Note:** 
+  **&#x2022;** Instance cluster network attachment creation requires the instance to be in stopped state. Use `ibm_is_instance_action` resource accordingly to stop/start the instance.</br>
+  **&#x2022;** Using cluster_network_attachments in `ibm_is_instance` and `ibm_is_instance_cluster_network_attachment` resource together would result in changes shown in both resources alternatively, use either of them or use meta lifecycle argument `ignore_changes` on `ibm_is_instance` resource.</br>
+
+
 - `before` - (Optional, List) The instance cluster network attachment that is immediately before. If absent, this is thelast instance cluster network attachment.
 	Nested schema for **before**:
-	- `href` - (Required, String) The URL for this instance cluster network attachment.
 	- `id` - (Required, String) The unique identifier for this instance cluster network attachment.
-	- `name` - (Computed, String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
-	- `resource_type` - (Computed, String) The resource type.
 - `cluster_network_interface` - (Required, List) The cluster network interface for this instance cluster network attachment.
 
 	Nested schema for **cluster_network_interface**:
-	- `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
-		Nested schema for **deleted**:
-		- `more_info` - (Computed, String) Link to documentation about deleted resources.
-	- `href` - (Required, String) The URL for this cluster network interface.
+
 	- `id` - (Required, String) The unique identifier for this cluster network interface.
 	- `name` - (Required, String) The name for this cluster network interface. The name is unique across all interfaces in the cluster network.
 	- `primary_ip` - (Required, List) The primary IP for this cluster network interface.
 		
 		Nested schema for **primary_ip**:
 		- `address` - (Required, String) The IP address.If the address is pending allocation, the value will be `0.0.0.0`.This property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) to support IPv6 addresses in the future.
-		- `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
-			
-			Nested schema for **deleted**:
-			- `more_info` - (Computed, String) Link to documentation about deleted resources.
-		- `href` - (Required, String) The URL for this cluster network subnet reserved IP.
 		- `id` - (Required, String) The unique identifier for this cluster network subnet reserved IP.
 		- `name` - (Required, String) The name for this cluster network subnet reserved IP. The name is unique across all reserved IPs in a cluster network subnet.
-		- `resource_type` - (Computed, String) The resource type.
-	- `resource_type` - (Computed, String) The resource type.
 	- `subnet` - (Required, List)
 		
 		Nested schema for **subnet**:
-		- `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
-
-			Nested schema for **deleted**:
-			- `more_info` - (Computed, String) Link to documentation about deleted resources.
-		- `href` - (Required, String) The URL for this cluster network subnet.
 		- `id` - (Required, String) The unique identifier for this cluster network subnet.
-		- `name` - (Computed, String) The name for this cluster network subnet. The name is unique across all cluster network subnets in the cluster network.
-		- `resource_type` - (Computed, String) The resource type.
+
 - `instance_id` - (Required, Forces new resource, String) The virtual server instance identifier.
 - `name` - (Optional, String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
 
 ## Attribute Reference
 
 After your resource is created, you can read values from the listed arguments and the following attributes.
 
+
 - `id` - The unique identifier of the InstanceClusterNetworkAttachment.
+- `before` - (List) The instance cluster network attachment that is immediately before. If absent, this is thelast instance cluster network attachment.
+	Nested schema for **before**:
+	- `href` - (String) The URL for this instance cluster network attachment.
+	- `id` - (String) The unique identifier for this instance cluster network attachment.
+	- `name` - (String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
+	- `resource_type` - (String) The resource type.
+- `cluster_network_interface` - (List) The cluster network interface for this instance cluster network attachment.
+	Nested schema for **cluster_network_interface**:
+	- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
+		Nested schema for **deleted**:
+		- `more_info` - (String) Link to documentation about deleted resources.
+	- `href` - (String) The URL for this cluster network interface.
+	- `id` - (String) The unique identifier for this cluster network interface.
+	- `name` - (String) The name for this cluster network interface. The name is unique across all interfaces in the cluster network.
+	- `primary_ip` - (List) The primary IP for this cluster network interface.
+		Nested schema for **primary_ip**:
+		- `address` - (String) The IP address.If the address is pending allocation, the value will be `0.0.0.0`.This property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) to support IPv6 addresses in the future.
+		- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
+
+			Nested schema for **deleted**:
+			- `more_info` - (String) Link to documentation about deleted resources.
+		- `href` - (String) The URL for this cluster network subnet reserved IP.
+		- `id` - (String) The unique identifier for this cluster network subnet reserved IP.
+		- `name` - (String) The name for this cluster network subnet reserved IP. The name is unique across all reserved IPs in a cluster network subnet.
+		- `resource_type` - (String) The resource type.
+	- `resource_type` - (String) The resource type.
+	- `subnet` - (List)
+		Nested schema for **subnet**:
+		- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
+			Nested schema for **deleted**:
+			- `more_info` - (String) Link to documentation about deleted resources.
+		- `href` - (String) The URL for this cluster network subnet.
+		- `id` - (String) The unique identifier for this cluster network subnet.
+		- `name` - (String) The name for this cluster network subnet. The name is unique across all cluster network subnets in the cluster network.
+		- `resource_type` - (String) The resource type.
 - `href` - (String) The URL for this instance cluster network attachment.
 - `instance_cluster_network_attachment_id` - (String) The unique identifier for this instance cluster network attachment.
 - `lifecycle_reasons` - (List) The reasons for the current `lifecycle_state` (if any).
-
 	Nested schema for **lifecycle_reasons**:
-	- `code` - (String) A reason code for this lifecycle state:- `internal_error`: internal error (contact IBM support)- `resource_suspended_by_provider`: The resource has been suspended (contact IBM  support)The enumerated values for this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future. Allowable values are: `internal_error`, `resource_suspended_by_provider`. 
+	- `code` - (String) A reason code for this lifecycle state:- `internal_error`: internal error (contact IBM support)- `resource_suspended_by_provider`: The resource has been suspended (contact IBM  support)The enumerated values for this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
 	- `message` - (String) An explanation of the reason for this lifecycle state.
 	- `more_info` - (String) Link to documentation about the reason for this lifecycle state.
 - `lifecycle_state` - (String) The lifecycle state of the instance cluster network attachment. Allowable values are: `deleting`, `failed`, `pending`, `stable`, `suspended`, `updating`, `waiting`.
+- `name` - (String) The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
 - `resource_type` - (String) The resource type. Allowable values are: `instance_cluster_network_attachment`.