Configuration

This section outlines the configuration schema.

harvester-config.yaml

HarvesterAppConfig

type	object
properties
harvesters	Harvesters
	type	object
	additionalProperties	#/definitions/HarvesterConfig
redis	Redis
	default	host	vs-redis-master
		port	6379
	allOf	#/definitions/RedisConfig
filesystems	Filesystems
	type	object
	additionalProperties	#/definitions/FilesystemConfig
definitions
ResourceType	ResourceType
	An enumeration.
	type	string
	enum	STACAPI, STACCatalog, FileMatcher, OADS, OpenSearch
TimeConfig	TimeConfig
	type	object
	properties
	begin	Begin
		type	string
		default	2022-12-01T10:12:15.703595
	end	End
		type	string
		default	2022-12-01T10:12:15.703605
QueryConfig	QueryConfig
	type	object
	properties
	time	#/definitions/TimeConfig
	bbox	Bbox
		type	string
	collection	Collection
		type	string
	extra_params	Extra Params
		type	object
		additionalProperties	type	string
STACAPIConfig	STACAPIConfig
	type	object
	properties
	url	Url
		type	string
	query	#/definitions/QueryConfig
STACCatalogConfig	STACCatalogConfig
	type	object
	properties
	root_path	Root Path
		type	string
	collection_id	Collection Id
		type	string
	deduplicate	Deduplicate
		type	boolean
		default	False
	filesystem	Filesystem
		type	string
		default	local
FileMatcherConfig	FileMatcherConfig
	type	object
	properties
	root_path	Root Path
		type	string
	datetime_regex	Datetime Regex
		type	string
		examples	\d{8}T\d{6}Z
			\d{4}-\d{2}-\d{2}
	id_regex	Id Regex
		type	string
		examples	SENTINEL2(A|B)-\d{8}T\d{6}Z
	asset_regex_map	Asset Id
		type	object
		additionalProperties	type	string
	filesystem	Filesystem
		type	string
OADSConfig	OADSConfig
	type	object
	properties
	url	Url
		type	string
	use_oads_ext	Use Oads Ext
		type	boolean
		default	False
JSONConfig	JSONConfig
	type	object
	properties
	property_mapping	Property Mapping
		type	object
		additionalProperties	type	string
ATOMXMLConfig	ATOMXMLConfig
	type	object
	properties
FormatConfig	FormatConfig
	type	object
	properties
	type	Type
		type	string
	json	#/definitions/JSONConfig
	atom_xml	#/definitions/ATOMXMLConfig
OpenSearchConfig	OpenSearchConfig
	type	object
	properties
	url	Url
		type	string
	query	#/definitions/QueryConfig
	format	#/definitions/FormatConfig
ResourceConfig	ResourceConfig
	type	object
	properties
	type	#/definitions/ResourceType
	stacapi	#/definitions/STACAPIConfig
	staccatalog	#/definitions/STACCatalogConfig
	filematcher	#/definitions/FileMatcherConfig
	oads	#/definitions/OADSConfig
	opensearch	#/definitions/OpenSearchConfig
FilterConfig	FilterConfig
	type	object
	properties
	context	Context
		type	object
	expression	Expression
		type	object
OutputType	OutputType
	An enumeration.
	type	string
	enum	console, queue
PostprocessorType	PostprocessorType
	An enumeration.
	type	string
	enum	builtin, external
PostprocessorConfig	PostprocessorConfig
	type	object
	properties
	type	#/definitions/PostprocessorType
	process	Process
		type	string
	kwargs	Kwargs
		type	object
HarvesterConfig	HarvesterConfig
	type	object
	properties
	resource	#/definitions/ResourceConfig
	filter	#/definitions/FilterConfig
	output	default	queue
		allOf	#/definitions/OutputType
	queue	Queue
		type	string
	postprocessors	Postprocessors
		type	array
		items	#/definitions/PostprocessorConfig
RedisConfig	RedisConfig
	type	object
	properties
	host	Host
		type	string
		default	vs-redis-master
	port	Port
		type	integer
		default	6379
FilesystemType	FilesystemType
	An enumeration.
	type	string
	enum	swift, s3, file, sshfs
S3FilesystemConfig	S3FilesystemConfig
	type	object
	properties
	access_key_id	Access Key Id
		type	string
		default
	secret_access_key	Secret Access Key
		type	string
		default
	endpoint_url	Endpoint Url
		type	string
		default
	region	Region
		type	string
		default
	public	Public
		type	boolean
		default	False
SwiftFileystemConfig	SwiftFileystemConfig
	type	object
	properties
	user	User
		type	string
	key	Key
		type	string
	region_name	Region Name
		type	string
	authurl	Authurl
		type	string
	auth_version	Auth Version
		type	string
	tenant_name	Tenant Name
		type	string
LocalFilesystemConfig	LocalFilesystemConfig
	type	object
	properties
SSHFilesystemConfig	SSHFileSystemConfig
	type	object
	properties
	host	Host address
		type	string
	username	SSH User
		type	string
	password	SSH Password
		type	string
FilesystemConfig	FilesystemConfig
	type	object
	properties
	type	#/definitions/FilesystemType
	s3	#/definitions/S3FilesystemConfig
	swift	#/definitions/SwiftFileystemConfig
	local	#/definitions/LocalFilesystemConfig
	sshfs	#/definitions/SSHFilesystemConfig