Skip to content

Commit

Permalink
feat: number of enhancements (#88)
Browse files Browse the repository at this point in the history 
* docs: minor fixes

* docs: fix typo

* docs: add support string

* feat: bump version numbers for base da to 1.6, alm da to 1.6.2

* feat: add suffix to container registry name

* feat: disable create of unused trusted profile

* feat: reintroduce default prefix

* docs: add tile description in code
  • Loading branch information
@vburckhardt
vburckhardt authored May 16, 2024
1 parent 9061928 commit e086005
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 10 deletions.
27 changes: 26 additions & 1 deletion ibm_catalog.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,34 @@
"watson",
"ai"
],
"short_description": "An automated solution that deploys a sample application illustrating how to implement the RAG Pattern with watson.ai and IBM Cloud services.",
"short_description": "A solution that automates the deployment of a sample Retrieval Augmented Generation application on IBM Cloud, including all underlying IBM Cloud infrastructure and Watson services.",
"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.",
"offering_docs_url": "https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md",
"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/solution.svg",
"provider_name": "IBM",
"features": [
{
"title": "Retrieval Augmented Generation sample pattern",
"description": "Deploy a banking retrieval augmented generation (RAG) sample application to IBM Cloud Code Engine using Continous Delivery."
},
{
"title": "Ensure Observability",
"description": "Provides observability by deploying services such as IBM Log Analysis, IBM Monitoring, IBM Activity Tracker, and log retention."
},
{
"title": "Implement Security",
"description": "The architecture ensures security by deploying IBM Key Protect and IBM Secrets Manager."
},
{
"title": "Achieve Regulatory Compliance",
"description": "Ensures regulatory compliance by implementing CI/CD/CC pipelines, along with IBM SCC for secure application lifecycle management."
},
{
"title": "Establish Trust",
"description": "Ensures trust by configuring the IBM Cloud account to align with compliance settings as defined in the Financial Services framework."
}
],
"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.",
"flavors": [
{
"label": "Deploy on Code Engine",
Expand Down Expand Up @@ -152,6 +176,7 @@
"key": "prefix",
"type": "string",
"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.",
"default_value": "rag",
"required": true
},
{
Expand Down
27 changes: 18 additions & 9 deletions stack_definition.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"name": "prefix",
"required": true,
"type": "string",
"hidden": false
"hidden": false,
"default": "rag"
},
{
"name": "secret_manager_service_plan",
Expand Down Expand Up @@ -70,7 +71,7 @@
"members": [
{
"name": "1 - Account Infrastructure Base",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.0fb5dd09-ac56-455e-bed7-9c9bf4c949bb-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.518bc17d-4629-457b-a4b4-66255a501301-global",
"inputs": [
{
"name": "prefix",
Expand Down Expand Up @@ -111,12 +112,16 @@
{
"name": "devops_resource_group_name",
"value": "ref:../../inputs/resource_group_name"
},
{
"name": "provision_trusted_profile_projects",
"value": false
}
]
},
{
"name": "2a - Security Service - Key Management",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.8e0a8f36-6bee-4611-b78a-bfce1dd8f0fe-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.2cdc89ae-daff-471a-9902-ad989376c23b-global",
"inputs": [
{
"name": "resource_group_name",
Expand All @@ -142,7 +147,7 @@
},
{
"name": "2b - Security Service - Secret Manager",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.4c4b156f-22ff-47be-8519-a09d5fb80d9c-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.ba032ffb-286c-4a00-ad79-ae9e09cea687-global",
"inputs": [
{
"name": "prefix",
Expand Down Expand Up @@ -180,7 +185,7 @@
},
{
"name": "2c - Security Service - Security Compliance Center",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.a719a939-8402-4ad2-a846-db4e05dd5122-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.9e036202-5495-4ea3-926b-3751450bbf54-global",
"inputs": [
{
"name": "ibmcloud_api_key",
Expand Down Expand Up @@ -214,7 +219,7 @@
},
{
"name": "3 - Observability - Logging Monitoring Activity Tracker",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.08d35739-6419-492d-8dbf-0a45c01a7fdd-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.9f478815-8a89-45f1-9889-7a82fa002b5a-global",
"inputs": [
{
"name": "ibmcloud_api_key",
Expand Down Expand Up @@ -252,7 +257,7 @@
},
{
"name": "4 - WatsonX SaaS services",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.570d8bf4-65dd-41dd-92bf-718e5afac34f-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.a8504fac-eb37-4aa0-a284-f26e876b5750-global",
"inputs": [
{
"name": "ibmcloud_api_key",
Expand Down Expand Up @@ -306,7 +311,7 @@
},
{
"name": "5 - Sample RAG app - Application Lifecycle Management",
"version_locator": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.c9d011c4-f1eb-4dae-87e9-fe20372d90a5-global",
"version_locator": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.3202356b-d72a-4263-af31-46d0f33f6614-global",
"inputs": [
{
"name": "ibmcloud_api_key",
Expand Down Expand Up @@ -403,12 +408,16 @@
{
"name": "code_engine_project_prefix",
"value": "ref:../../inputs/prefix"
},
{
"name": "add_container_name_suffix",
"value": true
}
]
},
{
"name": "6 - Sample RAG app configuration",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.9d2aeea2-a271-48fe-8c76-b878d3594d6e-global",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.f84e9973-24c0-4510-82a7-f7f7e782540d-global",
"inputs": [
{
"name": "toolchain_region",
Expand Down

0 comments on commit e086005

Please sign in to comment.