Merge pull request #1154 from ovh/dev/aamstutz/hide-s3-objects

feat(cloud_project_storage): Add field to avoid saving objects in state

Author: amstuta

docs/data-sources/cloud_project_storage.md

@@ -28,6 +28,7 @@ data "ovh_cloud_project_storage" "storage" {
 
 ### Optional
 
+- `hide_objects` (Boolean) If true, objects list will not be saved in state (useful for large buckets)
 - `limit` (Number) Limit the number of objects returned (1000 maximum, defaults to 1000)
 - `marker` (String) Key to start with when listing objects
 - `prefix` (String) List objects whose key begins with this prefix

docs/data-sources/okms_secret.md

@@ -70,21 +70,21 @@ In addition to the arguments above, the following attributes are exported:
 - `version` (Number) The resolved version number (requested or current latest).
 - `data` (String, Sensitive) Raw JSON secret payload (present only if `include_data` is true).
 - `metadata` (Block) Secret metadata:
-	- `cas_required` (Boolean)
-	- `created_at` (String)
-	- `updated_at` (String)
-	- `current_version` (Number)
-	- `oldest_version` (Number)
-	- `max_versions` (Number)
-	- `deactivate_version_after` (String)
-	- `custom_metadata` (Map of String)
+  - `cas_required` (Boolean)
+  - `created_at` (String)
+  - `updated_at` (String)
+  - `current_version` (Number)
+  - `oldest_version` (Number)
+  - `max_versions` (Number)
+  - `deactivate_version_after` (String)
+  - `custom_metadata` (Map of String)
 - `iam` (Block) IAM resource metadata:
-	- `display_name` (String)
-	- `id` (String)
-	- `tags` (Map of String)
-	- `urn` (String)
+  - `display_name` (String)
+  - `id` (String)
+  - `tags` (Map of String)
+  - `urn` (String)
 
 ## Behavior & Notes
 
 - The `data` attribute retains the raw JSON returned by the API. Use `jsondecode()` to work with individual keys.
-- Changing only `include_data` (true -> false) will cause the `data` attribute to become null in subsequent refreshes (state no longer holds the payload).
+- Changing only `include_data` (true -> false) will cause the `data` attribute to become null in subsequent refreshes (state no longer holds the payload).

docs/resources/cloud_project_storage.md

@@ -35,6 +35,7 @@ resource "ovh_cloud_project_storage" "storage" {
 ### Optional
 
 - `encryption` (Attributes) Encryption configuration (see [below for nested schema](#nestedatt--encryption))
+- `hide_objects` (Boolean) If true, objects list will not be saved in state (useful for large buckets)
 - `limit` (Number) Limit the number of objects returned (1000 maximum, defaults to 1000)
 - `marker` (String) Key to start with when listing objects
 - `owner_id` (Number) Container owner user ID

docs/resources/dedicated_server.md

@@ -140,7 +140,7 @@ resource "ovh_dedicated_server" "server" {
       * `raid_level` - Software raid type
       * `size` - Partition size in MiB
     * `scheme_name` - Partitioning scheme (if applicable with selected operating system)
-* `properties` - Deprecated, has no effect
+* `properties` - Attribute 'properties' is deprecated and has no effect
 
 ### Arguments used to control the lifecycle of a dedicated server
 

docs/resources/dedicated_server_reinstall_task.md

@@ -128,7 +128,7 @@ resource "ovh_dedicated_server_reinstall_task" "server_install" {
     http_headers = {
       Authorization = "Basic bG9naW46cGFzc3dvcmQ="
     }
-    image_url              = "https://github.com/ashmonger/akution_test/releases/download/0.5-compress/deb11k6.qcow2"
+    image_url           = "https://github.com/ashmonger/akution_test/releases/download/0.5-compress/deb11k6.qcow2"
   }
 }
 ```
@@ -239,7 +239,7 @@ The following arguments are supported:
 
 ~> **WARNING** Some customizations may be required on some Operating Systems. [Check how to list the available and required customization(s) for your operating system](https://help.ovhcloud.com/csm/en-dedicated-servers-api-os-installation?id=kb_article_view&sysparm_article=KB0061951#os-inputs) (do not forget to adapt camel case customization name to snake case parameter).
 
-* `properties` - Deprecated, has no effect
+* `properties` - Attribute 'properties' is deprecated and has no effect.
 
 * `storage`: OS reinstallation storage configurations. [More details about disks, hardware/software RAID and partitioning configuration](https://help.ovhcloud.com/csm/en-dedicated-servers-api-partitioning?id=kb_article_view&sysparm_article=KB0043882) (do not forget to adapt camel case parameters to snake case parameters).
   * `disk_group_id`: Disk group id to install the OS to (default is 0, meaning automatic).

docs/resources/okms_secret.md

@@ -47,6 +47,25 @@ output "api_key" {
 }
 ```
 
+# Reading a field from the secret version data:
+
+```terraform
+data "ovh_okms_secret" "latest_with_data" {
+	okms_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+	path         = "app/api_credentials"
+	include_data = true
+}
+
+locals {
+	secret_obj = jsondecode(data.ovh_okms_secret.latest_with_data.data)
+}
+
+output "api_key" {
+	value     = local.secret_obj.api_key
+	sensitive = true
+}
+```
+
 Updating the secret (new version) while enforcing optimistic concurrency control using CAS:
 
 ```terraform

ovh/data_cloud_project_storage.go

@@ -7,6 +7,7 @@ import (
 	"strconv"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	ovhtypes "github.com/ovh/terraform-provider-ovh/v2/ovh/types"
 )
 
 var _ datasource.DataSourceWithConfigure = (*cloudProjectStorageDataSource)(nil)
@@ -75,6 +76,10 @@ func (d *cloudProjectStorageDataSource) Read(ctx context.Context, req datasource
 		return
 	}
 
+	if data.HideObjects.ValueBool() {
+		data.Objects = ovhtypes.NewListNestedObjectValueOfNull[ObjectsValue](ctx)
+	}
+
 	// Save data into Terraform state
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }

ovh/data_cloud_project_storage_gen.go

@@ -10,6 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
+	ovhtypes "github.com/ovh/terraform-provider-ovh/v2/ovh/types"
 )
 
 var _ resource.ResourceWithConfigure = (*cloudProjectStorageResource)(nil)
@@ -115,6 +116,10 @@ func (r *cloudProjectStorageResource) Read(ctx context.Context, req resource.Rea
 
 	responseData.MergeWith(&data)
 
+	if data.HideObjects.ValueBool() {
+		responseData.Objects = ovhtypes.NewListNestedObjectValueOfNull[ObjectsValue](ctx)
+	}
+
 	// Save updated data into Terraform state
 	resp.Diagnostics.Append(resp.State.Set(ctx, &responseData)...)
 }
@@ -168,6 +173,10 @@ func (r *cloudProjectStorageResource) Update(ctx context.Context, req resource.U
 
 	responseData.MergeWith(&planData)
 
+	if planData.HideObjects.ValueBool() {
+		responseData.Objects = ovhtypes.NewListNestedObjectValueOfNull[ObjectsValue](ctx)
+	}
+
 	// Save updated data into Terraform state
 	resp.Diagnostics.Append(resp.State.Set(ctx, &responseData)...)
 }