Skip to content

Commit 6510cf4

Browse files
feat: addon poc content
1 parent 831ff08 commit 6510cf4

File tree

2 files changed

+210
-4
lines changed

2 files changed

+210
-4
lines changed

ibm_catalog.json

Lines changed: 210 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,8 @@
411411
{
412412
"dependency_output": "workload_resource_group_name",
413413
"version_input": "existing_resource_group_name"
414-
}, {
414+
},
415+
{
415416
"dependency_input": "prefix",
416417
"version_input": "prefix"
417418
}
@@ -472,18 +473,224 @@
472473
]
473474
}
474475
],
476+
"configuration": [
477+
{
478+
"key": "cloud_monitoring_access_key",
479+
"type": "password",
480+
"description": "The access key that is used by the IBM Cloud Monitoring agent to communicate with the instance.",
481+
"required": false
482+
},
483+
{
484+
"key": "cloud_monitoring_add_cluster_name",
485+
"type": "boolean",
486+
"default_value": true,
487+
"description": "Whether to attach a tag to log messages. Set to `true` to configure the IBM Cloud Monitoring agent to attach a tag that contains the cluster name to all log messages.",
488+
"required": false
489+
},
490+
{
491+
"key": "cloud_monitoring_agent_name",
492+
"type": "string",
493+
"default_value": "sysdig-agent",
494+
"description": "The name of the IBM Cloud Monitoring agent that is used to name the Kubernetes and Helm resources on the cluster. If a prefix input variable is passed, the name of the IBM Cloud Monitoring agent is prefixed to the value in the `<prefix>-<name>` format.",
495+
"required": false
496+
},
497+
{
498+
"key": "cloud_monitoring_agent_namespace",
499+
"type": "string",
500+
"default_value": "ibm-observe",
501+
"description": "The namespace to deploy the IBM Cloud Monitoring agent in. Default value: `ibm-observe`.",
502+
"required": false
503+
},
504+
{
505+
"key": "cloud_monitoring_agent_tags",
506+
"type": "array",
507+
"default_value": "[]",
508+
"description": "A list of the tags to associate with the metrics that the IBM Cloud Monitoring agent collects. To add the cluster name as a tag, use the `cloud_monitoring_add_cluster_name` variable.",
509+
"required": false
510+
},
511+
{
512+
"key": "cloud_monitoring_agent_tolerations",
513+
"type": "array",
514+
"default_value": "[{\n operator = \"Exists\"\n },\n {\n operator : \"Exists\"\n effect : \"NoSchedule\"\n key : \"node-role.kubernetes.io/master\"\n }]",
515+
"description": "The list of tolerations to apply to the IBM Cloud Monitoring agent. The default operator value `Exists` matches any taint on any node except the master node. [Learn more](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)",
516+
"required": false
517+
},
518+
{
519+
"key": "cloud_monitoring_enabled",
520+
"type": "boolean",
521+
"default_value": true,
522+
"description": "Whether to deploy the IBM Cloud Monitoring agent.",
523+
"required": false
524+
},
525+
{
526+
"key": "cloud_monitoring_endpoint_type",
527+
"type": "string",
528+
"default_value": "private",
529+
"description": "Specify the IBM Cloud Monitoring instance endpoint type (`public` or `private`) to use to construct the ingestion endpoint.",
530+
"required": false
531+
},
532+
{
533+
"key": "cloud_monitoring_instance_region",
534+
"type": "string",
535+
"default_value": "__NULL__",
536+
"description": "The name of the region where the IBM Cloud Monitoring instance is created. This name is used to construct the ingestion endpoint.",
537+
"required": false
538+
},
539+
{
540+
"key": "cloud_monitoring_metrics_filter",
541+
"type": "array",
542+
"default_value": "[]",
543+
"description": "To filter on custom metrics, specify the IBM Cloud Monitoring metrics to include or exclude. [Learn more](https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_inc_exc_metrics)",
544+
"required": false
545+
},
546+
{
547+
"key": "cloud_monitoring_secret_name",
548+
"type": "string",
549+
"default_value": "sysdig-agent",
550+
"description": "The name of the secret that will store the access key. If a prefix input variable is passed, the secret name is prefixed to the value in the `<prefix>-<name>` format.",
551+
"required": false
552+
},
553+
{
554+
"key": "cluster_config_endpoint_type",
555+
"type": "string",
556+
"default_value": "private",
557+
"description": "Specify the type of endpoint to use to access the cluster configuration. Possible values: `default`, `private`, `vpe`, `link`. The `default` value uses the default endpoint of the cluster.",
558+
"required": false
559+
},
560+
{
561+
"key": "cluster_id",
562+
"type": "string",
563+
"default_value": "__NOT_SET__",
564+
"description": "The ID of the cluster to deploy the agents in.",
565+
"required": true
566+
},
567+
{
568+
"key": "cluster_resource_group_id",
569+
"type": "string",
570+
"default_value": "__NOT_SET__",
571+
"description": "The resource group ID of the cluster.",
572+
"required": true
573+
},
574+
{
575+
"key": "ibmcloud_api_key",
576+
"type": "password",
577+
"description": "The IBM Cloud API key.",
578+
"required": true
579+
},
580+
{
581+
"key": "log_analysis_add_cluster_name",
582+
"type": "boolean",
583+
"default_value": true,
584+
"description": "Whether to attach the cluster name to log messages. Set to `true` to configure the IBM Log Analysis agent to tag all log messages with the name.",
585+
"required": false
586+
},
587+
{
588+
"key": "log_analysis_agent_custom_line_exclusion",
589+
"type": "string",
590+
"default_value": "__NULL__",
591+
"description": "The custom configuration of the IBM Log Analysis agent for the `LOGDNA_K8S_METADATA_LINE_INCLUSION` line exclusion setting. [Learn more](https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering)",
592+
"required": false
593+
},
594+
{
595+
"key": "log_analysis_agent_custom_line_inclusion",
596+
"type": "string",
597+
"default_value": "__NULL__",
598+
"description": "The custom configuration of the IBM Log Analysis agent for the `LOGDNA_K8S_METADATA_LINE_INCLUSION` line inclusion setting. [Learn more](https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering)",
599+
"required": false
600+
},
601+
{
602+
"key": "log_analysis_agent_name",
603+
"type": "string",
604+
"default_value": "logdna-agent",
605+
"description": "The name of the IBM Log Analysis agent that is used to name the Kubernetes and Helm resources on the cluster. If a prefix input variable is passed, the name of the IBM Log Analysis agent is prefixed to the value in the `<prefix>-<name>` format.",
606+
"required": false
607+
},
608+
{
609+
"key": "log_analysis_agent_namespace",
610+
"type": "string",
611+
"default_value": "ibm-observe",
612+
"description": "The namespace to deploy the IBM Log Analysis agent in. The default value of the namespace is `ibm-observe`.",
613+
"required": false
614+
},
615+
{
616+
"key": "log_analysis_agent_tags",
617+
"type": "array",
618+
"default_value": "[]",
619+
"description": "The list of tags to associate with all log records collected by the agent so that you can quickly identify the agent’s data in the logging UI. To add the cluster name as a tag, use the `log_analysis_add_cluster_name` variable.",
620+
"required": false
621+
},
622+
{
623+
"key": "log_analysis_agent_tolerations",
624+
"type": "array",
625+
"default_value": "[{\n operator = \"Exists\"\n }]",
626+
"description": "The list of tolerations to apply to the IBM Log Analysis agent. Because the default value is the `Exists` operator, this variable will match any taint on any node. [Learn more](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)",
627+
"required": false
628+
},
629+
{
630+
"key": "log_analysis_enabled",
631+
"type": "boolean",
632+
"default_value": true,
633+
"description": "Whether to deploy the IBM Cloud logging agent.",
634+
"required": false
635+
},
636+
{
637+
"key": "log_analysis_endpoint_type",
638+
"type": "string",
639+
"default_value": "private",
640+
"description": "Specify the IBM Log Analysis instance endpoint type to use to construct the ingestion endpoint. Possible values: `public` or `private`.",
641+
"required": false
642+
},
643+
{
644+
"key": "log_analysis_ingestion_key",
645+
"type": "password",
646+
"description": "The ingestion key that is used by the IBM Cloud logging agent to communicate with the instance.",
647+
"required": false
648+
},
649+
{
650+
"key": "log_analysis_instance_region",
651+
"type": "string",
652+
"default_value": "__NULL__",
653+
"description": "The name of the region where the IBM Log Analysis instance is created. The value is used in the ingestion endpoint in the format `api.<var-value>.logging.cloud.ibm.com`.",
654+
"required": false
655+
},
656+
{
657+
"key": "log_analysis_secret_name",
658+
"type": "string",
659+
"default_value": "logdna-agent",
660+
"description": "The name of the secret that stores the ingestion key. If a prefix input variable is specified, the secret name is prefixed to the value in the `<prefix>-<name>` format.",
661+
"required": false
662+
},
663+
{
664+
"key": "prefix",
665+
"type": "string",
666+
"default_value": "__NULL__",
667+
"description": "The prefix for resources created by this solution.",
668+
"required": false
669+
}
670+
],
475671
"dependencies": [
476672
{
673+
"name": "testing-deploy-arch-ibm-observability",
477674
"flavors": [
478675
"instances"
479676
],
480677
"id": "daf2cf91-2384-4205-b7f4-621299a4896d",
481-
"name": "testing-deploy-arch-ibm-observability",
482678
"version": "^1.0.7",
483679
"catalog_id": "f64499c8-eb50-4985-bf91-29f9e605a433",
484680
"optional": true,
485681
"input_mapping": [
486-
682+
{
683+
"dependency_input": "log_analysis_provision",
684+
"version_input": "log_analysis_enabled"
685+
},
686+
{
687+
"dependency_output": "log_analysis_ingestion_key",
688+
"version_input": "log_analysis_ingestion_key"
689+
},
690+
{
691+
"dependency_input": "cloud_monitoring_provision",
692+
"version_input": "cloud_monitoring_enabled"
693+
}
487694
]
488695
}
489696
],

solutions/agents/variables.tf

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ variable "log_analysis_enabled" {
4545
default = true
4646
}
4747

48-
4948
variable "log_analysis_agent_tags" {
5049
type = list(string)
5150
description = "The list of tags to associate with all log records collected by the agent so that you can quickly identify the agent’s data in the logging UI. To add the cluster name as a tag, use the `log_analysis_add_cluster_name` variable."

0 commit comments

Comments
 (0)