Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit 1883fcc

Browse files
rajatagarwal-ibmRajat Agrawal
andauthored
docs: cleanup (#4)
Co-authored-by: Rajat Agrawal <[email protected]>
1 parent 8508c9b commit 1883fcc

File tree

5 files changed

+14
-21
lines changed

5 files changed

+14
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ By using this architecture, you can:
1515
* Establish Trust: The architecture ensures trust by configuring the IBM Cloud account to align with compliance settings as defined in the [Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about) framework.
1616
* Ensure Observability: 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.
1717
* Implement Security: The architecture ensures security by deploying IBM Key Protect and IBM Secrets Manager.
18-
* Achieve Regulatory Compliance: The architecture ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM Security Compliance Center (SCC) for secure application lifecycle management.
18+
* Achieve Regulatory Compliance: The architecture ensures regulatory compliance with IBM Security Compliance Center (SCC).
1919

2020

2121
# Deployment Details

ibm_catalog.json

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@
2323
"key protect",
2424
"scc"
2525
],
26-
"short_description": "Deploys a sample Retrieval Augmented Generation application, including all supporting IBM Cloud and Watson services.",
27-
"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.",
28-
"offering_docs_url": "https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md",
26+
"short_description": "Deploys a GenAI Pattern on IBM Cloud, including all underlying IBM Cloud infrastructure.",
27+
"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 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\nThese pipelines facilitate the deployment of the application, vulnerability checks, and auditability, ensuring a secure and trustworthy deployment of Generative AI applications on IBM Cloud.",
28+
"offering_docs_url": "https://github.com/terraform-ibm-modules/stack-ibm-genai/blob/main/README.md",
2929
"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
3030
"features": [
31-
{
32-
"title": "Retrieval Augmented Generation sample pattern",
33-
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
34-
},
3531
{
3632
"title": "Ensure Observability",
3733
"description": "Provides observability by deploying services such as IBM Log Analysis, IBM Monitoring, IBM Activity Tracker, and log retention."
@@ -42,7 +38,7 @@
4238
},
4339
{
4440
"title": "Achieve Regulatory Compliance",
45-
"description": "Ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM SCC for secure application lifecycle management."
41+
"description": "Ensures regulatory compliance with IBM SCC."
4642
},
4743
{
4844
"title": "Establish Trust",
@@ -144,10 +140,6 @@
144140
],
145141
"architecture": {
146142
"features": [
147-
{
148-
"title": "Retrieval Augmented Generation sample pattern",
149-
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
150-
},
151143
{
152144
"title": "Ensure Observability",
153145
"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."
@@ -158,7 +150,7 @@
158150
},
159151
{
160152
"title": "Achieve Regulatory Compliance",
161-
"description": "The architecture ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM Security Compliance Center (SCC) for secure application lifecycle management."
153+
"description": "The architecture ensures regulatory compliance with IBM Security Compliance Center (SCC)."
162154
},
163155
{
164156
"title": "Establish Trust",
@@ -168,19 +160,19 @@
168160
"diagrams": [
169161
{
170162
"diagram": {
171-
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/RAG Pattern v2-part-2.svg",
163+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-ibm-genai/main/reference-architecture/Genai Pattern v2-part-2.svg",
172164
"caption": "Reference architecture",
173165
"type": "image/svg+xml",
174-
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/RAG Pattern v2-part-2.svg"
166+
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-ibm-genai/main/reference-architecture/Genai Pattern v2-part-2.svg"
175167
},
176168
"description": "Reference architecture"
177169
},
178170
{
179171
"diagram": {
180-
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg",
172+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-ibm-genai/main/reference-architecture/genai-stack.png",
181173
"caption": "Solution components",
182174
"type": "image/svg+xml",
183-
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg"
175+
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-ibm-genai/main/reference-architecture/genai-stack.png"
184176
},
185177
"description": "Solution components"
186178
}
@@ -226,7 +218,7 @@
226218
{
227219
"key": "resource_group_name",
228220
"type": "string",
229-
"default_value": "rag-services",
221+
"default_value": "genai-services",
230222
"description": "The name of the resource group that is created by this solution. The actual name is prefixed with the value of the input 'prefix'. All resources created by this solution are deployed in this resource group.",
231223
"required": false
232224
},

reference-architecture/Genai Pattern v2-part-2.svg

Lines changed: 1 addition & 0 deletions
Loading
106 KB
Loading

stack_definition.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"required": true,
66
"type": "string",
77
"hidden": false,
8-
"default": "rag",
8+
"default": "genai",
99
"description": "A prefix added to the name of all resources created by this solution. Used to avoid name clashes in the target account when existing this solution multiple times.",
1010
"custom_config": {}
1111
},
@@ -31,7 +31,7 @@
3131
"required": false,
3232
"type": "string",
3333
"hidden": false,
34-
"default": "rag-services",
34+
"default": "genai-services",
3535
"description": "The name of the resource group that is created by this solution. The actual name is prefixed with the value of the input 'prefix'. All resources created by this solution are deployed in this resource group.",
3636
"custom_config": {}
3737
},

0 commit comments

Comments
 (0)