File

The file config type is set to scrape configurations or configurations in common with the related elements that can be specified in the fields; type, and id. The paths to the configuration(s) to be scraped is set with the field path as a list.

file-scraper.yaml
apiVersion: configs.flanksource.com/v1
kind: ScrapeConfig
metadata:
  name: file-git-scraper
spec:
  file:
    - type: $.kind
      id: $.metadata.name
      url: github.com/flanksource/canary-checker
      paths:
        - fixtures/minimal/http_pass_single.yaml

Scraper

Field	Description	Scheme
`schedule`	Specify the interval to scrape in cron format. Defaults to every 60 minutes.	`string`
`full`	Set to `true` to extract changes from scraped configurations. Defaults to `false`.	`bool`
`retention`	Settings for retaining changes, analysis and scraped items	`Retention`
`file`	Specifies the list of File configurations to scrape.	`[]File`

File

Field	Description	Scheme	Required
`id`	A static value or JSONPath expression to use as the ID for the resource.	`string`	`true`
`name`	A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`.	`string`
`items`	A JSONPath expression to use to extract individual items from the resource	`string`
`type`	A static value or JSONPath expression to use as the type for the resource.	`string`	`true`
`class`	A static value or JSONPath expression to use as the config class. (Defaults to `type`)	`string`
`format`	Format of config item, defaults to JSON, available options are JSON	`string`
`timestampFormat`	TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`.	`string`
`createFields`	CreateFields 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`
`deleteFields`	DeleteFields 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`
`url`	Specify URL e.g github repository containing the configuration(s)	`string`
`paths`	Specify paths to configuration(s) for scraping	`[]string`	`true`
`ignore`	Set configurations to ignore	`[]string`
`properties`	Custom templatable properties for the scraped config items.	`[]ConfigProperty`
`tags`	set custom tags on the scraped config items	`map[string]string`
`transform`	Field to transform result	`Transform`

Scraper​

File​

Scraper

File