Add Chenai to the doc (#5813)

Co-authored-by: michaelkad <[email protected]>
IBM-Cloud · Nov 27, 2024 · 72949de · 72949de
1 parent e068524
commit 72949de
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 48 deletions.
diff --git a/website/docs/r/pi_capture.html.markdown b/website/docs/r/pi_capture.html.markdown
@@ -1,5 +1,4 @@
 ---
-
 subcategory: "Power Systems"
 layout: "ibm"
 page_title: "IBM: pi_capture"
@@ -8,40 +7,46 @@ description: |-
 ---
 
 # ibm_pi_capture
+
 Create or delete for Capture Power System Virtual Server Instance
 
 **Note:-**
 If `pi_capture_destination` is `Cloud-Storage` then delete bucket object functionality not supported by this resource , hence user need to delete bucket object manually from `Cloud Storage bucket`.
 
 For more information, about IBM power virtual server cloud, see [getting started with IBM Power Systems Virtual Servers](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-getting-started).
+
 ## Example usage
+
 The following example creates a Capture Power System Virtual Server Instance.
 
 ```terraform
 resource "ibm_pi_capture" "test_capture" {
-        pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
-        pi_capture_name = "terraform-test-capture"
-        pi_instance_name = "terraform-test-instance"
-        pi_capture_destination = "image-catalog"
+  pi_cloud_instance_id   = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
+  pi_capture_name        = "terraform-test-capture"
+  pi_instance_name       = "terraform-test-instance"
+  pi_capture_destination = "image-catalog"
 }
 ```
+
 ```terraform
 resource "ibm_pi_capture" "test_capture" {
-	pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
-	pi_capture_name = "test-capture"
-	pi_instance_name = "test-vm"
-	pi_capture_destination = "cloud-storage"
-	pi_capture_cloud_storage_region = "us-east"
-	pi_capture_cloud_storage_access_key = "<Cloud Storage Access key>"
-	pi_capture_cloud_storage_secret_key = "<Cloud Storage Secret key>"
-	pi_capture_storage_image_path = "test-bucket"
+  pi_cloud_instance_id                = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
+  pi_capture_name                     = "test-capture"
+  pi_instance_name                    = "test-vm"
+  pi_capture_destination              = "cloud-storage"
+  pi_capture_cloud_storage_region     = "us-east"
+  pi_capture_cloud_storage_access_key = "<Cloud Storage Access key>"
+  pi_capture_cloud_storage_secret_key = "<Cloud Storage Secret key>"
+  pi_capture_storage_image_path       = "test-bucket"
 }
 ```
-**Note**
-* Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
-* If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
-  * `region` - `lon`
-  * `zone` - `lon04`
+
+### Notes
+
+- Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
+- If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
+  - `region` - `lon`
+  - `zone` - `lon04`
 
   Example usage:
 
@@ -51,43 +56,44 @@ resource "ibm_pi_capture" "test_capture" {
       zone      =   "lon04"
     }
   ```
+
 ## Timeouts
 
 ibm_pi_capture provides the following [timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:
 
-- **create** - (Default 75 minutes) Used for creating capture instance .
+- **create** - (Default 75 minutes) Used for creating capture instance.
 - **delete** - (Default 50 minutes) Used for deleting capture instance.
 
-## Argument reference 
-Review the argument references that you can specify for your resource. 
+## Argument reference
+
+Review the argument references that you can specify for your resource.
 
 - `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
 - `pi_capture_name` - (Required, String) Name of the deployable image created for the captured PVMInstance.
 - `pi_instance_name` - (Required, String) The name of the instance.
 - `pi_capture_destination`- (Required, String) Destination for the deployable image.
 `[image-catalog,cloud-storage,both]`
 - `pi_capture_volume_ids`- (Optional, List of String)  List of Data volume IDs to include in the captured   PVMInstance.
-- `pi_capture_cloud_storage_region`- (Optional,String) The Cloud Object Storage region. Supported COS regions are: `au-syd`, `br-sao`, `ca-tor`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
+- `pi_capture_cloud_storage_region`- (Optional,String) The Cloud Object Storage region. Supported COS regions are: `au-syd`, `br-sao`, `ca-tor`, `che01`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
 - `pi_capture_cloud_storage_access_key`- (Optional,String) Cloud Storage Access key
 - `pi_capture_cloud_storage_secret_key`- (Optional,String) Cloud Storage Secret key
 - `pi_capture_storage_image_path` - (Optional,String) Cloud Storage Image Path (bucket-name [/folder/../..])
 - `pi_user_tags` - (Optional, List) List of user tags attached to the resource.
 
 ## Attribute reference
+
 In addition to all argument reference list, you can access the following attribute reference after your resource is created.
 
 - `crn` - (String) The CRN of the resource.
 - `id` - (String) The image id of the capture instance. The ID is composed of `<pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>`.
 - `image_id` - (String) The image id of the capture instance.
 
-
 ## Import
 
 The `ibm_pi_capture` resource can be imported by using `pi_cloud_instance_id` `pi_capture_name` and `pi_capture_destination`.
 
-**Example**
-```
-$ terraform import ibm_pi_capture.example d7bec597-4726-451f-8a63-e62e6f19c32c/test-capture/image-catalog
+### Example
 
+```bash
+terraform import ibm_pi_capture.example d7bec597-4726-451f-8a63-e62e6f19c32c/test-capture/image-catalog
 ```
-
diff --git a/website/docs/r/pi_image.html.markdown b/website/docs/r/pi_image.html.markdown
@@ -1,5 +1,4 @@
 ---
-
 subcategory: "Power Systems"
 layout: "ibm"
 page_title: "IBM: pi_image"
@@ -83,7 +82,7 @@ Review the argument references that you can specify for your resource.
 - `pi_image_bucket_access` - (Optional, String) Indicates if the bucket has public or private access. The default value is `public`.
 - `pi_image_bucket_file_name` - (Optional, String) Cloud Object Storage image filename
   - `pi_image_bucket_file_name` is required with `pi_image_bucket_name`
-- `pi_image_bucket_region` - (Optional, String) Cloud Object Storage region. Supported COS regions are: `au-syd`, `br-sao`, `ca-tor`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
+- `pi_image_bucket_region` - (Optional, String) Cloud Object Storage region. Supported COS regions are: `au-syd`, `br-sao`, `ca-tor`, `che01`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
   - `pi_image_bucket_region` is required with `pi_image_bucket_name`
 - `pi_image_secret_key` - (Optional, String, Sensitive) Cloud Object Storage secret key; required for buckets with private access.
   - `pi_image_secret_key` is required with `pi_image_access_key`

diff --git a/website/docs/r/pi_image_export.html.markdown b/website/docs/r/pi_image_export.html.markdown
@@ -1,5 +1,4 @@
 ---
-
 subcategory: "Power Systems"
 layout: "ibm"
 page_title: "IBM: pi_image_export"
@@ -8,30 +7,33 @@ description: |-
 ---
 
 # ibm_pi_image_export
+
 Export an image to IBM Cloud Object Storage for Power Systems Virtual Server instance. For more information, about IBM power virtual server cloud, see [getting started with IBM Power Systems Virtual Servers](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-getting-started).
 
 ## Example usage
+
 The following example enables you to export an image:
 
 ```terraform
 resource "ibm_pi_image_export" "testacc_image_export"{
-  pi_cloud_instance_id = "<value of the cloud_instance_id>"
-  pi_image_id       = "test_image"
-  pi_image_bucket_name = "images-public-bucket"
+  pi_cloud_instance_id   = "<value of the cloud_instance_id>"
+  pi_image_id            = "test_image"
+  pi_image_access_key    = "dummy-access-key"
+  pi_image_bucket_name   = "images-public-bucket"
   pi_image_bucket_region = "us-south"
-  pi_image_access_key = "dummy-access-key"
-  pi_image_secret_key = "dummy-secret-key"
+  pi_image_secret_key    = "dummy-secret-key"
 }
 ```
 
-**Note**
-* Ensure the exported file is cleaned up manually from the Cloud Object Storage when no longer needed. Power Systems Virtual Server does not support deleting the exported image. Updating any attribute will result in creating a new Export job.
-* Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
-* If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
-  * `region` - `lon`
-  * `zone` - `lon04`
+### Notes
+
+- Ensure the exported file is cleaned up manually from the Cloud Object Storage when no longer needed. Power Systems Virtual Server does not support deleting the exported image. Updating any attribute will result in creating a new Export job.
+- Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
+- If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
+  - `region` - `lon`
+  - `zone` - `lon04`
 
-  Example usage:
+Example usage:
 
   ```terraform
     provider "ibm" {
@@ -44,22 +46,21 @@ resource "ibm_pi_image_export" "testacc_image_export"{
 
 The   ibm_pi_image   provides the following [timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:
 
-- **Create** The export image to IBM Cloud Object Storage bucket is considered failed if no response is received for 60 minutes. 
+- **create** The export image to IBM Cloud Object Storage bucket is considered failed if no response is received for 60 minutes.
 
 ## Argument reference
-Review the argument references that you can specify for your resource. 
+
+Review the argument references that you can specify for your resource.
 
 - `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
 - `pi_image_id` - (Required, String) The Image ID of existing source image; required for image export.
 - `pi_image_bucket_name` - (Required, String) The Cloud Object Storage bucket name; `bucket-name[/optional/folder]`
 - `pi_image_access_key` - (Required, String, Sensitive) The Cloud Object Storage access key; required for buckets with private access.
-- `pi_image_bucket_region` - (Required, String) The Cloud Object Storage region. Supported COS regions are:`au-syd`, `br-sao`, `ca-tor`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
+- `pi_image_bucket_region` - (Required, String) The Cloud Object Storage region. Supported COS regions are:`au-syd`, `br-sao`, `ca-tor`, `che01`, `eu-de`, `eu-es`, `eu-gb`, `jp-osa`, `jp-tok`, `us-east`, `us-south`.
 - `pi_image_secret_key` - (Required, String, Sensitive) The Cloud Object Storage secret key; required for buckets with private access.
 
-
-
 ## Attribute reference
+
 In addition to all argument reference list, you can access the following attribute reference after your resource is created.
 
 - `id` - (String) The unique identifier of an image export resource. The ID is composed of `<image_id>/<bucket_name>/<bucket_region>`.
-