0.0.9 (#44)

* feat: bump submodule

* feat: bump versions

* feat: update stack reference architecture

* docs: remove documentation around manual steps

* fix: fix issue causing clashes in code engine names

* feat: bump to rag app da v1.5.0

* chore: bump to Secret Manager to version v1.12.0 Security Compliance Center to version v1.6.3

* feat: allow to pass crn to existing secret manager instance

* feat: add input wrt platform metrics and logging

* chore: bump DA versions

* chore: bump DA versions

* fix: obs to use resource group

* fix: missing secret manager region

* fix: reverse sm config

Author: vburckhardt

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "common-dev-assets"]
 	path = common-dev-assets
 	url = https://github.com/terraform-ibm-modules/common-dev-assets
+	branch = main

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-04-24T10:49:30Z",
+  "generated_at": "2024-04-29T15:33:54Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -82,23 +82,23 @@
         "hashed_secret": "bbc4e9d52252171a3a306be55086c65b126189e8",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 30,
+        "line_number": 32,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "d9e9019d9eb455a3d72a3bc252c26927bb148a10",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 45,
+        "line_number": 47,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "b13d7622394e85c3b2694f426bc096b093764462",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 49,
+        "line_number": 51,
         "type": "Secret Keyword",
         "verified_result": null
       }

README.md

@@ -1,6 +1,6 @@
 # Retrieval Augmented Generation (RAG) stack
 
-To run the full stack. These steps will be updated as development progresses on the stack and underlaying DAs.
+To run the full stack, follow these steps. These steps will be updated as development progresses on the stack and underlying DAs.
 
 ## 1. Deploy the stack in a new project from catalog
 
@@ -10,7 +10,9 @@ Click the "Add to project" button, and select create in new project.
 
 ## 2. Prereqs in target account
 
-- Create an API key in the target account. Keep note of it. Give it admin privilege for now. Exact permissions will be narrowed down in future version.
+Before deploying the stack, ensure you have:
+- Created an API key in the target account with sufficient permissions. Note the API key, as it will be used later.
+- For now, grant it admin privileges. The exact permissions required will be refined in future versions.
 
 
 ## 3. Set the input configuration for the stack
@@ -29,7 +31,7 @@ Click the "Add to project" button, and select create in new project.
         "prefix": "<prefix for resources name - ensure unique>",
         "ibmcloud_api_key": "<API Key of the target account with sufficient permissions>",
         "resource_group_name": "<target resource group - name of a new resource group that the stack will creates>",
-        "region": "<region where resources are deployed>",
+        "region": "<region where all resources are deployed>",
         "sample_app_git_url": "https://github.com/IBM/gen-ai-rag-watsonx-sample-application",
         "watsonx_admin_api_key": "<optional - admin key to use for watson if different from ibmcloud_api_key>",
         "signing_key": "signing key used to sign build artifacts"
@@ -73,15 +75,4 @@ Example 2 - simulate updating stack inputs and validating some configurations in
 DRY_RUN=true ./deploy-many.sh my-test-project RAG 'RAG-1|RAG-4|RAG-5'
 ```
 
-Tips: If deployment fail in one of the DA, you may need to remove the configuration name of the deployment that already passes from the pattern before re-running the script.
-
-Tips: to accelerate iteration you may deploy only a subset of the configurations: the bare minimum are key management, security manager, watson saas, alm and rag configuration da. Base account, observability and SCC are not on the critical path to get the app running.
-
-
-# 5. Deploy the sample app
-
-A few manual steps are required in the alpha version to trigger the deployment of the app:
-1. In the secret manager instance, in the default group, create an arbitrary secret named "ibmcloud-api-key". Put the used api key as secret.
-2. Follow the steps at https://cloud.ibm.com/docs/devsecops?topic=devsecops-devsecops-image-signing to generate a gpg key
-3. In the secret manager instance, in the default group, create an arbitrary secret named "signing_key". Put the signing key. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-devsecops-image-signing#cd-devsecops-gpg-store-secretsmgr
-4. Navigate to the "Generative AI Sample App-CI-Toolchain" CD instance, click "ci-pipeline" and execute the "Manual Trigger".
+Tips: If deployment fail in one of the DA, you may re-run the script as is. It will skip existing installed configuration.

ibm_catalog.json

@@ -14,7 +14,7 @@
 				"watson",
 				"ai"
 			],
-			"short_description": "A sample application that illustrates how to implement the RAG Pattern with watsonx.ai and IBM Cloud services.",
+			"short_description": "An automated solution that deploys a sample application illustrating how to implement the RAG Pattern with watsonx.ai and IBM Cloud services.",
 			"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
 			"flavors": [
 				{
@@ -105,7 +105,7 @@
 						"features": [
 							{
 								"title": "Deploy a customer care generative AI app to Code Engine using Continous Delivery",
-								"description": "TBD"
+								"description": ""
 							}
 						],
 						"diagrams": [
@@ -120,10 +120,10 @@
 							},
 							{
 								"diagram": {
-									"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-rag-sample-da/main/reference-architecture/stack.svg",
+									"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg",
 									"caption": "Solution components",
 									"type": "image/svg+xml",
-									"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-rag-sample-da/main/reference-architecture/stack.svg"
+									"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg"
 								},
 								"description": "Solution components"
 							}
@@ -174,6 +174,13 @@
 							"type": "password",
 							"hidden": false,
 							"default_value": "replace"
+						},
+						{
+							"name": "enable_platform_logs_metrics",
+							"required": false,
+							"type": "boolean",
+							"hidden": false,
+							"default_value": true
 						}
 					],
 					"install_type": "fullstack"