Skip to content

Commit 02122e4

Browse files
rajatagarwal-ibmdaniel-butler-irl
rajatagarwal-ibm
and
daniel-butler-irl
authored
feat: add dependencies (#445)
* add sm permissions * add cos dependency * address comments --------- Co-authored-by: Daniel Butler <[email protected]>
1 parent 7f06510 commit 02122e4

File tree

2 files changed

+232
-41
lines changed

2 files changed

+232
-41
lines changed

‎cra-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CRA_TARGETS:
55
CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
66
PROFILE_ID: "fe96bd4d-9b37-40f2-b39f-a62760e326a3" # SCC profile ID (currently set to 'IBM Cloud Framework for Financial Services' '1.7.0' profile).
77
CRA_ENVIRONMENT_VARIABLES:
8-
TF_VAR_prefix: "test"
8+
TF_VAR_prefix: "test-fc"
99
TF_VAR_existing_resource_group_name: "Default"
1010
TF_VAR_existing_kms_instance_crn: "crn:v1:bluemix:public:hs-crypto:us-south:a/abac0df06b644a9cabc6e44f55b3880e:e6dce284-e80f-46e1-a3c1-830f7adff7a9::"
1111
TF_VAR_kms_endpoint_url: "https://e6dce284-e80f-46e1-a3c1-830f7adff7a9.api.private.us-south.hs-crypto.appdomain.cloud"

‎ibm_catalog.json‎

Lines changed: 231 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@
2929
"features": [
3030
{
3131
"title": "Creates an IBM Cloud Event Notifications instance",
32-
"description": "Creates an IBM Cloud Event Notifications instance."
32+
"description": "For more details on an IBM Cloud Event Notifications instance, [see here](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-about)."
3333
},
3434
{
35-
"title": "Creates Key Rings and Keys",
36-
"description": "Creates Key Rings and Keys in an existing KMS instance used to encrypt data."
35+
"title": "Creates Key Rings and Keys to encrypt data",
36+
"description": "For more details on managing encryption using an existing Key Management Services (Key Protect or HPCS) instance, [see here](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-managing-encryption)."
3737
},
3838
{
3939
"title": "Collect events that fail delivery",
40-
"description": "Connect an existing IBM Cloud Object Storage service instance and bucket to collect events that fail delivery. Alternatively, create instances to connect to an Event Notifications instance."
40+
"description": "Connect an existing IBM Cloud Object Storage (COS) service instance and creates a new bucket to collect events that fail delivery. For more details on collecting failed events [see here](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-cfe-integrations)."
4141
}
4242
],
4343
"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/terraform-ibm-event-notifications/issues](https://github.com/terraform-ibm-modules/terraform-ibm-event-notifications/issues). Please note this product is not supported via the IBM Cloud Support Center.",
@@ -64,18 +64,6 @@
6464
"key": "prefix",
6565
"required": true
6666
},
67-
{
68-
"key": "existing_resource_group_name",
69-
"required": true,
70-
"custom_config": {
71-
"type": "resource_group",
72-
"grouping": "deployment",
73-
"original_grouping": "deployment",
74-
"config_constraints": {
75-
"identifier": "rg_name"
76-
}
77-
}
78-
},
7967
{
8068
"key": "region",
8169
"required": true,
@@ -126,6 +114,18 @@
126114
"key": "kms_endpoint_url",
127115
"required": true
128116
},
117+
{
118+
"key": "existing_resource_group_name",
119+
"display_name": "resource_group",
120+
"custom_config": {
121+
"type": "resource_group",
122+
"grouping": "deployment",
123+
"original_grouping": "deployment",
124+
"config_constraints": {
125+
"identifier": "rg_name"
126+
}
127+
}
128+
},
129129
{
130130
"key": "existing_monitoring_crn"
131131
},
@@ -199,7 +199,8 @@
199199
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
200200
"crn:v1:bluemix:public:iam::::role:Editor"
201201
],
202-
"service_name": "event-notifications"
202+
"service_name": "event-notifications",
203+
"notes": "[Optional] Required if you are creating an Event Notifications Instance."
203204
}
204205
],
205206
"architecture": {
@@ -227,7 +228,8 @@
227228
"description": "This architecture supports creating and configuring an IBM Cloud Event Notifications instance."
228229
}
229230
]
230-
}
231+
},
232+
"terraform_version": "1.10.5"
231233
},
232234
{
233235
"label": "Fully configurable",
@@ -251,18 +253,6 @@
251253
"key": "prefix",
252254
"required": true
253255
},
254-
{
255-
"key": "existing_resource_group_name",
256-
"required": true,
257-
"custom_config": {
258-
"type": "resource_group",
259-
"grouping": "deployment",
260-
"original_grouping": "deployment",
261-
"config_constraints": {
262-
"identifier": "rg_name"
263-
}
264-
}
265-
},
266256
{
267257
"key": "region",
268258
"required": true,
@@ -305,12 +295,6 @@
305295
}
306296
]
307297
},
308-
{
309-
"key": "existing_monitoring_crn"
310-
},
311-
{
312-
"key": "event_notifications_instance_name"
313-
},
314298
{
315299
"key": "service_plan",
316300
"options": [
@@ -322,7 +306,26 @@
322306
"displayname": "standard",
323307
"value": "standard"
324308
}
325-
]
309+
],
310+
"required": true
311+
},
312+
{
313+
"key": "existing_resource_group_name",
314+
"display_name": "resource_group",
315+
"custom_config": {
316+
"type": "resource_group",
317+
"grouping": "deployment",
318+
"original_grouping": "deployment",
319+
"config_constraints": {
320+
"identifier": "rg_name"
321+
}
322+
}
323+
},
324+
{
325+
"key": "existing_monitoring_crn"
326+
},
327+
{
328+
"key": "event_notifications_instance_name"
326329
},
327330
{
328331
"key": "service_endpoints",
@@ -364,6 +367,7 @@
364367
},
365368
{
366369
"key": "kms_endpoint_type",
370+
"hidden": true,
367371
"options": [
368372
{
369373
"displayname": "public",
@@ -487,7 +491,64 @@
487491
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
488492
"crn:v1:bluemix:public:iam::::role:Editor"
489493
],
490-
"service_name": "event-notifications"
494+
"service_name": "event-notifications",
495+
"notes": "[Optional] Required if you are creating an Event Notifications Instance."
496+
},
497+
{
498+
"role_crns": [
499+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
500+
"crn:v1:bluemix:public:iam::::role:Editor"
501+
],
502+
"service_name": "sysdig-monitor",
503+
"notes": "[Optional] Required if you are consuming Observability DA which sets up Cloud monitoring."
504+
},
505+
{
506+
"role_crns": [
507+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
508+
"crn:v1:bluemix:public:iam::::role:Editor"
509+
],
510+
"service_name": "logs",
511+
"notes": "[Optional] Required if you are consuming Observability DA which sets up Cloud logs."
512+
},
513+
{
514+
"role_crns": [
515+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
516+
"crn:v1:bluemix:public:iam::::role:Editor"
517+
],
518+
"service_name": "cloud-object-storage",
519+
"notes": "[Optional] Required if COS is chosen for target of Activity Tracker Event routing or Cloud logs data or cloud logs metrics or collecting Event Notifications failed events."
520+
},
521+
{
522+
"role_crns": [
523+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
524+
"crn:v1:bluemix:public:iam::::role:Editor"
525+
],
526+
"service_name": "hs-crypto",
527+
"notes": "[Optional] Required if you are creating/configuring keys in an existing Hyper Protect Crypto Services (HPCS) instance for encryption."
528+
},
529+
{
530+
"role_crns": [
531+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
532+
"crn:v1:bluemix:public:iam::::role:Editor"
533+
],
534+
"service_name": "kms",
535+
"notes": "[Optional] Required if you are creating/configuring Key Protect (KP) instance and keys for encryption."
536+
},
537+
{
538+
"role_crns": [
539+
"crn:v1:bluemix:public:iam::::role:Administrator"
540+
],
541+
"service_name": "iam-identity",
542+
"notes": "[Optional] Required if Cloud automation for account configuration is enabled."
543+
},
544+
{
545+
"role_crns": [
546+
"crn:v1:bluemix:public:iam::::role:Operator",
547+
"crn:v1:bluemix:public:iam::::serviceRole:Writer",
548+
"crn:v1:bluemix:public:iam::::serviceRole:Manager"
549+
],
550+
"service_name": "secrets-manager",
551+
"notes": "[Optional] Required if you wish to write the Event notification service credentials to an existing IBM Cloud Secrets Manager instance. 'Manager' access required if new secrets group creation is needed."
491552
}
492553
],
493554
"architecture": {
@@ -502,7 +563,7 @@
502563
},
503564
{
504565
"title": "Collects events that fail delivery",
505-
"description": "Connect an existing Object Storage service instance and bucket. Alternatively, create instances to connect to an Event Notifications instance and collect events that faile delivery."
566+
"description": "Connect an existing IBM Cloud Object Storage (COS) service instance and creates a new bucket to collect events that fail delivery."
506567
}
507568
],
508569
"diagrams": [
@@ -515,7 +576,137 @@
515576
"description": "This architecture supports creating and configuring an IBM Cloud Event Notifications instance."
516577
}
517578
]
518-
}
579+
},
580+
"dependencies": [
581+
{
582+
"name": "deploy-arch-ibm-account-infra-base",
583+
"description": "Cloud automation for Account Configuration organizes your IBM Cloud account with a ready-made set of resource groups by default—and, when you enable the “with Account Settings” option, it also applies baseline security and governance settings.",
584+
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
585+
"flavors": [
586+
"resource-group-only",
587+
"resource-groups-with-account-settings"
588+
],
589+
"default_flavour": "resource-group-only",
590+
"id": "63641cec-6093-4b4f-b7b0-98d2f4185cd6-global",
591+
"input_mapping": [
592+
{
593+
"dependency_input": "prefix",
594+
"version_input": "prefix",
595+
"reference_version": true
596+
},
597+
{
598+
"dependency_output": "observability_resource_group_name",
599+
"version_input": "existing_resource_group_name"
600+
},
601+
{
602+
"dependency_input": "provider_visibility",
603+
"version_input": "provider_visibility",
604+
"reference_version": true
605+
}
606+
],
607+
"optional": true,
608+
"on_by_default": false,
609+
"version": "v3.0.7"
610+
},
611+
{
612+
"name": "deploy-arch-ibm-observability",
613+
"description": "Enable to provisions and configures IBM Cloud Monitoring, Activity Tracker, and Log Analysis services for analysing events generated from the Events Notification instance.",
614+
"flavors": [
615+
"instances"
616+
],
617+
"id": "a3137d28-79e0-479d-8a24-758ebd5a0eab-global",
618+
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
619+
"input_mapping": [
620+
{
621+
"dependency_output": "cloud_monitoring_crn",
622+
"version_input": "existing_monitoring_crn"
623+
},
624+
{
625+
"dependency_input": "prefix",
626+
"version_input": "prefix",
627+
"reference_version": true
628+
},
629+
{
630+
"dependency_input": "region",
631+
"version_input": "region",
632+
"reference_version": true
633+
}
634+
],
635+
"optional": true,
636+
"on_by_default": true,
637+
"version": "v3.0.3"
638+
},
639+
{
640+
"name": "deploy-arch-ibm-kms",
641+
"id": "2cad4789-fa90-4886-9c9e-857081c273ee-global",
642+
"description": "Enable Cloud Automation for Key Protect when you want services to use your own managed encryption keys. If disabled, it will fall back on IBM Cloud's default service-managed encryption.",
643+
"flavors": [
644+
"fully-configurable"
645+
],
646+
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
647+
"input_mapping": [
648+
{
649+
"dependency_output": "kms_instance_crn",
650+
"version_input": "existing_kms_instance_crn"
651+
},
652+
{
653+
"dependency_output": "kms_private_endpoint",
654+
"version_input": "kms_endpoint_url"
655+
},
656+
{
657+
"version_input": "kms_encryption_enabled",
658+
"value": true
659+
},
660+
{
661+
"dependency_input": "prefix",
662+
"version_input": "prefix",
663+
"reference_version": true
664+
},
665+
{
666+
"dependency_input": "region",
667+
"version_input": "region",
668+
"reference_version": true
669+
}
670+
],
671+
"optional": true,
672+
"on_by_default": true,
673+
"version": "v5.1.4"
674+
},
675+
{
676+
"name": "deploy-arch-ibm-cos",
677+
"id": "68921490-2778-4930-ac6d-bae7be6cd958-global",
678+
"description": "Enable to create an IBM Cloud Object Storage(COS) instance to store failed Event Notifications events.",
679+
"flavors": [
680+
"instance"
681+
],
682+
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
683+
"input_mapping": [
684+
{
685+
"dependency_output": "cos_instance_crn",
686+
"version_input": "existing_cos_instance_crn"
687+
},
688+
{
689+
"dependency_input": "prefix",
690+
"version_input": "prefix",
691+
"reference_version": true
692+
},
693+
{
694+
"dependency_input": "resource_group_name",
695+
"version_input": "existing_resource_group_name",
696+
"reference_version": true
697+
},
698+
{
699+
"version_input": "enable_collecting_failed_events",
700+
"value": true
701+
}
702+
],
703+
"optional": true,
704+
"on_by_default": false,
705+
"version": "v8.21.25"
706+
}
707+
],
708+
"dependency_version_2": true,
709+
"terraform_version": "1.10.5"
519710
}
520711
]
521712
}

0 commit comments

Comments
 (0)