|
13 | 13 | "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/blob/main/README.md", |
14 | 14 | "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/images/observability-icon.svg", |
15 | 15 | "flavors": [ |
16 | | - { |
17 | | - "label": "Agents", |
18 | | - "name": "agents", |
19 | | - "working_directory": "solutions/agents", |
20 | | - "licenses": [ |
21 | | - { |
22 | | - "id": "LICENSE", |
23 | | - "name": "LICENSE", |
24 | | - "type": "text/plain", |
25 | | - "description": "LICENSE" |
26 | | - } |
27 | | - ], |
28 | | - "compliance": {}, |
29 | | - "iam_permissions": [ |
30 | | - { |
31 | | - "service_name": "containers-kubernetes", |
32 | | - "role_crns": [ |
33 | | - "crn:v1:bluemix:public:iam::::serviceRole:Manager", |
34 | | - "crn:v1:bluemix:public:iam::::role:Viewer" |
35 | | - ] |
36 | | - } |
37 | | - ], |
38 | | - "architecture": { |
39 | | - "features": [ |
40 | | - { |
41 | | - "title": "Works with any openshift or k8s cluster", |
42 | | - "description": "Works with the Red Hat OpenShift cluster." |
43 | | - }, |
44 | | - { |
45 | | - "title": "Deploys the IBM Cloud Monitoring agent on an existing cluster.", |
46 | | - "description": "Deploys the IBM Cloud Monitoring agent on an existing Red Hat OpenShift cluster." |
47 | | - }, |
48 | | - { |
49 | | - "title": "Deploys the IBM Logs agent on an existing cluster.", |
50 | | - "description": "Deploys the IBM Logs agent on an existing Red Hat OpenShift cluster." |
51 | | - } |
52 | | - ], |
53 | | - "diagrams": [ |
54 | | - { |
55 | | - "diagram": { |
56 | | - "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/reference-architecture/deployable-architecture-observability-agents.svg", |
57 | | - "caption": "Observability agents on a Red Hat OpenShift cluster", |
58 | | - "type": "image/svg+xml" |
59 | | - }, |
60 | | - "description": "Observability agents deployed on a Red Hat OpenShift cluster on a secure landing zone." |
61 | | - } |
62 | | - ] |
63 | | - }, |
64 | | - "dependencies": [ |
65 | | - { |
66 | | - "name": "testing-deploy-arch-ibm-observability", |
67 | | - "id": "daf2cf91-2384-4205-b7f4-621299a4896d", |
68 | | - "version": ">=1.0.7", |
69 | | - "flavors": [ |
70 | | - "instances" |
71 | | - ], |
72 | | - "catalog_id": "f64499c8-eb50-4985-bf91-29f9e605a433", |
73 | | - "optional": true, |
74 | | - "input_mapping": [ |
75 | | - { |
76 | | - "dependency_input": "log_analysis_provision", |
77 | | - "version_input": "log_analysis_enabled" |
78 | | - }, |
79 | | - { |
80 | | - "dependency_output": "log_analysis_ingestion_key", |
81 | | - "version_input": "log_analysis_ingestion_key" |
82 | | - }, |
83 | | - { |
84 | | - "dependency_input": "cloud_monitoring_provision", |
85 | | - "version_input": "cloud_monitoring_enabled" |
86 | | - }, |
87 | | - { |
88 | | - "dependency_output": "cloud_monitoring_access_key", |
89 | | - "version_input": "cloud_monitoring_access_key" |
90 | | - }, |
91 | | - { |
92 | | - "dependency_input": "region", |
93 | | - "version_input": "cloud_monitoring_instance_region" |
94 | | - } |
95 | | - ] |
96 | | - }, |
97 | | - { |
98 | | - "name": "deploy-arch-ibm-slz-ocp", |
99 | | - "id": "95fccffc-ae3b-42df-b6d9-80be5914d852-global", |
100 | | - "version": ">=v6.2.1", |
101 | | - "flavors": [ |
102 | | - "standard" |
103 | | - ], |
104 | | - "catalog_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc", |
105 | | - "optional": false, |
106 | | - "input_mapping": [] |
107 | | - } |
108 | | - ], |
109 | | - "dependency_version_2": true, |
110 | | - "configuration": [ |
111 | | - { |
112 | | - "key": "cloud_monitoring_access_key", |
113 | | - "type": "password", |
114 | | - "description": "The access key that is used by the IBM Cloud Monitoring agent to communicate with the instance.", |
115 | | - "required": true |
116 | | - }, |
117 | | - { |
118 | | - "key": "cloud_monitoring_add_cluster_name", |
119 | | - "type": "boolean", |
120 | | - "default_value": true, |
121 | | - "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.", |
122 | | - "required": false |
123 | | - }, |
124 | | - { |
125 | | - "key": "cloud_monitoring_agent_name", |
126 | | - "type": "string", |
127 | | - "default_value": "sysdig-agent", |
128 | | - "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.", |
129 | | - "required": false |
130 | | - }, |
131 | | - { |
132 | | - "key": "cloud_monitoring_agent_namespace", |
133 | | - "type": "string", |
134 | | - "default_value": "ibm-observe", |
135 | | - "description": "The namespace to deploy the IBM Cloud Monitoring agent in. Default value: `ibm-observe`.", |
136 | | - "required": false |
137 | | - }, |
138 | | - { |
139 | | - "key": "cloud_monitoring_agent_tags", |
140 | | - "type": "array", |
141 | | - "default_value": "[]", |
142 | | - "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.", |
143 | | - "required": false |
144 | | - }, |
145 | | - { |
146 | | - "key": "cloud_monitoring_agent_tolerations", |
147 | | - "type": "array", |
148 | | - "default_value": "[{\n operator = \"Exists\"\n },\n {\n operator : \"Exists\"\n effect : \"NoSchedule\"\n key : \"node-role.kubernetes.io/master\"\n }]", |
149 | | - "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/)", |
150 | | - "required": false |
151 | | - }, |
152 | | - { |
153 | | - "key": "cloud_monitoring_enabled", |
154 | | - "type": "boolean", |
155 | | - "default_value": true, |
156 | | - "description": "Whether to deploy the IBM Cloud Monitoring agent.", |
157 | | - "required": true |
158 | | - }, |
159 | | - { |
160 | | - "key": "cloud_monitoring_endpoint_type", |
161 | | - "type": "string", |
162 | | - "default_value": "private", |
163 | | - "description": "Specify the IBM Cloud Monitoring instance endpoint type (`public` or `private`) to use to construct the ingestion endpoint.", |
164 | | - "required": false |
165 | | - }, |
166 | | - { |
167 | | - "key": "cloud_monitoring_instance_region", |
168 | | - "type": "string", |
169 | | - "default_value": "__NULL__", |
170 | | - "description": "The name of the region where the IBM Cloud Monitoring instance is created. This name is used to construct the ingestion endpoint.", |
171 | | - "display_name": "Region", |
172 | | - "required": true, |
173 | | - "custom_config": { |
174 | | - "type": "vpc_region", |
175 | | - "grouping": "deployment", |
176 | | - "original_grouping": "deployment", |
177 | | - "config_constraints": { |
178 | | - "generationType": "2" |
179 | | - } |
180 | | - } |
181 | | - }, |
182 | | - { |
183 | | - "key": "cloud_monitoring_metrics_filter", |
184 | | - "type": "array", |
185 | | - "default_value": "[]", |
186 | | - "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)", |
187 | | - "required": false |
188 | | - }, |
189 | | - { |
190 | | - "key": "cloud_monitoring_secret_name", |
191 | | - "type": "string", |
192 | | - "default_value": "sysdig-agent", |
193 | | - "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.", |
194 | | - "required": false |
195 | | - }, |
196 | | - { |
197 | | - "key": "cluster_config_endpoint_type", |
198 | | - "type": "string", |
199 | | - "default_value": "private", |
200 | | - "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.", |
201 | | - "required": false |
202 | | - }, |
203 | | - { |
204 | | - "key": "cluster_id", |
205 | | - "type": "string", |
206 | | - "default_value": "__NOT_SET__", |
207 | | - "description": "The ID of the cluster to deploy the agents in.", |
208 | | - "required": true, |
209 | | - "custom_config": { |
210 | | - "type": "cluster_var", |
211 | | - "grouping": "deployment", |
212 | | - "original_grouping": "deployment" |
213 | | - } |
214 | | - }, |
215 | | - { |
216 | | - "key": "cluster_resource_group_id", |
217 | | - "type": "string", |
218 | | - "default_value": "__NOT_SET__", |
219 | | - "description": "The resource group ID of the cluster.", |
220 | | - "required": true, |
221 | | - "custom_config": { |
222 | | - "type": "resource_group", |
223 | | - "grouping": "deployment", |
224 | | - "original_grouping": "deployment", |
225 | | - "config_constraints": { |
226 | | - "identifier": "rg_id" |
227 | | - } |
228 | | - } |
229 | | - }, |
230 | | - { |
231 | | - "key": "ibmcloud_api_key", |
232 | | - "type": "password", |
233 | | - "description": "The IBM Cloud API key.", |
234 | | - "required": true |
235 | | - }, |
236 | | - { |
237 | | - "key": "prefix", |
238 | | - "type": "string", |
239 | | - "default_value": "__NULL__", |
240 | | - "description": "The prefix for resources created by this solution.", |
241 | | - "required": false |
242 | | - }, |
243 | | - { |
244 | | - "key": "cloud_logs_ingress_endpoint", |
245 | | - "type": "string", |
246 | | - "default_value": "__NULL__", |
247 | | - "description": "The host for IBM Cloud Logs ingestion. Ensure you use the ingress endpoint. See https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-endpoints_ingress. It is required if `logs_agent_enabled` is set to true.", |
248 | | - "required": false |
249 | | - }, |
250 | | - { |
251 | | - "key": "cloud_logs_ingress_port", |
252 | | - "type": "number", |
253 | | - "default_value": 3443, |
254 | | - "description": "The target port for the IBM Cloud Logs ingestion endpoint. The port must be 443 if you connect by using a VPE gateway, or port 3443 when you connect by using CSEs.", |
255 | | - "required": false |
256 | | - }, |
257 | | - { |
258 | | - "key": "is_vpc_cluster", |
259 | | - "type": "boolean", |
260 | | - "default_value": true, |
261 | | - "description": "Specify true if the target cluster for the DA is a VPC cluster, false if it is classic cluster.", |
262 | | - "required": false |
263 | | - }, |
264 | | - { |
265 | | - "key": "logs_agent_additional_log_source_paths", |
266 | | - "type": "array", |
267 | | - "default_value": "[]", |
268 | | - "description": "The list of additional log sources. By default, the Logs agent collects logs from a single source at `/var/log/containers/logger-agent-ds-*.log`.", |
269 | | - "required": false |
270 | | - }, |
271 | | - { |
272 | | - "key": "logs_agent_additional_metadata", |
273 | | - "type": "array", |
274 | | - "default_value": "[]", |
275 | | - "description": "The list of additional metadata fields to add to the routed logs.", |
276 | | - "required": false |
277 | | - }, |
278 | | - { |
279 | | - "key": "logs_agent_enable_scc", |
280 | | - "type": "boolean", |
281 | | - "default_value": true, |
282 | | - "description": "Whether to enable creation of Security Context Constraints in Openshift. When installing on an OpenShift cluster, this setting is mandatory to configure permissions for pods within your cluster.", |
283 | | - "required": false |
284 | | - }, |
285 | | - { |
286 | | - "key": "logs_agent_enabled", |
287 | | - "type": "boolean", |
288 | | - "default_value": true, |
289 | | - "description": "Whether to deploy the Logs agent.", |
290 | | - "required": true |
291 | | - }, |
292 | | - { |
293 | | - "key": "logs_agent_exclude_log_source_paths", |
294 | | - "type": "array", |
295 | | - "default_value": "[]", |
296 | | - "description": "The list of log sources to exclude. Specify the paths that the Logs agent ignores.", |
297 | | - "required": false |
298 | | - }, |
299 | | - { |
300 | | - "key": "logs_agent_iam_api_key", |
301 | | - "type": "password", |
302 | | - "description": "The IBM Cloud API key for the Logs agent to authenticate and communicate with the IBM Cloud Logs. It is required if `logs_agent_iam_mode` is set to `IAMAPIKey`.", |
303 | | - "required": true |
304 | | - }, |
305 | | - { |
306 | | - "key": "logs_agent_iam_environment", |
307 | | - "type": "string", |
308 | | - "default_value": "PrivateProduction", |
309 | | - "description": "IAM authentication Environment: `Production` or `PrivateProduction` or `Staging` or `PrivateStaging`.", |
310 | | - "required": false |
311 | | - }, |
312 | | - { |
313 | | - "key": "logs_agent_iam_mode", |
314 | | - "type": "string", |
315 | | - "default_value": "TrustedProfile", |
316 | | - "description": "IAM authentication mode: `TrustedProfile` or `IAMAPIKey`.", |
317 | | - "required": false |
318 | | - }, |
319 | | - { |
320 | | - "key": "logs_agent_log_source_namespaces", |
321 | | - "type": "array", |
322 | | - "default_value": "[]", |
323 | | - "description": "The list of namespaces from which logs should be forwarded by agent. When specified logs from only these namespaces will be sent by the agent.", |
324 | | - "required": false |
325 | | - }, |
326 | | - { |
327 | | - "key": "logs_agent_name", |
328 | | - "type": "string", |
329 | | - "default_value": "logs-agent", |
330 | | - "description": "The name of the Logs agent. The name is used in all Kubernetes and Helm resources in the cluster.", |
331 | | - "required": false |
332 | | - }, |
333 | | - { |
334 | | - "key": "logs_agent_namespace", |
335 | | - "type": "string", |
336 | | - "default_value": "ibm-observe", |
337 | | - "description": "The namespace where the Logs agent is deployed. The default value is `ibm-observe`.", |
338 | | - "required": false |
339 | | - }, |
340 | | - { |
341 | | - "key": "logs_agent_selected_log_source_paths", |
342 | | - "type": "array", |
343 | | - "default_value": "[]", |
344 | | - "description": "The list of specific log sources paths. Logs will only be collected from the specified log source paths.", |
345 | | - "required": false |
346 | | - }, |
347 | | - { |
348 | | - "key": "logs_agent_tolerations", |
349 | | - "type": "array", |
350 | | - "default_value": "[{\n operator = \"Exists\"\n }]", |
351 | | - "description": "List of tolerations to apply to Logs agent.", |
352 | | - "required": false |
353 | | - }, |
354 | | - { |
355 | | - "key": "logs_agent_trusted_profile", |
356 | | - "type": "string", |
357 | | - "default_value": "__NULL__", |
358 | | - "description": "The IBM Cloud trusted profile ID. Used only when `logs_agent_iam_mode` is set to `TrustedProfile`. The trusted profile must have an IBM Cloud Logs `Sender` role.", |
359 | | - "required": false |
360 | | - }, |
361 | | - { |
362 | | - "key": "wait_till", |
363 | | - "type": "string", |
364 | | - "default_value": "Normal", |
365 | | - "description": "To avoid long wait times when you run your Terraform code, you can specify the stage when you want Terraform to mark the cluster resource creation as completed. Depending on what stage you choose, the cluster creation might not be fully completed and continues to run in the background. However, your Terraform code can continue to run without waiting for the cluster to be fully created. Supported args are `MasterNodeReady`, `OneWorkerNodeReady`, `IngressReady` and `Normal`", |
366 | | - "required": false |
367 | | - }, |
368 | | - { |
369 | | - "key": "wait_till_timeout", |
370 | | - "type": "number", |
371 | | - "default_value": 90, |
372 | | - "description": "Timeout for wait_till in minutes.", |
373 | | - "required": false |
374 | | - } |
375 | | - ], |
376 | | - "install_type": "extension" |
377 | | - }, |
378 | 16 | { |
379 | 17 | "label": "Instances", |
380 | 18 | "name": "instances", |
|
0 commit comments