generated from terraform-ibm-modules/stack-ibm-template
-
Notifications
You must be signed in to change notification settings - Fork 12
/
ibm_catalog.json
788 lines (788 loc) · 31.3 KB
/
ibm_catalog.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
{
"products": [
{
"label": "Retrieval Augmented Generation (RAG) Pattern",
"name": "Retrieval_Augmented_Generation_Pattern",
"product_kind": "solution",
"tags": [
"watson",
"banking",
"ibm_created"
],
"keywords": [
"rag",
"watson",
"ai",
"compliance",
"fscloud",
"genai",
"sample",
"ibmcloud",
"financial services",
"watsonx",
"llm",
"retrieval augmented generation",
"secure",
"secret manager",
"key protect",
"scc"
],
"short_description": "Automate RAG deployment with supporting IBM Cloud and watsonx services, embed your enterprise data in generative AI solutions.",
"long_description": "Utilize data from your enterprise to achieve productivity gains in activities related to question/answer conversations, content search, summarization and generation. RAG can be deployed in multiple configurations and is applicable to various industry use cases and solutions.\n\nThis deployable architecture provides a comprehensive foundation for trust, observability, security, and regulatory compliance by configuring and deploying various services and a sample application for a [RAG pattern](https://cloud.ibm.com/docs/pattern-genai-rag?topic=pattern-genai-rag-genai-pattern), including:\n- Configuring IBM Cloud Account with best practices from [IBM Cloud Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about)\n- Deploying key and secrets management services for storage and management of encryption keys and secrets\n- Deploying controls for continuous compliance\n- Deploying observability services for application and platform logging and monitoring\n- Deploying a suite of watsonx services to provide generative AI RAG capabilities\n- Deploying content databases for storing vector embeddings of the documents and content search/retrieval\n- Deploying a sample application in a variety of run times including CI/CD/CC pipelines for secure application lifecycle management\n\nThe above configured and deployed services enable a secure and trustworthy deployment of generative AI applications on IBM Cloud.\n\nThe configurations are flexible and be changed to meet the needs for several types of RAG patterns depending on the chosen combination of technologies and services.\n\nThe generative AI RAG pattern services include:\n- [watsonx.ai](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html?context=wx)\n- [watsonx.data](https://cloud.ibm.com/docs/watsonxdata) (with Milvus)\n- [watsonx.governance](https://dataplatform.cloud.ibm.com/docs/content/svc-welcome/aiopenscale.html?context=wx)\n- [watsonx Assistant](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-welcome-new-assistant)\n- [watsonx Orchestrate](https://www.ibm.com/docs/en/watsonx/watson-orchestrate/current)\n- [Watson Discovery](https://cloud.ibm.com/docs/discovery-data)\n- [Elasticsearch](https://cloud.ibm.com/docs/databases-for-elasticsearch) Enterprise and Platinum edition\n\nThe supporting services include:\n- [Secrets Manager](https://cloud.ibm.com/docs/secrets-manager)\n- [Key Protect](https://cloud.ibm.com/docs/key-protect)\n- [Security and Compliance Center](https://cloud.ibm.com/docs/security-compliance)\n- [Event Notifications](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-getting-started)\n- [Logs](https://cloud.ibm.com/docs/cloud-logs)\n- [Monitoring](https://cloud.ibm.com/docs/monitoring?topic=monitoring-getting-started)\n- [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage)\n- [Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery) toolchains\n- [Container Registry](https://cloud.ibm.com/docs/Registry)\n\nA [sample RAG application](https://github.com/IBM/gen-ai-rag-watsonx-sample-application) is deployed to [Code Engine](https://cloud.ibm.com/docs/codeengine) or [Red Hat OpenShift](https://cloud.ibm.com/docs/openshift) cluster.\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": "RAG Pattern",
"description": "Deploy a RAG pattern with supporting IBM Cloud and watsonx services, and a sample application to Code Engine or Red Hat OpenShift using Continuous Delivery."
},
{
"title": "Implement Security",
"description": "The architecture ensures security by deploying Key Protect and Secrets Manager."
},
{
"title": "Achieve Regulatory Compliance",
"description": "Ensures regulatory compliance by implementing CI/CD/CC pipelines, along with Security and Compliance Center for continuous compliance."
},
{
"title": "Ensure Observability",
"description": "Provides observability by deploying services such as Logs and Monitoring for log analysis and tracking activity."
},
{
"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": "Basic (Deploy on Code Engine)",
"name": "basic",
"working_directory": "solutions/basic",
"compliance": {
"authority": "scc-v3",
"profiles": [
{
"profile_name": "AI Security Guardrails 2.0",
"profile_version": "1.1.0"
}
]
},
"iam_permissions": [
{
"service_name": "iam-groups",
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "cloud-object-storage"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator"
],
"service_name": "iam-identity"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Writer",
"crn:v1:bluemix:public:iam::::role:Administrator"
],
"service_name": "atracker"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "kms"
},
{
"service_name": "compliance",
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "pm-20"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "data-science-experience"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "aiopenscale"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "conversation"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "discovery"
},
{
"service_name": "databases-for-elasticsearch",
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"service_name": "event-notifications",
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Writer",
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "codeengine"
}
],
"architecture": {
"features": [
{
"title": " ",
"description": "Enables:"
},
{
"title": "1. Code Engine for containerized and serverless workloads",
"description": " "
},
{
"title": "2. Elasticsearch Enterprise for building and storing dense vector indexes or keyword search indexes",
"description": " "
},
{
"title": "3. watsonx.ai in-memory vector store for RAG trial and exploration",
"description": " "
},
{
"title": "4. watsonx.ai UI to upload documents",
"description": " "
},
{
"title": "5. watsonx.ai Prompt Lab for inferencing and Prompt Templates",
"description": " "
},
{
"title": "6. watsonx Assistant Conversational Search with embedded LLM",
"description": " "
},
{
"title": "7. Build your own data processing, ingestion pipeline and indexes",
"description": " "
}
],
"diagrams": [
{
"diagram": {
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-pattern.svg",
"caption": "Reference architecture",
"type": "image/svg+xml",
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-pattern.svg"
},
"description": "Reference architecture"
},
{
"diagram": {
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg",
"caption": "Solution components",
"type": "image/svg+xml",
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg"
},
"description": "Solution components"
}
]
},
"configuration": [
{
"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 deploying this solution multiple times.",
"default_value": "rag",
"required": true
},
{
"key": "ibmcloud_api_key",
"type": "password",
"description": "The API Key used to provision all resources created in this solution.",
"required": true
},
{
"key": "signing_key",
"type": "password",
"description": "The key used to sign the application image built by the CI pipeline deployed in this solution; please refer to the documentation at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md for generating the key; if not set, all resources will deploy successfully, but the initial CI pipeline execution will fail at the signing step.",
"display_name": "Multiline secure value",
"default_value": "replace",
"required": false,
"custom_config": {
"type": "multiline_secure_value",
"grouping": "deployment",
"original_grouping": "deployment"
}
},
{
"key": "region",
"type": "string",
"default_value": "us-south",
"description": "The region in which all resources are deployed.",
"required": false,
"options": [
{
"displayname": "us-south",
"value": "us-south"
},
{
"displayname": "eu-de",
"value": "eu-de"
}
]
},
{
"key": "resource_group_name",
"type": "string",
"default_value": "rag-services",
"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.",
"required": false
},
{
"key": "existing_resource_group_name",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "watsonx_admin_api_key",
"type": "password",
"description": "The API key used to provision the watson project resources. If not set, the API key used to deploy the solution is used.",
"required": false
},
{
"key": "secret_manager_service_plan",
"type": "string",
"default_value": "trial",
"description": "The service/pricing plan to use when provisioning a new Secrets Manager instance. Only one trial instance is allowed per account.",
"required": false,
"options": [
{
"displayname": "Trial",
"value": "trial"
},
{
"displayname": "Standard",
"value": "standard"
}
]
},
{
"key": "existing_secrets_manager_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing secret manager instance to use in this solution. If not set, a new secret manager instance is provisioned.",
"required": false
},
{
"key": "enable_platform_logs_metrics",
"type": "boolean",
"default_value": false,
"description": "Whether to provision logging and monitoring instances are configured to receive all platform logs and metrics in the target region. There can only be one instance per region provisioned for platform logs/metrics.",
"required": false
},
{
"key": "sample_app_git_url",
"type": "string",
"default_value": "https://github.com/IBM/gen-ai-rag-watsonx-sample-application",
"description": "The URL to the public git repository containing the sample rag application code.",
"required": false
},
{
"key": "existing_kms_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing KMS instance to use in this solution. If not set, a new KP instance is provisioned.",
"required": false
},
{
"key": "existing_event_notification_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing event notification instance to use in this solution. If not set, a new event notification instance is provisioned.",
"required": false
},
{
"key": "existing_discovery_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_assistant_instance_crn",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_governance_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_studio_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_machine_learning_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_elasticsearch_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing elasticsearch instance to use in this solution. If not set, a new elasticsearch instance is provisioned.",
"required": false
}
],
"outputs": [
{
"key": "elasticsearch_hostname",
"description": "The hostname of the Elasticsearch instance."
},
{
"key": "elasticsearch_port",
"description": "The port of the Elasticsearch instance."
},
{
"key": "elasticsearch_service_credentials_json",
"description": "The service credentials of the Elasticsearch instance."
},
{
"key": "elasticsearch_crn",
"description": "The CRN of the Elasticsearch instance."
},
{
"key": "watsonx_project_url",
"description": "The URL to the WatsonX project for the sample RAG application."
},
{
"key": "watsonx_project_id",
"description": "The ID for the WatsonX project for the sample RAG application."
},
{
"key": "watson_discovery_api_url",
"description": "The URL to the Watson Discovery API endpoint."
},
{
"key": "watson_discovery_project_id",
"description": "The ID for the Watson Discovery project for the sample RAG application."
}
],
"install_type": "fullstack"
},
{
"label": "Standard (Deploy on Red Hat OpenShift)",
"name": "standard",
"working_directory": "solutions/standard",
"compliance": {
"authority": "scc-v3",
"profiles": [
{
"profile_name": "AI Security Guardrails 2.0",
"profile_version": "1.1.0"
}
]
},
"iam_permissions": [
{
"service_name": "iam-groups",
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "cloud-object-storage"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator",
"crn:v1:bluemix:public:iam-identity::::serviceRole:UserApiKeyCreator"
],
"service_name": "iam-identity"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Writer",
"crn:v1:bluemix:public:iam::::role:Administrator"
],
"service_name": "atracker"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "kms"
},
{
"service_name": "compliance",
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "pm-20"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "data-science-experience"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "aiopenscale"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "conversation"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
],
"service_name": "discovery"
},
{
"service_name": "databases-for-elasticsearch",
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"service_name": "event-notifications",
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Editor"
]
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator"
],
"service_name": "containers-kubernetes"
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Administrator"
],
"service_name": "is.vpc"
}
],
"architecture": {
"features": [
{
"title": " ",
"description": "Enables:"
},
{
"title": "1. Red Hat OpenShift cluster for microservices workloads",
"description": " "
},
{
"title": "2. Elasticsearch Platinum for building and storing sparse vectors, dense vector indexes or keyword search indexes",
"description": " "
},
{
"title": "i. watsonx.ai use of Elasticsearch ELSER2 vector index for RAG",
"description": " "
},
{
"title": "ii. watsonx Assistant Conversational Search with UI feature for uploading documents to create or use Elasticsearch ELSER2 vector index for RAG",
"description": " "
},
{
"title": "3. watsonx.ai in-memory vector store for RAG trial and exploration",
"description": " "
},
{
"title": "4. watsonx.ai UI to upload documents",
"description": " "
},
{
"title": "5. watsonx.ai Prompt Lab for inferencing and Prompt Templates",
"description": " "
},
{
"title": "6. watsonx Assistant Conversational Search with embedded LLM",
"description": " "
},
{
"title": "7. Build your own data processing, ingestion pipeline and indexes",
"description": " "
}
],
"diagrams": [
{
"diagram": {
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-pattern.svg",
"caption": "Reference architecture",
"type": "image/svg+xml",
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-pattern.svg"
},
"description": "Reference architecture"
},
{
"diagram": {
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg",
"caption": "Solution components",
"type": "image/svg+xml",
"thumbnail_url": "https://raw.githubusercontent.com/terraform-ibm-modules/stack-retrieval-augmented-generation/main/reference-architecture/rag-stack.svg"
},
"description": "Solution components"
}
]
},
"configuration": [
{
"key": "prefix",
"type": "string",
"description": "A prefix added to the name of all resources created by this solution. Must start with a letter, contain only lowercase letters, numbers, or dashes, and be 13 characters or less. Used to avoid name clashes in the target account when deploying this solution multiple times.",
"default_value": "rag",
"required": true
},
{
"key": "ibmcloud_api_key",
"type": "password",
"description": "The API Key used to provision all resources created in this solution.",
"required": true
},
{
"key": "signing_key",
"type": "password",
"description": "The key used to sign the application image built by the CI pipeline deployed in this solution; please refer to the documentation at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md for generating the key; if not set, all resources will deploy successfully, but the initial CI pipeline execution will fail at the signing step.",
"display_name": "Multiline secure value",
"default_value": "replace",
"required": false,
"custom_config": {
"type": "multiline_secure_value",
"grouping": "deployment",
"original_grouping": "deployment"
}
},
{
"key": "region",
"type": "string",
"default_value": "us-south",
"description": "The region in which all resources are deployed.",
"required": false,
"options": [
{
"displayname": "us-south",
"value": "us-south"
},
{
"displayname": "eu-de",
"value": "eu-de"
}
]
},
{
"key": "resource_group_name",
"type": "string",
"default_value": "rag-services",
"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.",
"required": false
},
{
"key": "existing_resource_group_name",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "watsonx_admin_api_key",
"type": "password",
"description": "The API key used to provision the watson project resources. If not set, the API key used to deploy the solution is used.",
"required": false
},
{
"key": "secret_manager_service_plan",
"type": "string",
"default_value": "trial",
"description": "The service/pricing plan to use when provisioning a new Secrets Manager instance. Only one trial instance is allowed per account.",
"required": false,
"options": [
{
"displayname": "Trial",
"value": "trial"
},
{
"displayname": "Standard",
"value": "standard"
}
]
},
{
"key": "existing_secrets_manager_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing secret manager instance to use in this solution. If not set, a new secret manager instance is provisioned.",
"required": false
},
{
"key": "enable_platform_logs_metrics",
"type": "boolean",
"default_value": false,
"description": "Whether to provision logging and monitoring instances are configured to receive all platform logs and metrics in the target region. There can only be one instance per region provisioned for platform logs/metrics.",
"required": false
},
{
"key": "sample_app_git_url",
"type": "string",
"default_value": "https://github.com/IBM/gen-ai-rag-watsonx-sample-application",
"description": "The URL to the public git repository containing the sample rag application code.",
"required": false
},
{
"key": "existing_kms_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing KMS instance to use in this solution. If not set, a new KP instance is provisioned.",
"required": false
},
{
"key": "existing_event_notification_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing event notification instance to use in this solution. If not set, a new event notification instance is provisioned.",
"required": false
},
{
"key": "existing_discovery_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_assistant_instance_crn",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_governance_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_studio_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_machine_learning_instance",
"type": "string",
"default_value": "__NULL__",
"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.",
"required": false
},
{
"key": "existing_elasticsearch_instance_crn",
"type": "string",
"default_value": "__NULL__",
"description": "The CRN of an existing elasticsearch instance to use in this solution. If not set, a new elasticsearch instance is provisioned.",
"required": false
}
],
"outputs": [
{
"key": "elasticsearch_hostname",
"description": "The hostname of the Elasticsearch instance."
},
{
"key": "elasticsearch_port",
"description": "The port of the Elasticsearch instance."
},
{
"key": "elasticsearch_service_credentials_json",
"description": "The service credentials of the Elasticsearch instance."
},
{
"key": "elasticsearch_crn",
"description": "The CRN of the Elasticsearch instance."
},
{
"key": "watsonx_project_url",
"description": "The URL to the WatsonX project for the sample RAG application."
},
{
"key": "watsonx_project_id",
"description": "The ID for the WatsonX project for the sample RAG application."
},
{
"key": "watson_discovery_api_url",
"description": "The URL to the Watson Discovery API endpoint."
},
{
"key": "watson_discovery_project_id",
"description": "The ID for the Watson Discovery project for the sample RAG application."
}
],
"install_type": "fullstack"
}
]
}
]
}