From 04a714d7b3f88bf93de365a8dbc21dd1cba6b5dd Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:10:15 +0000 Subject: [PATCH 1/6] docs: improve tile presentation --- .secrets.baseline | 2 +- common-dev-assets | 2 +- ibm_catalog.json | 62 +++++++++++++++++++++++++++++++++++++++++------ 3 files changed, 57 insertions(+), 9 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index abecc868..33c134bf 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "go.sum|^.secrets.baseline$", "lines": null }, - "generated_at": "2025-01-24T17:27:34Z", + "generated_at": "2025-03-21T12:09:55Z", "plugins_used": [ { "name": "AWSKeyDetector" diff --git a/common-dev-assets b/common-dev-assets index 2f8bedb6..48a440eb 160000 --- a/common-dev-assets +++ b/common-dev-assets @@ -1 +1 @@ -Subproject commit 2f8bedb6f5e623405e41553b0491c0306a027023 +Subproject commit 48a440ebe74a2fd6a1135c8d59b5442a254aedf9 diff --git a/ibm_catalog.json b/ibm_catalog.json index b6e3ecb2..36211b23 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,22 +176,70 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This architecture supports creating an IBM Cloud Object Storage instance, cross-region and single-region bucket.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud Automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understand-module-da) for more complex deployment.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM", "features": [ { "title": "Create an IBM Cloud Object Storage instance", - "description": "Create an IBM Cloud Object Storage instance." + "description": "Create an IBM Cloud Object Storage instance with customizable configurations such as instance name, resource keys, and plan." }, { "title": "Create an IBM Cloud Object Storage bucket", - "description": "Create either a cross-region or regional Object Storage bucket." + "description": "Create either a cross-region or regional Object Storage bucket with options for encryption, access tags, and storage class." }, { "title": "Attach access tags", - "description": "Attach access tags to the Object Storage instance." + "description": "Attach access tags to the Object Storage instance for fine-grained access control." + }, + { + "title": "Configure IAM authorization policies", + "description": "Set up IAM authorization policies to allow Secrets Manager to manage keys for the COS instance." + }, + { + "title": "Manage service credentials", + "description": "Create and manage service credentials for the COS instance, including automatic rotation and integration with Secrets Manager." + }, + { + "title": "Secure cross-region bucket setup", + "description": "Configure secure cross-region buckets with KMS encryption, activity tracking, and metrics monitoring." + }, + { + "title": "Secure regional bucket setup", + "description": "Configure secure regional buckets with KMS encryption, activity tracking, and metrics monitoring." + }, + { + "title": "KMS key management", + "description": "Create and manage KMS keys for encryption, including key rotation and dual-auth delete options." + }, + { + "title": "Bucket configuration options", + "description": "Customize bucket configurations such as storage class, object locking, versioning, and retention rules." + }, + { + "title": "Resource group management", + "description": "Create or use existing resource groups to organize and manage your COS instances and buckets." + }, + { + "title": "Cross-account authorization policies", + "description": "Set up cross-account authorization policies to allow COS instances to access KMS keys from different accounts." + }, + { + "title": "Bucket lifecycle management", + "description": "Configure lifecycle rules for buckets, including expiration, archiving, and retention policies." + }, + { + "title": "Metrics and monitoring", + "description": "Enable metrics and monitoring for buckets to track usage, request metrics, and management events." + }, + { + "title": "Object versioning", + "description": "Enable object versioning to keep multiple versions of objects in the bucket." + }, + { + "title": "Object locking", + "description": "Enable object locking to prevent objects from being deleted or overwritten for a specified duration." } ], "flavors": [ @@ -244,7 +292,7 @@ "required": true }, { - "key":"prefix", + "key": "prefix", "required": true, "description": "Prefix to add to all resources created by this solution. To not use any prefix value, you can enter the string `__NULL__`." }, @@ -390,7 +438,7 @@ "key": "ibmcloud_api_key" }, { - "key":"prefix", + "key": "prefix", "required": true, "description": "Prefix to add to all resources created by this solution. To not use any prefix value, you can enter the string `__NULL__`." }, @@ -649,7 +697,7 @@ "key": "ibmcloud_api_key" }, { - "key":"prefix", + "key": "prefix", "required": true, "description": "Prefix to add to all resources created by this solution. To not use any prefix value, you can enter the string `__NULL__`." }, From 5bd2a471fab7c68b3054700c4b385d0124cda9c6 Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:19:32 +0000 Subject: [PATCH 2/6] docs: improve tile presentation --- ibm_catalog.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ibm_catalog.json b/ibm_catalog.json index 36211b23..7797ec95 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,7 +176,7 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud Automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understand-module-da) for more complex deployment.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understand-module-da) for more complex deployment.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM", @@ -195,11 +195,11 @@ }, { "title": "Configure IAM authorization policies", - "description": "Set up IAM authorization policies to allow Secrets Manager to manage keys for the COS instance." + "description": "Set up IAM authorization policies to allow Secrets Manager to manage keys for the Cloud Object Storage instance." }, { "title": "Manage service credentials", - "description": "Create and manage service credentials for the COS instance, including automatic rotation and integration with Secrets Manager." + "description": "Create and manage service credentials for the Cloud Object Storage instance, including automatic rotation and integration with Secrets Manager." }, { "title": "Secure cross-region bucket setup", @@ -219,11 +219,11 @@ }, { "title": "Resource group management", - "description": "Create or use existing resource groups to organize and manage your COS instances and buckets." + "description": "Create or use existing resource groups to organize and manage your Cloud Object Storage instances and buckets." }, { "title": "Cross-account authorization policies", - "description": "Set up cross-account authorization policies to allow COS instances to access KMS keys from different accounts." + "description": "Set up cross-account authorization policies to allow Cloud Object Storage instances to access KMS keys from different accounts." }, { "title": "Bucket lifecycle management", From 2580f9102c96039d28def5c6b32165faa35ba40c Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:22:13 +0000 Subject: [PATCH 3/6] docs: improve tile presentation --- ibm_catalog.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ibm_catalog.json b/ibm_catalog.json index 7797ec95..f43500ef 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,7 +176,7 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understand-module-da) for more complex deployment.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM", From f0f1b444a705bbf42a97db079bad10044a198349 Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:26:09 +0000 Subject: [PATCH 4/6] docs: improve tile presentation --- ibm_catalog.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ibm_catalog.json b/ibm_catalog.json index f43500ef..beb553c2 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,7 +176,7 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\nThis Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\n:tip: This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM", From 6042b338203c1acefc21d53f6815b2333ecf3e9b Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:33:58 +0000 Subject: [PATCH 5/6] docs: improve tile presentation --- ibm_catalog.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ibm_catalog.json b/ibm_catalog.json index beb553c2..f4edf355 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,7 +176,7 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\n:tip: This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects) to infrastructure management, or assembled together into a broader [automated stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\n💡 This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects), or assembled together into a broader [automated IaC stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM", From 79f9f1ac838cd41f1290db8f2082a916ddadec9c Mon Sep 17 00:00:00 2001 From: Vincent Burckhardt Date: Fri, 21 Mar 2025 12:36:22 +0000 Subject: [PATCH 6/6] docs: improve tile presentation --- ibm_catalog.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ibm_catalog.json b/ibm_catalog.json index f4edf355..6873d2a4 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -176,7 +176,7 @@ "solution" ], "short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket", - "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\n💡 This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects), or assembled together into a broader [automated IaC stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", + "long_description": "This deployable architecture supports the creation, configuration, and management of [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instances and buckets. It facilitates the setup of secure cross-region and regional buckets, ensuring your data is both accessible and protected.\n\n\n💡 This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) asset collection, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects), or assembled together into a broader [automated IaC stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.", "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md", "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg", "provider_name": "IBM",