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

fix: update architecture diagrams and reorder DAs deployment #26

Merged
merged 5 commits into from
Aug 23, 2024
Merged

fix: update architecture diagrams and reorder DAs deployment #26

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2a8e449
fix: update architecture diagrams
akocbekIBM Aug 20, 2024
479316c
fix: remove extra region param in kms
toddgiguere Aug 22, 2024
2d71254
fix(deps): update to latest version of secret manager
toddgiguere Aug 22, 2024
b54e00d
refactor: rename and reorder stack members
toddgiguere Aug 22, 2024
e6a2d92
chore: fixed checkov skip in json
toddgiguere Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion reference-architecture/RAG Pattern v2-part-2.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion reference-architecture/rag-stack.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions sample_deploy_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"stack_api_key_env": "IBMCLOUD_API_KEY",
"config_order": [
"1 - Account Infrastructure Base",
"2a - Security Service - Key Management",
"2b - WatsonX SaaS services",
"2 - Security Service - Key Management",
"3a - Observability - Logging Monitoring Activity Tracker",
"3b - Databases for Elasticsearch",
"4 - Event Notifications",
"5a - Security Service - Secret Manager",
"5b - Security Service - Security Compliance Center",
"6 - Sample RAG app - Application Lifecycle Management",
"7 - Sample RAG app configuration"
"6 - WatsonX SaaS services",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logically the Elastic DA should be next to Watson (probably right before that). As is, Elastic sits in the middle of the Security / Observability DAs.

From the same perspective, may be we should put the Security Service DAs together, even though some of them are dependent on Event Notififcations and will not be deployed in that exact order.

Overall, I am starting to think that we might consider dropping the numbering from the member DA names - otherwise we get massive changes every time we change the order or add something in the middle. May be we should hold a vote on that.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^^ @toddgiguere

"7 - Sample RAG app - Application Lifecycle Management",
"8 - Sample RAG app configuration"
],
"stack_inputs": {
"prefix": "<YOUR PREFIX HERE>",
Expand Down
188 changes: 94 additions & 94 deletions solutions/basic/stack_definition.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
]
},
{
"name": "2a - Security Service - Key Management",
"name": "2 - Security Service - Key Management",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.a58250eb-8af0-4874-842e-88e66f5ffbb8-global",
"inputs": [
{
Expand Down Expand Up @@ -241,80 +241,6 @@
}
]
},
{
"name": "2b - WatsonX SaaS services",
"version_locator": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.6da72ae0-73c6-43f5-adc5-9d78f08be81d-global",
"inputs": [
{
"name": "ibmcloud_api_key",
"value": ""
},
{
"name": "watsonx_admin_api_key",
"value": "ref:../../inputs/watsonx_admin_api_key"
},
{
"name": "resource_group_name",
"value": "ref:../1 - Account Infrastructure Base/outputs/workload_resource_group_name"
},
{
"name": "location",
"value": "ref:../../inputs/region"
},
{
"name": "resource_prefix",
"value": "ref:../../inputs/prefix"
},
{
"name": "use_existing_resource_group",
"value": true
},
{
"name": "watson_machine_learning_plan",
"value": "v2-standard"
},
{
"name": "existing_machine_learning_instance",
"value": "ref:../../inputs/existing_machine_learning_instance"
},
{
"name": "watson_studio_plan",
"value": "professional-v1"
},
{
"name": "existing_studio_instance",
"value": "ref:../../inputs/existing_studio_instance"
},
{
"name": "watson_discovery_plan",
"value": "do not install"
},
{
"name": "existing_discovery_instance",
"value": "ref:../../inputs/existing_discovery_instance"
},
{
"name": "watsonx_assistant_plan",
"value": "plus"
},
{
"name": "existing_assistant_instance",
"value": "ref:../../inputs/existing_assistant_instance"
},
{
"name": "watsonx_governance_plan",
"value": "do not install"
},
{
"name": "existing_governance_instance",
"value": "ref:../../inputs/existing_governance_instance"
},
{
"name": "cos_kms_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
}
]
},
{
"name": "3a - Observability - Logging Monitoring Activity Tracker",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.6d66c3b4-6b0a-4484-a59e-8f490e3ff8b8-global",
Expand All @@ -329,7 +255,7 @@
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
},
{
"name": "resource_group_name",
Expand Down Expand Up @@ -383,7 +309,7 @@
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../../members/2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../../members/2 - Security Service - Key Management/outputs/kms_instance_crn"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should follow the ref scheme we used in other places - i.e. ref:../2 - Security Service - Key Management/outputs/kms_instance_crn

},
{
"name": "kms_endpoint_type",
Expand Down Expand Up @@ -413,11 +339,11 @@
"inputs": [
{
"name": "kms_endpoint_url",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_private_endpoint"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_private_endpoint"
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
},
{
"name": "kms_endpoint_type",
Expand Down Expand Up @@ -471,7 +397,7 @@
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
},
{
"name": "use_existing_resource_group",
Expand Down Expand Up @@ -513,7 +439,7 @@
},
{
"name": "existing_kms_instance_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
},
{
"name": "use_existing_resource_group",
Expand All @@ -530,7 +456,81 @@
]
},
{
"name": "6 - Sample RAG app - Application Lifecycle Management",
"name": "6 - WatsonX SaaS services",
"version_locator": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.6da72ae0-73c6-43f5-adc5-9d78f08be81d-global",
"inputs": [
{
"name": "ibmcloud_api_key",
"value": ""
},
{
"name": "watsonx_admin_api_key",
"value": "ref:../../inputs/watsonx_admin_api_key"
},
{
"name": "resource_group_name",
"value": "ref:../1 - Account Infrastructure Base/outputs/workload_resource_group_name"
},
{
"name": "location",
"value": "ref:../../inputs/region"
},
{
"name": "resource_prefix",
"value": "ref:../../inputs/prefix"
},
{
"name": "use_existing_resource_group",
"value": true
},
{
"name": "watson_machine_learning_plan",
"value": "v2-standard"
},
{
"name": "existing_machine_learning_instance",
"value": "ref:../../inputs/existing_machine_learning_instance"
},
{
"name": "watson_studio_plan",
"value": "professional-v1"
},
{
"name": "existing_studio_instance",
"value": "ref:../../inputs/existing_studio_instance"
},
{
"name": "watson_discovery_plan",
"value": "do not install"
},
{
"name": "existing_discovery_instance",
"value": "ref:../../inputs/existing_discovery_instance"
},
{
"name": "watsonx_assistant_plan",
"value": "plus"
},
{
"name": "existing_assistant_instance",
"value": "ref:../../inputs/existing_assistant_instance"
},
{
"name": "watsonx_governance_plan",
"value": "do not install"
},
{
"name": "existing_governance_instance",
"value": "ref:../../inputs/existing_governance_instance"
},
{
"name": "cos_kms_crn",
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
}
]
},
{
"name": "7 - Sample RAG app - Application Lifecycle Management",
"version_locator": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.3a73ae21-ca89-4120-836a-3d4da7df7ce0-global",
"inputs": [
{
Expand Down Expand Up @@ -628,7 +628,7 @@
]
},
{
"name": "7 - Sample RAG app configuration",
"name": "8 - Sample RAG app configuration",
"version_locator": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3.d7ea2d8d-b35a-471a-ae83-02b0ea9989b9-global",
"inputs": [
{
Expand All @@ -649,27 +649,27 @@
},
{
"name": "watson_assistant_instance_id",
"value": "ref:../2b - WatsonX SaaS services/outputs/watsonx_assistant_guid"
"value": "ref:../6 - WatsonX SaaS services/outputs/watsonx_assistant_guid"
},
{
"name": "cd_pipeline_id",
"value": "ref:../6 - Sample RAG app - Application Lifecycle Management/outputs/cd_pipeline_id"
"value": "ref:../7 - Sample RAG app - Application Lifecycle Management/outputs/cd_pipeline_id"
},
{
"name": "ci_pipeline_id",
"value": "ref:../6 - Sample RAG app - Application Lifecycle Management/outputs/ci_pipeline_id"
"value": "ref:../7 - Sample RAG app - Application Lifecycle Management/outputs/ci_pipeline_id"
},
{
"name": "watson_machine_learning_instance_guid",
"value": "ref:../2b - WatsonX SaaS services/outputs/watson_machine_learning_guid"
"value": "ref:../6 - WatsonX SaaS services/outputs/watson_machine_learning_guid"
},
{
"name": "watson_machine_learning_instance_resource_name",
"value": "ref:../2b - WatsonX SaaS services/outputs/watson_machine_learning_name"
"value": "ref:../6 - WatsonX SaaS services/outputs/watson_machine_learning_name"
},
{
"name": "watson_machine_learning_instance_crn",
"value": "ref:../2b - WatsonX SaaS services/outputs/watson_machine_learning_crn"
"value": "ref:../6 - WatsonX SaaS services/outputs/watson_machine_learning_crn"
},
{
"name": "toolchain_resource_group",
Expand Down Expand Up @@ -709,7 +709,7 @@
},
{
"name": "cos_kms_crn",
"value": "ref:../2a - Security Service - Key Management/outputs/kms_instance_crn"
"value": "ref:../2 - Security Service - Key Management/outputs/kms_instance_crn"
}
]
}
Expand All @@ -733,19 +733,19 @@
},
{
"name": "watsonx_project_url",
"value": "ref:../7 - Sample RAG app configuration/outputs/watsonx_project_url"
"value": "ref:../8 - Sample RAG app configuration/outputs/watsonx_project_url"
},
{
"name": "watsonx_project_id",
"value": "ref:../7 - Sample RAG app configuration/outputs/watsonx_project_id"
"value": "ref:../8 - Sample RAG app configuration/outputs/watsonx_project_id"
},
{
"name": "watson_discovery_api_url",
"value": "ref:../7 - Sample RAG app configuration/outputs/watson_discovery_api_url"
"value": "ref:../8 - Sample RAG app configuration/outputs/watson_discovery_api_url"
},
{
"name": "watson_discovery_project_id",
"value": "ref:../7 - Sample RAG app configuration/outputs/watson_discovery_project_id"
"value": "ref:../8 - Sample RAG app configuration/outputs/watson_discovery_project_id"
}
]
}