github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add readme for kubernetes security (#138663)

Browse source
This commit is contained in:
Jack 2022-08-31 17:48:23 -04:00 • committed by GitHub
parent a8d00100a5
commit 33ae517f90
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

40
x-pack/plugins/kubernetes_security/README.md
View file

@ -1,3 +1,41 @@
# Kubernetes Security
This plugin provides interactive visualizations of your Kubernetes workload and session data.
(under construction)
## Overview
Allow users to explore the data stream from k8s environment that being monitored by Elastic Agent(+ endpoint integration) in a session view with cloud and k8s context. For more context, see internal [doc](https://github.com/elastic/security-team/issues/3337).
This plugin is currently being used as a part of Security Solution features under the `/app/security/kubernetes` page.
## API
#### `getKubernetesPage`
Returns the kubernetes page.
Parameters
| Property | Description | Type |
| ----------------------- | ----------------- | ------ |
| kubernetesSecurityDeps | Parameters object | object |
`kubernetesSecurityDeps`
| Property | Description | Type |
| ------------------- | ------------------------------------------------------------- | --------- |
| filter | The global filter component used across pages in Kibana | ReactNode |
| renderSessionsView | Function to render sessions view table | function |
| indexPattern | Index pattern used for the data source in the Kubernetes page | object |
| globalFilter | Includes query and timerange used for filtering | object |
`indexPattern`
| Property | Description | Type |
| --------- | ----------------------------------- | -------------------------------------------- |
| fields | A list of `FieldSpec` | `FieldSpec[]` from `@kbn/data-plugin/common` |
| title | Index pattern string representation | string |
`globalFilter`
| Property | Description | Type |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| filterQuery | Stringified Elasticsearch filter query. See [doc](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html). | Optional, string |
| startDate | Start date time of timerange filter, in ISO format | string |
| endDate | End date time of timerange filter, in ISO format | string |
## Page preview
![preview](https://user-images.githubusercontent.com/91196877/171646384-ff7041ae-13ae-4abc-bb25-636c38e7efbb.png)