Skip to content

Commit 32d097d

Browse files
acolleenacolleen
authored
fix: doc updates(#70)
1 parent ebf09d8 commit 32d097d

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

‎ibm_catalog.json‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,26 @@
2525
"observability agents"
2626
],
2727
"short_description": "Configures IBM Cloud Observability resources",
28-
"long_description": "Solutions which support configuring IBM Cloud Observability resources for logging, monitoring and activity tracking.",
28+
"long_description": "Solutions that support configuring IBM Cloud Observability resources for logging, monitoring, and activity tracking.",
2929
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/blob/main/README.md",
3030
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/images/observability-icon.svg",
3131
"provider_name": "IBM",
3232
"features": [
3333
{
34-
"title": "Configures Log Analysis",
35-
"description": "Configures Log Analysis instance and agents."
34+
"title": "Configures IBM Log Analysis",
35+
"description": "Configures the IBM Log Analysis instance and logging agents."
3636
},
3737
{
38-
"description": "Configures Cloud Monitoring",
39-
"title": "Configures Cloud Monitoring. instance and agents."
38+
"title": "Configures IBM Cloud Monitoring",
39+
"description": "Configures the IBM Cloud Monitoring instance and logging agents."
4040
},
4141
{
42-
"description": "Configures Activity Tracker event routing to a COS bucket and Log Analysis instance.",
43-
"title": "Configures an Activity Tracker event routing"
42+
43+
"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."
4445
}
4546
],
46-
"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-observability-da/issues](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/issues). Please note this product is not supported via the IBM Cloud Support Center.",
47+
"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.",
4748
"flavors": [
4849
{
4950
"label": "Instances",
@@ -403,27 +404,25 @@
403404
}
404405
],
405406
"architecture": {
406-
"descriptions": "This architecture supports the deployment of Log Analysis and Cloud Monitoring instances on IBM Cloud. It also supports configuring the Activity Tracker event routing.",
407+
408+
"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.",
409+
407410
"features": [
408411
{
409-
"title": "Creates the Log Analysis instance.",
410-
"description": "Creates and configures the Log Analysis instance."
412+
"title": "Creates a Log Analysis instance",
413+
"description": "Creates and configures the IBM Cloud Log Analysis instance."
411414
},
412415
{
413-
"description": "Creates the Cloud Monitoring instance.",
414-
"title": "Creates and configures the Cloud Monitoring instance."
416+
"description": "Creates a Monitoring instance",
417+
"title": "Creates and configures the IBM Cloud Monitoring instance."
415418
},
416419
{
417-
"title": "Creates the KMS encrypted COS bucket required for the logs archiving.",
418-
"description": "Creates and configures the COS bucket with archiving and expiration enabled."
420+
"title": "Creates KMS-encrypted Object Storage buckets for log files and Activity Tracker events",
421+
"description": "Creates and configures the IBM Cloud Object Storage buckets with archiving and expiration enabled."
419422
},
420423
{
421-
"title": "Creates the KMS encrypted COS bucket required for routing of ATracker events.",
422-
"description": "Creates and configures the COS bucket with archiving and expiration enabled."
423-
},
424-
{
425-
"title": "Support Configuring the Activity Tracker event routing.",
426-
"description": "Supports configuring the Activity Tracker event routing to a COS bucket and to a Log Analysis instance."
424+
"title": "Creates an IBM Cloud Activity Tracker event route to an Object Storage bucket and Log Analysis target",
425+
"description": "Creates and configures the IBM Cloud Activity Tracker Event Routing to an IBM Cloud Object Storage bucket and IBM Cloud Log Analysis target."
427426
}
428427
],
429428
"diagrams": [
@@ -433,7 +432,9 @@
433432
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/reference-architecture/deployable-architecture-observability-instances.svg",
434433
"type": "image/svg+xml"
435434
},
436-
"description": "This architecture supports creating and configuring IBM Cloud Observability instances and Activity Tracker event routing to a COS bucket and to a Log Analysis instance."
435+
436+
"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."
437+
437438
}
438439
]
439440
}
@@ -464,29 +465,29 @@
464465
}
465466
],
466467
"architecture": {
467-
"descriptions": "This architecture supports deployment of Log Analysis and Cloud Monitoring Agents on an existing OpenShift Cluster on Secure Landing Zone.",
468+
"descriptions": "This architecture supports the deployment of IBM Log Analysis and IBM Cloud Monitoring agents on an existing Red Hat OpenShift cluster on a secure landing zone.",
468469
"features": [
469470
{
470-
"title": "Works with the Secure Landing Zone.",
471-
"description": "Works with the OpenShift cluster of Secure Landing Zone."
471+
"title": "Works with the secure landing zone.",
472+
"description": "Works with the Red Hat OpenShift cluster on a secure landing zone."
472473
},
473474
{
474-
"title": "Deploys Log Analysis agent on an existing cluster on Secure Landing Zone.",
475-
"description": "Deploys Log Analysis agent on an existing OpenShift cluster on Secure Landing Zone."
475+
"title": "Deploys the IBM Log Analysis agent on an existing cluster on a secure landing zone.",
476+
"description": "Deploys the IBM Log Analysis agent on an existing Red Hat OpenShift cluster on a secure landing zone."
476477
},
477478
{
478-
"title": "Deploys Cloud Monitoring agent on an existing cluster on Secure Landing Zone.",
479-
"description": "Deploys Cloud Monitoring agent on an existing OpenShift cluster on Secure Landing Zone."
479+
"title": "Deploys the IBM Cloud Monitoring agent on an existing cluster on a secure landing zone.",
480+
"description": "Deploys the IBM Cloud Monitoring agent on an existing Red Hat OpenShift cluster on a secure landing zone."
480481
}
481482
],
482483
"diagrams": [
483484
{
484485
"diagram": {
485-
"caption": "Observability Agents on an OpenShift cluster",
486+
"caption": "Observability agents on a Red Hat OpenShift cluster",
486487
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/reference-architecture/deployable-architecture-observability-agents.svg",
487488
"type": "image/svg+xml"
488489
},
489-
"description": "Deployment of Observability agents on an OpenShift cluster of Secure Landing Zone."
490+
"description": "Observability agents deployed on a Red Hat OpenShift cluster on a secure landing zone."
490491
}
491492
]
492493
}

0 commit comments

Comments
 (0)