feat: rag-stack quick start variation

.gitignore

@@ -1,4 +1,15 @@
 .def.json
 .terraform
+**/.terraform/*
+
 *.tfstate
+*.tfstate.*
+
+*.terraform.lock.hcl
 *.lock.hcl
+
+.DS_Store
+
+*.tfvars
+*.tfvars.json
+*.log

ibm_catalog.json

@@ -9,7 +9,11 @@
 				"watson",
 				"security",
 				"banking",
-				"ibm_created"
+				"ibm_created",
+				"target_terraform",
+				"terraform",
+				"converged_infra",
+				"platform_engineering"
 			],
 			"keywords": [
 				"rag",
@@ -30,9 +34,13 @@
 				"security and compliance center workload protection",
 				"cspm",
 				"config aggregator",
-				"app config"
+				"app config",
+				"IaC",
+				"infrastructure as code",
+				"terraform",
+				"solution"
 			],
-			"short_description": "Automate RAG deployment with supporting IBM Cloud and watsonx services, embed your enterprise data in generative AI solutions.",
+			"short_description": "Automate RAG deployment with supporting IBM Cloud and watsonx services, embed your enterprise data in generative AI solutions",
 			"long_description": "Utilize data from your enterprise to achieve productivity gains in activities related to question/answer conversations, content search, summarization and generation. RAG can be deployed in multiple configurations and is applicable to various industry use cases and solutions.\n\nThis deployable architecture provides a comprehensive foundation for trust, observability, security, and regulatory compliance by configuring and deploying various services and a sample application for a [RAG pattern](https://cloud.ibm.com/docs/pattern-genai-rag?topic=pattern-genai-rag-genai-pattern), including:\n- Configuring IBM Cloud Account with best practices from [IBM Cloud Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about)\n- Deploying key and secrets management services for storage and management of encryption keys and secrets\n- Deploying controls for continuous compliance\n- Deploying observability services for application and platform logging and monitoring\n- Deploying a suite of watsonx services to provide generative AI RAG capabilities\n- Deploying content databases for storing vector embeddings of the documents and content search/retrieval\n- Deploying a sample application in a variety of run times including CI/CD/CC pipelines for secure application lifecycle management\n\nThe above configured and deployed services enable a secure and trustworthy deployment of generative AI applications on IBM Cloud.\n\nThe configurations are flexible and be changed to meet the needs for several types of RAG patterns depending on the chosen combination of technologies and services.\n\nThe generative AI RAG pattern services include:\n- [watsonx.ai](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html?context=wx)\n- [watsonx.data](https://cloud.ibm.com/docs/watsonxdata) (with Milvus)\n- [watsonx.governance](https://dataplatform.cloud.ibm.com/docs/content/svc-welcome/aiopenscale.html?context=wx)\n- [watsonx Assistant](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-welcome-new-assistant)\n- [watsonx Orchestrate](https://www.ibm.com/docs/en/watsonx/watson-orchestrate/current)\n- [Watson Discovery](https://cloud.ibm.com/docs/discovery-data)\n- [Elasticsearch](https://cloud.ibm.com/docs/databases-for-elasticsearch) Enterprise and Platinum edition\n\nThe supporting services include:\n- [Secrets Manager](https://cloud.ibm.com/docs/secrets-manager)\n- [Key Protect](https://cloud.ibm.com/docs/key-protect)\n- [Security and Compliance Center](https://cloud.ibm.com/docs/security-compliance)\n- [Event Notifications](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-getting-started)\n- [Logs](https://cloud.ibm.com/docs/cloud-logs)\n- [Monitoring](https://cloud.ibm.com/docs/monitoring?topic=monitoring-getting-started)\n- [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage)\n- [Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery) toolchains\n- [Container Registry](https://cloud.ibm.com/docs/Registry)\n\nA [sample RAG application](https://github.com/IBM/gen-ai-rag-watsonx-sample-application) is deployed to [Code Engine](https://cloud.ibm.com/docs/codeengine) or [Red Hat OpenShift](https://cloud.ibm.com/docs/openshift) cluster.\n\nBy leveraging this architecture, you can accelerate your deployment and tailor it to meet your unique business needs and enterprise goals.",
 			"offering_docs_url": "https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md",
 			"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
@@ -59,7 +67,7 @@
 					"description": "Ensures trust by configuring the IBM Cloud account to align with compliance settings as defined in the Financial Services framework."
 				}
 			],
-			"support_details": "This product is in the community registry, as such support is handled through the originated repo. If you experience issues please open an issue in that repository [https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/issues](https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/issues). Please note this product is not supported via the IBM Cloud Support Center.",
+			"support_details": "This product is in the community registry, support is handled through the [original repo](https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation). If you experience issues kindly open an issue [here](https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/issues). Please note that this product is not currently supported through the IBM Cloud Support Center.",
 			"flavors": [
 				{
 					"label": "Basic (Deploy on Code Engine)",
@@ -1018,6 +1026,147 @@
 						}
 					],
 					"install_type": "fullstack"
+				},
+				{
+					"label": "QuickStart",
+					"name": "quickstart",
+					"index": 1,
+					"install_type": "fullstack",
+					"working_directory": "solutions/quickstart",
+					"iam_permissions": [
+						{
+							"service_name": "cloud-object-storage",
+							"role_crns": [
+								"crn:v1:bluemix:public:iam::::serviceRole:Manager",
+								"crn:v1:bluemix:public:iam::::role:Editor"
+							],
+							"notes": "Required to manage Object Storage for the watsonx.ai."
+						},
+						{
+							"role_crns": [
+								"crn:v1:bluemix:public:iam::::role:Viewer"
+							],
+							"service_name": "Resource group only",
+							"notes": "Viewer access is required in the resource group you want to provision in."
+						}
+					],
+					"architecture": {
+						"features": [
+							{
+								"title": " ",
+								"description": "Ideal for users new to IBM Cloud or watsonx.ai who want to get started without configuring underlying infrastructure."
+							},
+							{
+								"title": " ",
+								"description": "Quickly provisions watsonx.ai, watsonx Assistant, watson Discovery, Elasticsearch, Object Storage, and Key Management Services. Includes all necessary services to deploy a sample Retrieval-Augmented Generation (RAG) application leveraging Code Engine."
+							}
+						],
+						"diagrams": [
+							{
+								"diagram": {
+									"caption": "RAG based Solution on IBM Cloud with watsonx - QuickStart",
+									"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/deployable-architecture-rag-stack-qs.svg",
+									"type": "image/svg+xml"
+								},
+								"description": "This deployable architecture provisions a suite of AI and data services on IBM Cloud to support rapid development and deployment of Retrieval-Augmented Generation (RAG) applications. It includes <b>watsonx.ai</b> for foundation model training and inference, <b>watsonx Assistant</b> for conversational AI, <b>watson Discovery</b> for intelligent document understanding, and <b>IBM Cloud Databases for Elasticsearch</b> with a pre-configured index to enable scalable search capabilities. The solution also provisions <b>IBM Cloud Object Storage (COS)</b> for persistent storage of model artifacts, application data, and logs, and <b>Key Management Services (KMS)</b> to ensure secure handling of sensitive information and encryption keys across services. Once the foundational services are provisioned, a sample <b>Retrieval-Augmented Generation (RAG)</b> application can be deployed to demonstrate how enterprise-grade AI solutions can be built using IBM Cloud-native services. The application leverages watsonx.ai for generative responses, Elasticsearch for document retrieval, and Code Engine to orchestrate the runtime environment."
+							}
+						]
+					},
+					"configuration": [
+						{
+							"key": "prefix",
+							"required": true,
+							"default_value": "dev",
+							"random_string": {
+								"length": 4
+							},
+							"value_constraints": [
+								{
+									"type": "regex",
+									"description": "Prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). It should not exceed 16 characters.",
+									"value": "^$|^__NULL__$|^[a-z](?!.*--)(?:[a-z0-9-]{0,14}[a-z0-9])?$"
+								}
+							]
+						},
+						{
+							"key": "existing_resource_group_name",
+							"display_name": "resource_group",
+							"custom_config": {
+								"type": "resource_group",
+								"grouping": "deployment",
+								"original_grouping": "deployment",
+								"config_constraints": {
+									"identifier": "rg_name"
+								}
+							},
+							"default_value": "Default",
+							"description": "The name of an existing resource group to provision the resources. [Learn more](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui#create_rgs) about how to create a resource group."
+						},
+						{
+							"key": "ibmcloud_api_key"
+						},
+						{
+							"key": "region",
+						    "required": true,
+							"options": [
+								{
+									"displayname": "Dallas (us-south)",
+									"value": "us-south"
+								},
+								{
+									"displayname": "Sydney (au-syd)",
+									"value": "au-syd"
+								},
+								{
+									"displayname": "Toronto (ca-tor)",
+									"value": "ca-tor"
+								},
+								{
+									"displayname": "Frankfurt (eu-de)",
+									"value": "eu-de"
+								},
+								{
+									"displayname": "London (eu-gb)",
+									"value": "eu-gb"
+								},
+								{
+									"displayname": "Tokyo (jp-tok)",
+									"value": "jp-tok"
+								}
+							]
+						},
+						{
+						"key": "provider_visibility",
+						"options": [
+							{
+								"displayname": "private",
+								"value": "private"
+							},
+							{
+								"displayname": "public",
+								"value": "public"
+							},
+							{
+								"displayname": "public-and-private",
+								"value": "public-and-private"
+							}
+						],
+						"hidden": true
+						},
+						{
+							"key": "resource_tags",
+							"custom_config": {
+								"type": "array",
+								"grouping": "deployment",
+								"original_grouping": "deployment",
+								"config_constraints": {
+									"type": "string"
+								}
+							}
+						}
+					],
+					"dependency_version_2": true,
+					"terraform_version": "1.10.5"
 				}
 			]
 		}

solutions/quickstart/README.md

@@ -0,0 +1,3 @@
+# Cloud automation for RAG (Retrieval Augmented Generation) Stack on VPC (QuickStart)
+
+:exclamation: **Important:** This solution is not intended to be called by other modules because it contains a provider configuration and is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information, see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers).

solutions/quickstart/catalogValidationValues.json.template

@@ -0,0 +1,5 @@
+{
+  "ibmcloud_api_key": $VALIDATION_APIKEY,
+  "prefix": $PREFIX,
+  "existing_resource_group_name": "geretain-test-resources"
+}