|
2 | 2 |
|
3 | 3 | The following [deployable architecture](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understand-module-da#what-is-da) automates the deployment of a sample gen AI Pattern on IBM Cloud, including all underlying IBM Cloud and WatsonX infrastructure. This architecture implements the best practices for watsonx gen AI Pattern deployment on IBM Cloud, as described in the [reference architecture](https://cloud.ibm.com/docs/pattern-genai-rag?topic=pattern-genai-rag-genai-pattern). |
4 | 4 |
|
5 | | -This deployable architecture provides a comprehensive foundation for trust, observability, security, and regulatory compliance. The architecture configures an IBM Cloud account to align with compliance settings. It also deploys key management and secrets management services and the infrastructure to support continuous integration (CI), continuous delivery (CD), and continuous compliance (CC) pipelines for secure management of the application lifecycle. It also deploys the WatsonX services suite and IBM Cloud Elasticsearch to faciliate a RAG pattern. These pipelines facilitate the deployment of the application, check for vulnerabilities and auditability, and help ensure a secure and trustworthy deployment of generative AI applications on IBM Cloud. |
| 5 | +This deployable architecture provides a comprehensive foundation for trust, observability, security, and regulatory compliance. The architecture configures an IBM Cloud account to align with compliance settings. It also deploys key management and secrets management services and the infrastructure to support continuous integration (CI), continuous delivery (CD), and continuous compliance (CC) pipelines for secure management of the application lifecycle. It also deploys the WatsonX services suite and IBM Cloud Elasticsearch to facilitate a RAG pattern. These pipelines facilitate the deployment of the application, check for vulnerabilities and auditability, and help ensure a secure and trustworthy deployment of generative AI applications on IBM Cloud. |
6 | 6 |
|
7 | 7 | ## Variations |
8 | 8 |
|
9 | | -Two variations are available for this deployable architecture: |
10 | | -1. Basic variation: |
| 9 | +This deployable architecture is available in four variations, grouped into two categories (Basic and Standard). Each category offers an option with or without a sample application deployment or pipeline: |
| 10 | + |
| 11 | +1. Basic variation - With sample application: |
11 | 12 | - Code Engine Project: Provisions a Code Engine project, providing a fully managed platform for containerized applications. |
12 | 13 | - Application Deployment: Deploys the application on the provisioned Code Engine project. |
13 | 14 | - Elasticsearch Enterprise: Provisions an Elasticsearch [enterprise](https://cloud.ibm.com/docs/databases-for-elasticsearch?topic=databases-for-elasticsearch-elastic-offerings) instance for search and analytics capabilities. |
14 | 15 |
|
15 | | -2. Standard variation: |
| 16 | +2. Standard variation - With sample application: |
16 | 17 | - IBM Cloud OpenShift Cluster: Provisions an [IBM Cloud OpenShift cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-overview) |
17 | 18 | - VPC Network Infrastructure: Sets up the underlying VPC network infrastructure to support the OpenShift cluster. |
18 | 19 | - Application Deployment: Deploys the application on the provisioned OpenShift cluster. |
19 | 20 | - ElasticSearch Platinum Plan: Leverages the platinum plan of ElasticSearch, which includes the [ELSER](https://cloud.ibm.com/docs/databases-for-elasticsearch?topic=databases-for-elasticsearch-elser-embeddings-elasticsearch) model for advanced vector generation capabilities. |
20 | 21 |
|
| 22 | +3. Basic variation: |
| 23 | + - Code Engine Project: Provisions a Code Engine project, providing a fully managed platform for containerized applications. |
| 24 | + - Elasticsearch Enterprise: Provisions an Elasticsearch [enterprise](https://cloud.ibm.com/docs/databases-for-elasticsearch?topic=databases-for-elasticsearch-elastic-offerings) instance for search and analytics capabilities. |
21 | 25 |
|
| 26 | +4. Standard variation: |
| 27 | + - IBM Cloud OpenShift Cluster: Provisions an [IBM Cloud OpenShift cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-overview) |
| 28 | + - VPC Network Infrastructure: Sets up the underlying VPC network infrastructure to support the OpenShift cluster. |
| 29 | + - ElasticSearch Platinum Plan: Leverages the platinum plan of ElasticSearch, which includes the [ELSER](https://cloud.ibm.com/docs/databases-for-elasticsearch?topic=databases-for-elasticsearch-elser-embeddings-elasticsearch) model for advanced vector generation capabilities. |
22 | 30 |
|
23 | 31 | ## Objective and benefits |
24 | 32 |
|
25 | | -This deployable architecture is designed to showcase a fully automated deployment of a retrieval augmented generation application through IBM Cloud Projects. It provides a flexible and customizable foundation for your own watsonx applications on IBM Cloud. This architecture deploys the following [sample application](https://github.com/IBM/gen-ai-rag-watsonx-sample-application) by default. |
| 33 | +This deployable architecture is designed to showcase a fully automated deployment of a retrieval augmented generation application through IBM Cloud Projects. It provides a flexible and customizable foundation for your own watsonx applications on IBM Cloud. This architecture deploys the following [sample application](https://github.com/IBM/gen-ai-rag-watsonx-sample-application) by default for the variations that allow provisioning sample application. |
26 | 34 |
|
27 | 35 | By using this architecture, you can accelerate your deployment and tailor it to meet your business needs and enterprise goals. |
28 | 36 |
|
@@ -239,3 +247,20 @@ To use your own app, remove the `Workload - Sample RAG Application` member confi |
239 | 247 | 1. Delete the project. |
240 | 248 |
|
241 | 249 | To undeploy the infrastructure created by the deployable architecture, follow the steps in [Deleting a project](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-delete-project) in the IBM Cloud docs. |
| 250 | + |
| 251 | +## Known Issues |
| 252 | + |
| 253 | +[The Standard (OpenShift) variation is currently not idempotent](https://github.com/terraform-ibm-modules/stack-ibm-retrieval-augmented-generation/issues/247). |
| 254 | + |
| 255 | +Both the `Landing zone` Deployable Architecture (DA) and the `Landing zone for cloud-native AI applications` Deployable Architecture (DA) attempt to manage the same `Access Control Lists (ACLs)`. |
| 256 | +This may result in duplicate or conflicting updates as the same ACL resource is updated from two independent Terraform states. |
| 257 | + |
| 258 | +**Impact:** |
| 259 | + |
| 260 | +- Non‑idempotent applies: `terraform apply` may produce updates even when no configuration changes exist. |
| 261 | + |
| 262 | +- Unexpected diffs: Terraform may show differences in ACL rules because another state has modified the resource. |
| 263 | + |
| 264 | +- Apply failures: Concurrent updates from both DAs may trigger errors such as “object changed outside of Terraform. |
| 265 | + |
| 266 | +These issues occur only in environments where both DAs are applied independently and target the same ACL resource. |
0 commit comments