Skip to content

Commit 9616b28

Browse files
authored
feat: added support for IBM Cloud Logs. By default, the instances variation will now deploy this instead of Log Analysis. To manage platform logs that are generated by IBM Cloud® services in a region of IBM Cloud, you must create a tenant in each region that you operate. This can be done passing the regions into the logs_routing_tenant_regions input.<br>- Activity tracking will still send events to a COS bucket target, but now by default it will also send them to IBM Cloud Logs. These settings can be toggled using the enable_at_event_routing_to_cloud_logs and enable_at_event_routing_to_cos_bucket boolean inputs.<br>- **Upgrade considerations:**<br> - If you are upgrading from a previous version, and using the default inputs, you will see the Log Analysis instance identified for destroy. If you are not ready yet to destroy it, you can toggle the values of the log_analysis_provision and cloud_logs_provision inputs, but please be aware that Log Analysis is a deprecated service, and new instances cannot be provisioned after November 30, 2024. (#137)
1 parent 43fcf99 commit 9616b28

File tree

9 files changed

+406
-50
lines changed

9 files changed

+406
-50
lines changed

ibm_catalog.json

Lines changed: 112 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"solution",
1919
"observability",
2020
"observability instances",
21+
"cloud logs",
2122
"log analysis",
2223
"cloud monitoring",
2324
"ATracker",
@@ -30,6 +31,10 @@
3031
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/images/observability-icon.svg",
3132
"provider_name": "IBM",
3233
"features": [
34+
{
35+
"title": "Configures IBM Cloud Logs",
36+
"description": "Configures an IBM Cloud Logs instance."
37+
},
3338
{
3439
"title": "Configures IBM Log Analysis",
3540
"description": "Configures the IBM Log Analysis instance and logging agents."
@@ -41,7 +46,7 @@
4146
{
4247

4348
"title": "Configures IBM Cloud Activity Tracker Event Routing",
44-
"description": "Configures an IBM Cloud Activity Tracker route with a Cloud Object Storage and Log Analysis target."
49+
"description": "Configures an IBM Cloud Activity Tracker route with a Cloud Object Storage, Log Analysis and Cloud Logs target."
4550
}
4651
],
4752
"support_details": "This product is in the community registry and support is handled in the source repo. You can open an issue at [https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/issues](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/issues). Support is not offered through IBM Cloud Support.",
@@ -93,6 +98,13 @@
9398
"crn:v1:bluemix:public:iam::::role:Editor"
9499
],
95100
"service_name": "cloud-object-storage"
101+
},
102+
{
103+
"role_crns": [
104+
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
105+
"crn:v1:bluemix:public:iam::::role:Editor"
106+
],
107+
"service_name": "logs"
96108
}
97109
],
98110
"compliance": {
@@ -155,6 +167,58 @@
155167
}
156168
]
157169
},
170+
{
171+
"key": "cloud_logs_provision"
172+
},
173+
{
174+
"key": "cloud_logs_instance_name"
175+
},
176+
{
177+
"key": "cloud_logs_tags"
178+
},
179+
{
180+
"key": "cloud_logs_access_tags"
181+
},
182+
{
183+
"key": "cloud_logs_retention_period",
184+
"options": [
185+
{
186+
"displayname": "7-days",
187+
"value": "7"
188+
},
189+
{
190+
"displayname": "14-days",
191+
"value": "14"
192+
},
193+
{
194+
"displayname": "30-days",
195+
"value": "30"
196+
},
197+
{
198+
"displayname": "60-days",
199+
"value": "60"
200+
},
201+
{
202+
"displayname": "90-days",
203+
"value": "90"
204+
}
205+
]
206+
},
207+
{
208+
"key": "existing_en_instance_crn"
209+
},
210+
{
211+
"key": "en_integration_name"
212+
},
213+
{
214+
"key": "skip_en_auth_policy"
215+
},
216+
{
217+
"key": "skip_logs_routing_auth_policy"
218+
},
219+
{
220+
"key": "logs_routing_tenant_regions"
221+
},
158222
{
159223
"key": "log_analysis_provision"
160224
},
@@ -221,6 +285,9 @@
221285
{
222286
"key": "enable_at_event_routing_to_cos_bucket"
223287
},
288+
{
289+
"key": "enable_at_event_routing_to_cloud_logs"
290+
},
224291
{
225292
"key": "cloud_monitoring_provision"
226293
},
@@ -243,15 +310,6 @@
243310
}
244311
]
245312
},
246-
{
247-
"key": "cloud_monitoring_service_endpoints",
248-
"options": [
249-
{
250-
"displayname": "public-and-private",
251-
"value": "public-and-private"
252-
}
253-
]
254-
},
255313
{
256314
"key": "cloud_monitoring_tags"
257315
},
@@ -332,6 +390,37 @@
332390
}
333391
]
334392
},
393+
{
394+
"key": "cloud_log_data_bucket_name"
395+
},
396+
{
397+
"key": "cloud_log_data_bucket_class",
398+
"options": [
399+
{
400+
"displayname": "standard",
401+
"value": "standard"
402+
},
403+
{
404+
"displayname": "vault",
405+
"value": "vault"
406+
},
407+
{
408+
"displayname": "cold",
409+
"value": "cold"
410+
},
411+
{
412+
"displayname": "smart",
413+
"value": "smart"
414+
},
415+
{
416+
"displayname": "onerate_active",
417+
"value": "onerate_active"
418+
}
419+
]
420+
},
421+
{
422+
"key": "cloud_log_data_bucket_access_tag"
423+
},
335424
{
336425
"key": "management_endpoint_type_for_bucket",
337426
"options": [
@@ -364,6 +453,12 @@
364453
{
365454
"key": "existing_at_cos_target_bucket_endpoint"
366455
},
456+
{
457+
"key": "existing_cloud_logs_data_bucket_crn"
458+
},
459+
{
460+
"key": "existing_cloud_logs_data_bucket_endpoint"
461+
},
367462
{
368463
"key": "skip_cos_kms_auth_policy"
369464
},
@@ -396,9 +491,13 @@
396491
],
397492
"architecture": {
398493

399-
"descriptions": "This architecture supports the deployment of IBM Log Analysis and IBM Cloud Monitoring instances on IBM Cloud. It also supports the deployment of IBM Cloud Activity Tracker Event Routing to an Object Storage bucket and Log Analysis target.",
494+
"descriptions": "This architecture supports the deployment of IBM Log Analysis, IBM Cloud Monitoring and IBM Cloud Logs instances on IBM Cloud. It also supports the deployment of IBM Cloud Activity Tracker Event Routing to an Object Storage bucket, Log Analysis and Cloud Logs target.",
400495

401496
"features": [
497+
{
498+
"title": "Creates a Cloud Logs instance",
499+
"description": "Creates and configures the IBM Cloud Logs instance."
500+
},
402501
{
403502
"title": "Creates a Log Analysis instance",
404503
"description": "Creates and configures the IBM Cloud Log Analysis instance."
@@ -413,7 +512,7 @@
413512
},
414513
{
415514
"title": "Creates an IBM Cloud Activity Tracker event route to an Object Storage bucket and Log Analysis target",
416-
"description": "Creates and configures the IBM Cloud Activity Tracker Event Routing to an IBM Cloud Object Storage bucket and IBM Cloud Log Analysis target."
515+
"description": "Creates and configures the IBM Cloud Activity Tracker Event Routing to an IBM Cloud Object Storage bucket, IBM Cloud Log Analysis and IBM Cloud Logs target."
417516
}
418517
],
419518
"diagrams": [
@@ -424,7 +523,7 @@
424523
"type": "image/svg+xml"
425524
},
426525

427-
"description": "This architecture supports creating and configuring IBM Cloud Observability instances and IBM Cloud Activity Tracker Event Routing to an Object Storage bucket and Log Analysis instance."
526+
"description": "This architecture supports creating and configuring IBM Cloud Observability instances and IBM Cloud Activity Tracker Event Routing to an Object Storage bucket, Log Analysis and Cloud Logs instance."
428527

429528
}
430529
]

reference-architecture/deployable-architecture-observability-instances.svg

Lines changed: 1 addition & 1 deletion
Loading

solutions/instances/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ This deployable architecture creates observability instances in IBM Cloud and su
55
* A resource group, if one is not passed in.
66
* An IBM Cloud Log Analysis instance.
77
* An IBM Cloud Monitoring instance.
8+
* An IBM Cloud Logs instance.
89
* An IBM Cloud Object Storage instance, if one does not exist.
910
* The root keys in an existing key management service (KMS) if the keys do not exist. These keys are used when Object Storage buckets are created.
1011
* A KMS-encrypted Object Storage bucket to store archived logs, if one is not passed in.
1112
* A KMS-encrypted Object Storage bucket for Activity Tracker event routing, if one is not passed in.
12-
* An Activity Tracker event route to an Object Storage and Log Analysis target.
13+
* A KMS-encrypted Object Storage bucket for Cloud Logs data, if one is not passed in.
14+
* An Activity Tracker event route to an Object Storage, Log Analysis and Cloud Logs target.
15+
* An option to integrate Cloud Logs with existing event notification instance.
1316

1417
![observability-instances-deployable-architecture](../../reference-architecture/deployable-architecture-observability-instances.svg)
1518

0 commit comments

Comments
 (0)