|
28 | 28 | "scc"
|
29 | 29 | ],
|
30 | 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.", |
| 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.", |
32 | 32 | "offering_docs_url": "https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md",
|
33 | 33 | "offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
|
34 | 34 | "provider_name": "IBM",
|
|
57 | 57 | "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.",
|
58 | 58 | "flavors": [
|
59 | 59 | {
|
60 |
| - "label": "Deploy on Code Engine", |
| 60 | + "label": "Basic (Deploy on Code Engine)", |
61 | 61 | "name": "Code-Engine-d7b9",
|
| 62 | + "working_directory": "solutions/basic", |
62 | 63 | "compliance": {
|
63 | 64 | "authority": "scc-v3",
|
64 | 65 | "profiles": [
|
65 | 66 | {
|
66 |
| - "profile_name": "AI ICT Guardrails", |
| 67 | + "profile_name": "AI Security Guardrails 2.0", |
67 | 68 | "profile_version": "1.0.0"
|
68 | 69 | }
|
69 | 70 | ]
|
|
138 | 139 | "crn:v1:bluemix:public:iam::::role:Editor"
|
139 | 140 | ],
|
140 | 141 | "service_name": "discovery"
|
| 142 | + }, |
| 143 | + { |
| 144 | + "service_name": "databases-for-elasticsearch", |
| 145 | + "role_crns": [ |
| 146 | + "crn:v1:bluemix:public:iam::::role:Editor" |
| 147 | + ] |
| 148 | + }, |
| 149 | + { |
| 150 | + "service_name": "event-notifications", |
| 151 | + "role_crns": [ |
| 152 | + "crn:v1:bluemix:public:iam::::serviceRole:Manager", |
| 153 | + "crn:v1:bluemix:public:iam::::role:Editor" |
| 154 | + ] |
141 | 155 | }
|
142 | 156 | ],
|
143 | 157 | "architecture": {
|
|
232 | 246 | "key": "resource_group_name",
|
233 | 247 | "type": "string",
|
234 | 248 | "default_value": "rag-services",
|
235 |
| - "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. ", |
| 249 | + "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.", |
| 250 | + "required": false |
| 251 | + }, { |
| 252 | + "key": "existing_resource_group_name", |
| 253 | + "type": "string", |
| 254 | + "default_value": "__NULL__", |
| 255 | + "description": "The name of an existing resource group that is used by this solution, takes precedence over resource_group_name. Prefix is NOT used for existing resource group. All resources created by this solution are deployed in this resource group.", |
236 | 256 | "required": false
|
237 | 257 | },
|
238 | 258 | {
|
|
285 | 305 | "default_value": "__NULL__",
|
286 | 306 | "description": "The CRN of an existing KMS instance to use in this solution. If not set, a new KP instance is provisioned.",
|
287 | 307 | "required": false
|
| 308 | + }, |
| 309 | + { |
| 310 | + "key": "existing_event_notification_instance_crn", |
| 311 | + "type": "string", |
| 312 | + "default_value": "__NULL__", |
| 313 | + "description": "The CRN of an existing event notification instance to use in this solution. If not set, a new event notification instance is provisioned.", |
| 314 | + "required": false |
| 315 | + }, |
| 316 | + { |
| 317 | + "key": "existing_discovery_instance", |
| 318 | + "type": "string", |
| 319 | + "default_value": "__NULL__", |
| 320 | + "description": "The CRN of an existing WatsonX SaaS discovery instance to use in this solution. If not set, a new discovery instance is provisioned depending on which plan is selected.", |
| 321 | + "required": false |
| 322 | + }, |
| 323 | + { |
| 324 | + "key": "existing_assistant_instance_crn", |
| 325 | + "type": "string", |
| 326 | + "default_value": "__NULL__", |
| 327 | + "description": "The CRN of an existing WatsonX SaaS assistant instance to use in this solution. If not set, a new assistant instance is provisioned depending on which plan is selected.", |
| 328 | + "required": false |
| 329 | + }, |
| 330 | + { |
| 331 | + "key": "existing_governance_instance", |
| 332 | + "type": "string", |
| 333 | + "default_value": "__NULL__", |
| 334 | + "description": "The CRN of an existing WatsonX SaaS governance instance to use in this solution. If not set, a new governance instance is provisioned depending on which plan is selected.", |
| 335 | + "required": false |
| 336 | + }, |
| 337 | + { |
| 338 | + "key": "existing_studio_instance", |
| 339 | + "type": "string", |
| 340 | + "default_value": "__NULL__", |
| 341 | + "description": "The CRN of an existing WatsonX SaaS studio instance to use in this solution. If not set, a new studio instance is provisioned depending on which plan is selected.", |
| 342 | + "required": false |
| 343 | + }, |
| 344 | + { |
| 345 | + "key": "existing_machine_learning_instance", |
| 346 | + "type": "string", |
| 347 | + "default_value": "__NULL__", |
| 348 | + "description": "The CRN of an existing WatsonX SaaS machine learning instance to use in this solution. If not set, a new machine learning instance is provisioned depending on which plan is selected.", |
| 349 | + "required": false |
| 350 | + }, |
| 351 | + { |
| 352 | + "key": "existing_elasticsearch_instance_crn", |
| 353 | + "type": "string", |
| 354 | + "default_value": "__NULL__", |
| 355 | + "description": "The CRN of an existing elasticsearch instance to use in this solution. If not set, a new elasticsearch instance is provisioned.", |
| 356 | + "required": false |
288 | 357 | }
|
289 | 358 | ],
|
290 | 359 | "outputs": [
|
| 360 | + { |
| 361 | + "key": "elasticsearch_hostname", |
| 362 | + "description": "The hostname of the Elasticsearch instance." |
| 363 | + }, |
| 364 | + { |
| 365 | + "key": "elasticsearch_port", |
| 366 | + "description": "The port of the Elasticsearch instance." |
| 367 | + }, |
| 368 | + { |
| 369 | + "key": "elasticsearch_service_credentials_json", |
| 370 | + "description": "The service credentials of the Elasticsearch instance." |
| 371 | + }, |
| 372 | + { |
| 373 | + "key": "elasticsearch_crn", |
| 374 | + "description": "The CRN of the Elasticsearch instance." |
| 375 | + }, |
291 | 376 | {
|
292 | 377 | "key": "watsonx_project_url",
|
293 | 378 | "description": "The URL to the WatsonX project for the sample RAG application."
|
|
0 commit comments