Skip to content
This repository was archived by the owner on Dec 17, 2024. It is now read-only.

Commit 7d6f2d8

Browse files
fix(deps): Update stack definition member versions (#52)
1 parent bf929c2 commit 7d6f2d8

File tree

7 files changed

+114
-107
lines changed

7 files changed

+114
-107
lines changed

ibm_catalog.json

Lines changed: 15 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"products": [
33
{
4-
"label": "Retrieval Augmented Generation Pattern (Dev)",
4+
"label": "Retrieval Augmented Generation (RAG) Pattern (Dev)",
55
"name": "Retrieval_Augmented_Generation_Pattern_dev",
66
"product_kind": "solution",
77
"tags": [
@@ -27,27 +27,27 @@
2727
"key protect",
2828
"scc"
2929
],
30-
"short_description": "Deploys a sample Retrieval Augmented Generation application, including all supporting IBM Cloud and Watson services.",
31-
"long_description": "This deployable architecture provides a comprehensive foundation for trust, observability, security, and regulatory compliance by configuring and deploying various services, including:\n- Configuring IBM Cloud Account: with recommended values meeting the [IBM Cloud Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about)\n- Deploying Observability Services: for application and platform logging and monitoring\n- Deploying Keys and Secrets Management Services: for storage and management of encryption keys and secrets\n- Deploying CI/CD/CC Pipelines: for secure application lifecycle management\n- Deploying a Suite of Watson AI Services: to provide AI capabilities to the application \n\nThese configured and deployed services enable a secure and trustworthy deployment of Generative AI applications on IBM Cloud.\n\n# Objective\n\nThis deployable architecture is designed to showcase a fully automated deployment of a retrieval augmented generation application through IBM Cloud Project, providing a flexible and customizable foundation for your own Watson-based application deployments on IBM Cloud. This architecture deploys the following [banking sample application](https://github.com/IBM/gen-ai-rag-watsonx-sample-application) by default.\n\nBy leveraging this architecture, you can accelerate your deployment and tailor it to meet your unique business needs and enterprise goals.",
30+
"short_description": "Automate RAG deployment with supporting IBM Cloud and watsonx services, embed your enterprise data in generative AI solutions.",
31+
"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\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.",
3232
"offering_docs_url": "https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md",
3333
"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
3434
"provider_name": "IBM",
3535
"features": [
3636
{
37-
"title": "Retrieval Augmented Generation sample pattern",
38-
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
39-
},
40-
{
41-
"title": "Ensure Observability",
42-
"description": "Provides observability by deploying services such as IBM Log Analysis, IBM Monitoring, IBM Activity Tracker, and log retention."
37+
"title": "RAG Pattern",
38+
"description": "Deploy a RAG pattern with supporting IBM Cloud and watsonx services, and a sample application to Code Engine or Red Hat OpenShift using Continuous Delivery."
4339
},
4440
{
4541
"title": "Implement Security",
46-
"description": "The architecture ensures security by deploying IBM Key Protect and IBM Secrets Manager."
42+
"description": "The architecture ensures security by deploying Key Protect and Secrets Manager."
4743
},
4844
{
4945
"title": "Achieve Regulatory Compliance",
50-
"description": "Ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM SCC for secure application lifecycle management."
46+
"description": "Ensures regulatory compliance by implementing CI/CD/CC pipelines, along with Security and Compliance Center for continuous compliance."
47+
},
48+
{
49+
"title": "Ensure Observability",
50+
"description": "Provides observability by deploying services such as Logs and Monitoring for log analysis and tracking activity."
5151
},
5252
{
5353
"title": "Establish Trust",
@@ -157,24 +157,8 @@
157157
"architecture": {
158158
"features": [
159159
{
160-
"title": "Retrieval Augmented Generation sample pattern",
161-
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
162-
},
163-
{
164-
"title": "Ensure Observability",
165-
"description": "The architecture provides observability by deploying services such as IBM Log Analysis, IBM Monitoring, IBM Activity Tracker, and log retention through Cloud Object Storage buckets."
166-
},
167-
{
168-
"title": "Implement Security",
169-
"description": "The architecture ensures security by deploying IBM Key Protect and IBM Secrets Manager."
170-
},
171-
{
172-
"title": "Achieve Regulatory Compliance",
173-
"description": "The architecture ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM Security Compliance Center (SCC) for secure application lifecycle management."
174-
},
175-
{
176-
"title": "Establish Trust",
177-
"description": "The architecture ensures trust by configuring the IBM Cloud account to align with compliance settings as defined in the Financial Services framework."
160+
"title": "Enables:",
161+
"description": "1.Code Engine for containerized and serverless workloads\n2.Elasticsearch Enterprise for building and storing dense vector indexes or keyword search indexes\n3.watsonx.ai in-memory vector store for RAG trial and exploration\n4.watsonx.ai UI to upload documents\n5.watsonx.ai Prompt Lab for inferencing and Prompt Templates\n6.watsonx Assistant Conversational Search with embedded LLM\n7.Build your own data processing, ingestion pipeline and indexes"
178162
}
179163
],
180164
"diagrams": [
@@ -494,24 +478,8 @@
494478
"architecture": {
495479
"features": [
496480
{
497-
"title": "Retrieval Augmented Generation sample pattern",
498-
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
499-
},
500-
{
501-
"title": "Ensure Observability",
502-
"description": "The architecture provides observability by deploying services such as IBM Log Analysis, IBM Monitoring, IBM Activity Tracker, and log retention through Cloud Object Storage buckets."
503-
},
504-
{
505-
"title": "Implement Security",
506-
"description": "The architecture ensures security by deploying IBM Key Protect and IBM Secrets Manager."
507-
},
508-
{
509-
"title": "Achieve Regulatory Compliance",
510-
"description": "The architecture ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM Security Compliance Center (SCC) for secure application lifecycle management."
511-
},
512-
{
513-
"title": "Establish Trust",
514-
"description": "The architecture ensures trust by configuring the IBM Cloud account to align with compliance settings as defined in the Financial Services framework."
481+
"title": "Enables:",
482+
"description": "1.Red Hat OpenShift cluster for microservices workloads\n2.Elasticsearch Platinum for building and storing sparse vectors, dense vector indexes or keyword search indexes\n - watsonx.ai use of Elasticsearch ELSER2 vector index for RAG\n - watsonx Assistant Conversational Search with UI feature for uploading documents to create or use Elasticsearch ELSER2 vector index for RAG\n3.watsonx.ai in-memory vector store for RAG trial and exploration\n4.watsonx.ai UI to upload documents\n5.watsonx.ai Prompt Lab for inferencing and Prompt Templates\n6.watsonx Assistant Conversational Search with embedded LLM\n7.Build your own data processing, ingestion pipeline and indexes"
515483
}
516484
],
517485
"diagrams": [

solutions/basic/stack_definition.json

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,19 @@
7676
"default": null
7777
},
7878
{
79-
"name": "enable_platform_logs_metrics",
79+
"name": "enable_platform_metrics",
8080
"required": false,
8181
"type": "boolean",
8282
"hidden": false,
8383
"default": false
8484
},
85+
{
86+
"name": "logs_routing_tenant_regions",
87+
"required": false,
88+
"type": "array",
89+
"hidden": false,
90+
"default": []
91+
},
8592
{
8693
"name": "existing_discovery_instance",
8794
"required": false,
@@ -128,7 +135,7 @@
128135
"members": [
129136
{
130137
"name": "Account Infrastructure Base",
131-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.8252b811-2ef8-4bb1-b3b8-2c3e433485dd-global",
138+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.75f26d78-6e7e-4d83-9822-7777ea101706-global",
132139
"inputs": [
133140
{
134141
"name": "prefix",
@@ -206,7 +213,7 @@
206213
},
207214
{
208215
"name": "Essential Security - Encryption Key Management",
209-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.f28afafd-1dd9-4029-af68-4a0046f8b65e-global",
216+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.7f57ef48-2bb2-4641-8f6e-db27a7eacc38-global",
210217
"inputs": [
211218
{
212219
"name": "resource_group_name",
@@ -236,7 +243,7 @@
236243
},
237244
{
238245
"name": "Essential Security - Logging Monitoring Activity Tracker",
239-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.a7b3b41f-7da2-40e8-a0e5-6fbdcbda487d-global",
246+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.eaf90e32-42b4-4cd6-a4c3-ea720f6ea9f7-global",
240247
"inputs": [
241248
{
242249
"name": "ibmcloud_api_key",
@@ -263,18 +270,22 @@
263270
"value": true
264271
},
265272
{
266-
"name": "enable_platform_logs",
267-
"value": "ref:../../inputs/enable_platform_logs_metrics"
273+
"name": "existing_en_instance_crn",
274+
"value": "ref:../Essential Security - Event Notifications/outputs/crn"
275+
},
276+
{
277+
"name": "logs_routing_tenant_regions",
278+
"value": "ref:../../inputs/logs_routing_tenant_regions"
268279
},
269280
{
270281
"name": "enable_platform_metrics",
271-
"value": "ref:../../inputs/enable_platform_logs_metrics"
282+
"value": "ref:../../inputs/enable_platform_metrics"
272283
}
273284
]
274285
},
275286
{
276-
"name": "Essential Security - Observability Event Notifications",
277-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.2f638eb6-9702-457f-b72d-62c051101aab-global",
287+
"name": "Essential Security - Event Notifications",
288+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.b7a7944c-55fa-4196-b995-df8bc085870a-global",
278289
"inputs": [
279290
{
280291
"name": "kms_endpoint_url",
@@ -304,10 +315,6 @@
304315
"name": "prefix",
305316
"value": "ref:../../inputs/prefix"
306317
},
307-
{
308-
"name": "existing_monitoring_crn",
309-
"value": "ref:../Essential Security - Logging Monitoring Activity Tracker/outputs/cloud_monitoring_crn"
310-
},
311318
{
312319
"name": "existing_en_instance_crn",
313320
"value": "ref:../../inputs/existing_event_notification_instance_crn"
@@ -316,7 +323,7 @@
316323
},
317324
{
318325
"name": "Essential Security - Secrets Manager",
319-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.32c26a0f-bbd2-4693-8846-46fca0598d21-global",
326+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.03587d2d-38bd-42c3-983b-72469702e038-global",
320327
"inputs": [
321328
{
322329
"name": "prefix",
@@ -352,7 +359,7 @@
352359
},
353360
{
354361
"name": "existing_event_notification_instance_crn",
355-
"value": "ref:../Essential Security - Observability Event Notifications/outputs/crn"
362+
"value": "ref:../Essential Security - Event Notifications/outputs/crn"
356363
},
357364
{
358365
"name": "enable_event_notification",
@@ -362,7 +369,7 @@
362369
},
363370
{
364371
"name": "Essential Security - Security Compliance Center",
365-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.69dd48c5-d92c-42b6-8bc2-510c1329c962-global",
372+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.b27fc8c7-f6ec-4f98-890d-4f7ccfd37aaf-global",
366373
"inputs": [
367374
{
368375
"name": "ibmcloud_api_key",
@@ -398,7 +405,7 @@
398405
},
399406
{
400407
"name": "existing_en_crn",
401-
"value": "ref:../Essential Security - Observability Event Notifications/outputs/crn"
408+
"value": "ref:../Essential Security - Event Notifications/outputs/crn"
402409
},
403410
{
404411
"name": "profile_attachments",
@@ -408,7 +415,7 @@
408415
},
409416
{
410417
"name": "Gen AI - Databases for Elasticsearch",
411-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.3858adc6-94f5-4f28-97c0-f249cba95e8a-global",
418+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.aa4a2c9b-8a6a-472d-a9d3-9fc6e97b062f-global",
412419
"inputs": [
413420
{
414421
"name": "use_existing_resource_group",
@@ -540,7 +547,7 @@
540547
},
541548
{
542549
"name": "Workload - Code Engine Projects",
543-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.45457859-aaf7-4f87-8c1e-09422a0da2b8-global",
550+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.42a9e379-8a61-4fad-a4c7-09f72a9bfb7c-global",
544551
"inputs": [
545552
{
546553
"name": "ibmcloud_api_key",
@@ -679,7 +686,7 @@
679686
},
680687
{
681688
"name": "Workload - Sample RAG App Configuration",
682-
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.0b549763-7c2e-4136-8b3e-8b9485972232-global",
689+
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.89e63750-f8dc-4537-a825-a06132c445a5-global",
683690
"inputs": [
684691
{
685692
"name": "toolchain_region",

0 commit comments

Comments
 (0)