Skip to main content

Kubernetes File

The KubernetesFile config type is used to scrape configurations contained in your specified resource e.g Pod.

k8s-file-scraper.yaml
apiVersion: configs.flanksource.com/v1
kind: ScrapeConfig
metadata:
name: k8s-file-scraper
spec:
kubernetesFile:
- selector:
namespace: demo
kind: Statefulset
name: postgresql
files:
- path:
- /var/lib/postgresql/data/pgdata/postgresql.conf
format: properties

Scraper

FieldDescriptionSchemeRequired
logLevelSpecify the level of logging.string
scheduleSpecify the interval to scrape in cron format. Defaults to every 60 minutes.string
fullSet to true to extract changes from scraped configurations. Defaults to false.bool
retentionSettings for retaining changes, analysis and scraped itemsRetention
kubernetesFileSpecifies the list of Kubernetes File configurations to scrape.[]KubernetesFile

KubernetesFile

FieldDescriptionSchemeRequired
idA static value or JSONPath expression to use as the ID for the resource.stringtrue
nameA static value or JSONPath expression to use as the Name for the resource. Default value is the id.string
itemsA JSONPath expression to use to extract individual items from the resourcestring
typeA static value or JSONPath expression to use as the type for the resource.stringtrue
transformSpecify field to transform resultTransform
formatFormat of config item, defaults to JSON, available options are JSONstring
timestampFormatTimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is RFC3339.string
createFieldsCreateFields is a list of JSONPath expression used to identify the created time of the config. If multiple fields are specified, the first non-empty value will be used[]string
deleteFieldsDeleteFields is a JSONPath expression used to identify the deleted time of the config. If multiple fields are specified, the first non-empty value will be used[]string
selectorSpecify Kubernetes resource for configuration based on namespace, kind, name and more.ResourceSelectortrue
containerSet container namestring
filesSpecify path to file contained in Pod[]File

File

FieldDescriptionSchemeRequired
pathSet path to file contained in Pod[]string
formatSpecify format of filestring