From f34f021df45118faf3308323d2cfa8dc5f45f533 Mon Sep 17 00:00:00 2001 From: shemau Date: Sat, 8 Feb 2025 19:21:33 +0000 Subject: [PATCH 1/4] fix: sync ibm_catalog keys --- .secrets.baseline | 4 +- README.md | 1 + ibm_catalog.json | 643 +++++++++++++++++++++++----------------------- 3 files changed, 325 insertions(+), 323 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 35efb212..15be23f7 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "go.sum|^.secrets.baseline$", "lines": null }, - "generated_at": "2025-02-05T07:22:24Z", + "generated_at": "2025-02-08T15:11:07Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -82,7 +82,7 @@ "hashed_secret": "33da8d0e8af2efc260f01d8e5edfcc5c5aba44ad", "is_secret": true, "is_verified": false, - "line_number": 35, + "line_number": 36, "type": "Secret Keyword", "verified_result": null } diff --git a/README.md b/README.md index b396e37d..66b1300b 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ * [Basic example with index creation and updates to cluster-wide settings](./examples/basic) * [Complete example with autoscaling, BYOK encryption and service credentials creation](./examples/complete) * [Financial Services Cloud profile example with autoscaling enabled](./examples/fscloud) + * [Restore from backup example](./examples/backup-restore) * [Contributing](#contributing) diff --git a/ibm_catalog.json b/ibm_catalog.json index e731a84c..7dce2947 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -1,385 +1,386 @@ { - "products": [ - { - "name": "deploy-arch-ibm-icd-elasticsearch", - "label": "Cloud automation for Databases for Elasticsearch", - "product_kind": "solution", - "tags": [ - "ibm_created", - "target_terraform", - "terraform", - "data_management", - "solution" - ], - "keywords": [ - "elasticsearch", - "IaC", - "infrastructure as code", - "terraform", - "solution", - "elasticsearch standard", - "database", - "nosql" - ], - "short_description": "Creates and configures an instance of IBM Cloud Databases for Elasticsearch.", - "long_description": "This architecture supports creating and configuring an instance of Databases for Elasticsearch with KMS encryption.", - "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/blob/main/README.md", - "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/main/images/elasticsearch_icon.svg", - "provider_name": "IBM", - "features": [ - { - "title": "Creates an instance of Databases for Elasticsearch", - "description": "Creates and configures an IBM Cloud Databases for Elasticsearch instance." - }, - { - "title": "Supports KMS encryption", - "description": "Provides KMS encryption for the data that you store in the database." - }, - { - "title": "Supports autoscaling", - "description": "Provides the autoscaling to allow the database to increase resources in response to usage." - }, - { - "title": "Attaches access tags", - "description": "Attaches access tags to the Elasticsearch instance." + "products": [ + { + "name": "deploy-arch-ibm-icd-elasticsearch", + "label": "Cloud automation for Databases for Elasticsearch", + "product_kind": "solution", + "tags": [ + "ibm_created", + "target_terraform", + "terraform", + "data_management", + "solution" + ], + "keywords": [ + "elasticsearch", + "IaC", + "infrastructure as code", + "terraform", + "solution", + "elasticsearch standard", + "database", + "nosql" + ], + "short_description": "Creates and configures an instance of IBM Cloud Databases for Elasticsearch.", + "long_description": "This architecture supports creating and configuring an instance of Databases for Elasticsearch with KMS encryption.", + "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/blob/main/README.md", + "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/main/images/elasticsearch_icon.svg", + "provider_name": "IBM", + "features": [ + { + "title": "Creates an instance of Databases for Elasticsearch", + "description": "Creates and configures an IBM Cloud Databases for Elasticsearch instance." + }, + { + "title": "Supports KMS encryption", + "description": "Provides KMS encryption for the data that you store in the database." + }, + { + "title": "Supports autoscaling", + "description": "Provides the autoscaling to allow the database to increase resources in response to usage." + }, + { + "title": "Attaches access tags", + "description": "Attaches access tags to the Elasticsearch instance." + }, + { + "title": "Supports backup restoration", + "description": "Provides database restoration using a backup created by a deployment with the same service ID." + } + ], + "flavors": [ + { + "label": "Standard", + "name": "standard", + "install_type": "fullstack", + "working_directory": "solutions/standard", + "compliance": { + "authority": "scc-v3", + "profiles": [ + { + "profile_name": "IBM Cloud Framework for Financial Services", + "profile_version": "1.6.0" + } + ] }, - { - "title": "Supports backup restoration", - "description": "Provides database restoration using a backup created by a deployment with the same service ID." - } - ], - "flavors": [ - { - "label": "Standard", - "name": "standard", - "install_type": "fullstack", - "working_directory": "solutions/standard", - "compliance": { - "authority": "scc-v3", - "profiles": [ - { - "profile_name": "IBM Cloud Framework for Financial Services", - "profile_version": "1.6.0" - } - ]}, - "iam_permissions": [ + "iam_permissions": [ + { + "role_crns": [ + "crn:v1:bluemix:public:iam::::role:Editor" + ], + "service_name": "databases-for-elasticsearch" + } + ], + "architecture": { + "descriptions": "This architecture creates an instance of IBM Cloud Databases for Elasticsearch instance with KMS encryption. Supports autoscaling.", + "features": [ { - "role_crns": [ - "crn:v1:bluemix:public:iam::::role:Editor" - ], - "service_name": "databases-for-elasticsearch" + "title": " Creates an instance of Databases for Elasticsearch", + "description": "This architecture creates an instance of IBM Cloud Databases for Elasticsearch with KMS encryption. It accepts or creates a resource group, and provides autoscaling rules." } ], - "architecture": { - "descriptions": "This architecture creates an instance of IBM Cloud Databases for Elasticsearch instance with KMS encryption. Supports autoscaling.", - "features": [ - { - "title": " Creates an instance of Databases for Elasticsearch", - "description": "This architecture creates an instance of IBM Cloud Databases for Elasticsearch with KMS encryption. It accepts or creates a resource group, and provides autoscaling rules." - } - ], - "diagrams": [ - { - "diagram": { - "caption": "Databases for Elasticsearch instance on IBM Cloud", - "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/main/reference-architecture/deployable-architecture-elasticsearch.svg", - "type": "image/svg+xml" - }, - "description": "This architecture supports creating and configuring an instance of Databases for Elasticsearch instance with KMS encryption." - } - ] - }, - "configuration": [ - { - "key": "ibmcloud_api_key" - }, - { - "key": "provider_visibility", - "options": [ - { - "displayname": "private", - "value": "private" - }, - { - "displayname": "public", - "value": "public" - }, - { - "displayname": "public-and-private", - "value": "public-and-private" - } - ] + "diagrams": [ + { + "diagram": { + "caption": "Databases for Elasticsearch instance on IBM Cloud", + "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-icd-elasticsearch/main/reference-architecture/deployable-architecture-elasticsearch.svg", + "type": "image/svg+xml" }, + "description": "This architecture supports creating and configuring an instance of Databases for Elasticsearch instance with KMS encryption." + } + ] + }, + "configuration": [ + { + "key": "ibmcloud_api_key" + }, + { + "key": "provider_visibility", + "options": [ { - "key": "use_existing_resource_group" + "displayname": "private", + "value": "private" }, { - "key": "resource_group_name" + "displayname": "public", + "value": "public" }, { - "key": "prefix", + "displayname": "public-and-private", + "value": "public-and-private" + } + ] + }, + { + "key": "use_existing_resource_group" + }, + { + "key": "resource_group_name" + }, + { + "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__`." - }, - { - "key": "region", - "required": true, - "options": [ - { - "displayname": "Chennai (che01)", - "value": "che01" - }, - { - "displayname": "Dallas (us-south)", - "value": "us-south" - }, - { - "displayname": "Frankfurt (eu-de)", - "value": "eu-de" - }, - { - "displayname": "London (eu-gb)", - "value": "eu-gb" - }, - { - "displayname": "Madrid (eu-es)", - "value": "eu-es" - }, - { - "displayname": "Osaka (jp-osa)", - "value": "jp-osa" - }, - { - "displayname": "Paris (par01)", - "value": "par01" - }, - { - "displayname": "Sao Paulo (br-sao)", - "value": "br-sao" - }, - { - "displayname": "Sydney (au-syd)", - "value": "au-syd" - }, - { - "displayname": "Toronto (ca-tor)", - "value": "ca-tor" - }, - { - "displayname": "Tokyo (jp-tok)", - "value": "jp-tok" - }, - { - "displayname": "Washington (us-east)", - "value": "us-east" - } - ] - }, - { - "key": "name" - }, - { - "key": "existing_db_instance_crn" - }, - { - "key": "plan", - "options": [ - { - "displayname": "enterprise", - "value": "enterprise" - }, - { - "displayname": "platinum", - "value": "platinum" - } - ] - }, - { - "key": "elasticsearch_version", - "required": false, - "default_value": "__NULL__", - "options": [ - { - "displayname": "preferred", - "value": "__NULL__" - }, - { - "displayname": "8.15", - "value": "8.15" - }, - { - "displayname": "8.12", - "value": "8.12" - }, - { - "displayname": "8.10", - "value": "8.10" - } - ] - }, - { - "key": "tags" - }, - { - "key": "access_tags" - }, - { - "key": "auto_scaling" - }, - { - "key": "members" - }, - { - "key": "member_memory_mb" - }, - { - "key": "member_cpu_count" - }, - { - "key": "member_disk_mb" - }, - { - "key": "member_host_flavor" - }, - { - "key": "admin_pass" - }, + }, + { + "key": "region", + "required": true, + "options": [ { - "key": "users" + "displayname": "Chennai (che01)", + "value": "che01" }, { - "key": "service_credential_names" + "displayname": "Dallas (us-south)", + "value": "us-south" }, { - "key": "existing_secrets_manager_instance_crn" + "displayname": "Frankfurt (eu-de)", + "value": "eu-de" }, { - "key": "existing_secrets_manager_endpoint_type", - "options": [ - { - "displayname": "public", - "value": "public" - }, - { - "displayname": "private", - "value": "private" - } - ] + "displayname": "London (eu-gb)", + "value": "eu-gb" }, { - "key": "service_credential_secrets" + "displayname": "Madrid (eu-es)", + "value": "eu-es" }, { - "key": "admin_pass_sm_secret_group" + "displayname": "Osaka (jp-osa)", + "value": "jp-osa" }, { - "key": "use_existing_admin_pass_sm_secret_group" + "displayname": "Paris (par01)", + "value": "par01" }, { - "key": "admin_pass_sm_secret_name" + "displayname": "Sao Paulo (br-sao)", + "value": "br-sao" }, { - "key": "skip_es_sm_auth_policy" + "displayname": "Sydney (au-syd)", + "value": "au-syd" }, { - "key": "ibmcloud_kms_api_key" + "displayname": "Toronto (ca-tor)", + "value": "ca-tor" }, { - "key": "kms_endpoint_type", - "options": [ - { - "displayname": "public", - "value": "public" - }, - { - "displayname": "private", - "value": "private" - } - ] + "displayname": "Tokyo (jp-tok)", + "value": "jp-tok" }, { - "key": "use_ibm_owned_encryption_key" - }, + "displayname": "Washington (us-east)", + "value": "us-east" + } + ] + }, + { + "key": "name" + }, + { + "key": "existing_db_instance_crn" + }, + { + "key": "plan", + "options": [ { - "key": "existing_kms_instance_crn", - "required": true + "displayname": "enterprise", + "value": "enterprise" }, { - "key": "existing_kms_key_crn" - }, + "displayname": "platinum", + "value": "platinum" + } + ] + }, + { + "key": "elasticsearch_version", + "required": false, + "default_value": "__NULL__", + "options": [ { - "key": "existing_backup_kms_key_crn" + "displayname": "preferred", + "value": "__NULL__" }, { - "key": "use_default_backup_encryption_key" + "displayname": "8.15", + "value": "8.15" }, { - "key": "elasticsearch_key_ring_name" + "displayname": "8.12", + "value": "8.12" }, { - "key": "elasticsearch_key_name" - }, + "displayname": "8.10", + "value": "8.10" + } + ] + }, + { + "key": "tags" + }, + { + "key": "access_tags" + }, + { + "key": "auto_scaling" + }, + { + "key": "members" + }, + { + "key": "member_memory_mb" + }, + { + "key": "member_cpu_count" + }, + { + "key": "member_disk_mb" + }, + { + "key": "member_host_flavor" + }, + { + "key": "admin_pass" + }, + { + "key": "users" + }, + { + "key": "service_credential_names" + }, + { + "key": "existing_secrets_manager_instance_crn" + }, + { + "key": "existing_secrets_manager_endpoint_type", + "options": [ { - "key": "skip_es_kms_auth_policy" + "displayname": "public", + "value": "public" }, { - "key": "backup_crn" - }, + "displayname": "private", + "value": "private" + } + ] + }, + { + "key": "service_credential_secrets" + }, + { + "key": "admin_pass_sm_secret_group" + }, + { + "key": "use_existing_admin_pass_sm_secret_group" + }, + { + "key": "admin_pass_sm_secret_name" + }, + { + "key": "skip_es_sm_auth_policy" + }, + { + "key": "ibmcloud_kms_api_key" + }, + { + "key": "kms_endpoint_type", + "options": [ { - "key": "enable_elser_model" + "displayname": "public", + "value": "public" }, { - "key": "elser_model_type", - "options": [ - { - "displayname": ".elser_model_1", - "value": ".elser_model_1" - }, - { - "displayname": ".elser_model_2", - "value": ".elser_model_2" - }, - { - "displayname": ".elser_model_2_linux-x86_64", - "value": ".elser_model_2_linux-x86_64" - } - ] - }, + "displayname": "private", + "value": "private" + } + ] + }, + { + "key": "use_ibm_owned_encryption_key" + }, + { + "key": "existing_kms_instance_crn", + "required": true + }, + { + "key": "existing_kms_key_crn" + }, + { + "key": "existing_backup_kms_key_crn" + }, + { + "key": "use_default_backup_encryption_key" + }, + { + "key": "elasticsearch_key_ring_name" + }, + { + "key": "elasticsearch_key_name" + }, + { + "key": "skip_es_kms_auth_policy" + }, + { + "key": "backup_crn" + }, + { + "key": "enable_elser_model" + }, + { + "key": "elser_model_type", + "options": [ { - "key": "enable_kibana_dashboard" + "displayname": ".elser_model_1", + "value": ".elser_model_1" }, { - "key": "existing_code_engine_project_id" + "displayname": ".elser_model_2", + "value": ".elser_model_2" }, { - "key": "kibana_registry_namespace_image" - }, + "displayname": ".elser_model_2_linux-x86_64", + "value": ".elser_model_2_linux-x86_64" + } + ] + }, + { + "key": "enable_kibana_dashboard" + }, + { + "key": "existing_code_engine_project_id" + }, + { + "key": "kibana_registry_namespace_image" + }, + { + "key": "kibana_image_digest" + }, + { + "key": "kibana_image_port" + }, + { + "key": "kibana_visibility", + "options": [ { - "key": "kibana_image_digest" + "displayname": "local_public", + "value": "local_public" }, { - "key": "kibana_image_port" + "displayname": "local_private", + "value": "local_private" }, { - "key": "kibana_visibility", - "options": [ - { - "displayname": "local_public", - "value": "local_public" - }, - { - "displayname": "local_private", - "value": "local_private" - }, - { - "displayname": "local", - "value": "local" - } - ] + "displayname": "local", + "value": "local" } ] - } - ] - } - ] - } + } + ] + } + ] + } + ] +} From 241cc880858fc347e51ddb7a0ef8833bb99fe3f2 Mon Sep 17 00:00:00 2001 From: shemau Date: Mon, 10 Feb 2025 10:14:51 +0000 Subject: [PATCH 2/4] fix: bump common dev assets catalog json validation --- common-dev-assets | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common-dev-assets b/common-dev-assets index 3b7b2f12..a82b82a5 160000 --- a/common-dev-assets +++ b/common-dev-assets @@ -1 +1 @@ -Subproject commit 3b7b2f12c56fc534972eb510af1127dfcd7d3240 +Subproject commit a82b82a515e442958a736cae705b72891d6a60f4 From bc603a85410ccd3f329991f1ad44f8b99f71d203 Mon Sep 17 00:00:00 2001 From: shemau Date: Mon, 10 Feb 2025 13:48:28 +0000 Subject: [PATCH 3/4] fix: without README --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 66b1300b..b396e37d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ * [Basic example with index creation and updates to cluster-wide settings](./examples/basic) * [Complete example with autoscaling, BYOK encryption and service credentials creation](./examples/complete) * [Financial Services Cloud profile example with autoscaling enabled](./examples/fscloud) - * [Restore from backup example](./examples/backup-restore) * [Contributing](#contributing) From 117dcd8c4b2c72a1d8be6f90c5626576f91dcc9c Mon Sep 17 00:00:00 2001 From: shemau Date: Mon, 10 Feb 2025 13:55:45 +0000 Subject: [PATCH 4/4] fix: without secrets baseline --- .secrets.baseline | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 15be23f7..35efb212 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "go.sum|^.secrets.baseline$", "lines": null }, - "generated_at": "2025-02-08T15:11:07Z", + "generated_at": "2025-02-05T07:22:24Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -82,7 +82,7 @@ "hashed_secret": "33da8d0e8af2efc260f01d8e5edfcc5c5aba44ad", "is_secret": true, "is_verified": false, - "line_number": 36, + "line_number": 35, "type": "Secret Keyword", "verified_result": null }