Skip to content

Commit 3188cda

Browse files
jen-huangkibanamachine
jen-huang
and
kibanamachine
authored
[UII] Add status tracking for agentless integrations (elastic#199567)
## Summary Resolves elastic/ingest-dev#3933. For deployments that support agentless, integrations with agentless deployment mode enabled will allow the status of agentless integration policies to be tracked. ### Key technical changes - A new field `supports_agentless` was added to package policies. This field already exists on agent policies. When an agentless integration is created, `supports_agentless: true` is now added to both the package policy and its parent agent policy. - This allows easier filtering for agentless integrations as we avoid having to retrieve & check against every parent agent policy. - This also means existing agentless policies do not get this new status tracking UI, only new ones created after this change. Since agentless is not yet GA, I think this is okay. - `/api/fleet/agent_status/data` now takes optional query params `pkgName` and `pkgVersion`. When both are specified, the API will check if agent(s) have ingested data for only that package's datastreams. ## UI walkthrough <details> <summary>🖼️ Click to show screenshots</summary> 1. **Integration policies** page now shows two tables for integrations meeting the above condition, one for agentless policies and one for agent-based policies: ![image](https://github.com/user-attachments/assets/58c6a932-9bda-4229-ba5f-d341bdbd539a) 2. Clicking the status badge in the agentless policies table opens a flyout with two steps: confirm agentless enrollment and confirm incoming data: ![image](https://github.com/user-attachments/assets/e19e6ba0-f40d-48a7-a524-0373934ac46a) 3. Confirm agentless enrollment polls for an agent enrolled into that integration policy's agent policy. If that agent is reporting an unhealthy status, the integration component UI is shown. This UI is the same one used on Fleet > Agents > Agent details page and shows all components reported by that agent: ![image](https://github.com/user-attachments/assets/ce214f7f-4bdd-48e5-a5eb-a1e8fcc7a512) 4. Once a healthy agentless enrollment is established, confirm incoming data starts polling for data for that integration ingested by that agent ID in the past 5 minutes: ![image](https://github.com/user-attachments/assets/7f3de40b-3418-4174-b529-e805407949b6) 5. If data could not be retrieved in 5 minutes, an error message shows while polling continues in the background: ![image](https://github.com/user-attachments/assets/a3fd198e-1570-4357-9b7f-e541a769d33f) 6. If data is retrieved, a success message is shown: ![image](https://github.com/user-attachments/assets/f4e442af-ca60-4448-9bfb-3f244cd03c2d) </details> ## Testing Easiest way to test is use the Cloud deployment from this PR. Enable Beta integrations and navigate to CSPM. Add a CSPM integration using `Agentless` setup technology. Then you can track the status of the agentless deployment on the Integrations policies tab. For local testing, the following is required to simulate agentless agent: 1. Add the following to kibana.dev.yml: ``` xpack.cloud.id: 'anything-to-pass-cloud-validation-checks' xpack.fleet.agentless.enabled: true xpack.fleet.agentless.api.url: 'https://localhost:8443' xpack.fleet.agentless.api.tls.certificate: './config/certs/ess-client.crt' xpack.fleet.agentless.api.tls.key: './config/certs/ess-client.key' xpack.fleet.agentless.api.tls.ca: './config/certs/ca.crt' ``` 2. Apply [this patch](https://gist.github.com/jen-huang/dfc3e02ceb63976ad54bd1f50c524cb4) to prevent attempt to create agentless pod 3. Enroll a Fleet Server as usual 4. Enable Beta integrations and navigate to CSPM. Add a CSPM integration using `Agentless` setup technology. 5. Enroll a normal Elastic Agent to the agent policy for that CSPM integration by using the token from Enrollment tokens ## To-do - [x] API tests - [x] Unit UI tests - [x] Manual Cloud tests - [x] File docs request - elastic/ingest-docs#1466 - [ ] Update troubleshooting guide link once available ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]>
1 parent f2da55a commit 3188cda

File tree

46 files changed

+2659
-590
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2659
-590
lines changed

Diff for: ‎oas_docs/bundle.json

+118
Original file line numberDiff line numberDiff line change
@@ -6919,6 +6919,12 @@
69196919
},
69206920
"type": "array"
69216921
},
6922+
"supports_agentless": {
6923+
"default": false,
6924+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
6925+
"nullable": true,
6926+
"type": "boolean"
6927+
},
69226928
"updated_at": {
69236929
"type": "string"
69246930
},
@@ -7943,6 +7949,12 @@
79437949
},
79447950
"type": "array"
79457951
},
7952+
"supports_agentless": {
7953+
"default": false,
7954+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
7955+
"nullable": true,
7956+
"type": "boolean"
7957+
},
79467958
"updated_at": {
79477959
"type": "string"
79487960
},
@@ -8736,6 +8748,12 @@
87368748
},
87378749
"type": "array"
87388750
},
8751+
"supports_agentless": {
8752+
"default": false,
8753+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
8754+
"nullable": true,
8755+
"type": "boolean"
8756+
},
87398757
"updated_at": {
87408758
"type": "string"
87418759
},
@@ -9790,6 +9808,12 @@
97909808
},
97919809
"type": "array"
97929810
},
9811+
"supports_agentless": {
9812+
"default": false,
9813+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
9814+
"nullable": true,
9815+
"type": "boolean"
9816+
},
97939817
"updated_at": {
97949818
"type": "string"
97959819
},
@@ -10813,6 +10837,12 @@
1081310837
},
1081410838
"type": "array"
1081510839
},
10840+
"supports_agentless": {
10841+
"default": false,
10842+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
10843+
"nullable": true,
10844+
"type": "boolean"
10845+
},
1081610846
"updated_at": {
1081710847
"type": "string"
1081810848
},
@@ -11607,6 +11637,12 @@
1160711637
},
1160811638
"type": "array"
1160911639
},
11640+
"supports_agentless": {
11641+
"default": false,
11642+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
11643+
"nullable": true,
11644+
"type": "boolean"
11645+
},
1161011646
"updated_at": {
1161111647
"type": "string"
1161211648
},
@@ -12744,6 +12780,22 @@
1274412780
]
1274512781
}
1274612782
},
12783+
{
12784+
"in": "query",
12785+
"name": "pkgName",
12786+
"required": false,
12787+
"schema": {
12788+
"type": "string"
12789+
}
12790+
},
12791+
{
12792+
"in": "query",
12793+
"name": "pkgVersion",
12794+
"required": false,
12795+
"schema": {
12796+
"type": "string"
12797+
}
12798+
},
1274712799
{
1274812800
"in": "query",
1274912801
"name": "previewData",
@@ -30076,6 +30128,12 @@
3007630128
},
3007730129
"type": "array"
3007830130
},
30131+
"supports_agentless": {
30132+
"default": false,
30133+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
30134+
"nullable": true,
30135+
"type": "boolean"
30136+
},
3007930137
"updated_at": {
3008030138
"type": "string"
3008130139
},
@@ -30563,6 +30621,12 @@
3056330621
},
3056430622
"type": "array"
3056530623
},
30624+
"supports_agentless": {
30625+
"default": false,
30626+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
30627+
"nullable": true,
30628+
"type": "boolean"
30629+
},
3056630630
"vars": {
3056730631
"additionalProperties": {
3056830632
"additionalProperties": false,
@@ -30800,6 +30864,12 @@
3080030864
},
3080130865
"type": "array"
3080230866
},
30867+
"supports_agentless": {
30868+
"default": false,
30869+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
30870+
"nullable": true,
30871+
"type": "boolean"
30872+
},
3080330873
"vars": {
3080430874
"additionalProperties": {
3080530875
"anyOf": [
@@ -31336,6 +31406,12 @@
3133631406
},
3133731407
"type": "array"
3133831408
},
31409+
"supports_agentless": {
31410+
"default": false,
31411+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
31412+
"nullable": true,
31413+
"type": "boolean"
31414+
},
3133931415
"updated_at": {
3134031416
"type": "string"
3134131417
},
@@ -32038,6 +32114,12 @@
3203832114
},
3203932115
"type": "array"
3204032116
},
32117+
"supports_agentless": {
32118+
"default": false,
32119+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
32120+
"nullable": true,
32121+
"type": "boolean"
32122+
},
3204132123
"updated_at": {
3204232124
"type": "string"
3204332125
},
@@ -33210,6 +33292,12 @@
3321033292
},
3321133293
"type": "array"
3321233294
},
33295+
"supports_agentless": {
33296+
"default": false,
33297+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
33298+
"nullable": true,
33299+
"type": "boolean"
33300+
},
3321333301
"updated_at": {
3321433302
"type": "string"
3321533303
},
@@ -33622,6 +33710,12 @@
3362233710
},
3362333711
"type": "array"
3362433712
},
33713+
"supports_agentless": {
33714+
"default": false,
33715+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
33716+
"nullable": true,
33717+
"type": "boolean"
33718+
},
3362533719
"vars": {
3362633720
"additionalProperties": {
3362733721
"additionalProperties": false,
@@ -34314,6 +34408,12 @@
3431434408
},
3431534409
"type": "array"
3431634410
},
34411+
"supports_agentless": {
34412+
"default": false,
34413+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
34414+
"nullable": true,
34415+
"type": "boolean"
34416+
},
3431734417
"updated_at": {
3431834418
"type": "string"
3431934419
},
@@ -34808,6 +34908,12 @@
3480834908
},
3480934909
"type": "array"
3481034910
},
34911+
"supports_agentless": {
34912+
"default": false,
34913+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
34914+
"nullable": true,
34915+
"type": "boolean"
34916+
},
3481134917
"vars": {
3481234918
"additionalProperties": {
3481334919
"additionalProperties": false,
@@ -35044,6 +35150,12 @@
3504435150
},
3504535151
"type": "array"
3504635152
},
35153+
"supports_agentless": {
35154+
"default": false,
35155+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
35156+
"nullable": true,
35157+
"type": "boolean"
35158+
},
3504735159
"vars": {
3504835160
"additionalProperties": {
3504935161
"anyOf": [
@@ -35579,6 +35691,12 @@
3557935691
},
3558035692
"type": "array"
3558135693
},
35694+
"supports_agentless": {
35695+
"default": false,
35696+
"description": "Indicates whether the package policy belongs to an agentless agent policy.",
35697+
"nullable": true,
35698+
"type": "boolean"
35699+
},
3558235700
"updated_at": {
3558335701
"type": "string"
3558435702
},

0 commit comments

Comments
 (0)