Configuration

This section outlines the configuration schema.

preprocessor-config.yaml

PreprocessorConfig

type	object
properties
processors	Processors
	Mapping of processor configurations
	type	object
	additionalProperties	#/definitions/ProcessorConfig
paths	Paths
	Mapping of paths
	type	object
	additionalProperties	type	string
filesystems	Filesystems
	Mapping of filesystem configurations
	type	object
	additionalProperties	type	object
		#/definitions/FilesystemConfig
collections	Collections
	Mapping of collections to process
	type	object
	additionalProperties	#/definitions/CollectionConfig
mode	Mode
	Running mode of the preprocessor.
	type	string
	enum	create, update
update	Update
	Update toggles, either update data, metadata or both
	type	object
	properties
	data	Data
		type	boolean
	metadata	Metadata
		type	boolean
definitions
ProcessorType	ProcessorType
	An enumeration.
	type	string
	enum	mapchete, local
LocalProcessorConfig	LocalProcessorConfig
	type	object
	properties
	process	Process
		type	string
GridType	GridType
	An enumeration.
	type	string
	enum	mercator, geodetic
PyramidConfig	PyramidConfig
	type	object
	properties
	grid	default	mercator
		allOf	#/definitions/GridType
	metatiling	Metatiling
		type	integer
		default	1
ResamplingType	ResamplingType
	An enumeration.
	type	string
	enum	nearest, cubic, bilinear
MapcheteOutputConfig	MapcheteOutputConfig
	type	object
	properties
	bands	Bands
		type	integer
		default	1
	zoom_levels	Zoom Levels
		type	integer
		default	8
MapcheteProcessorConfig	MapcheteProcessorConfig
	type	object
	properties
	process	Process
		type	string
	pyramid	Pyramid
		default	grid	mercator
			metatiling	1
		allOf	#/definitions/PyramidConfig
	resampling	default	nearest
		allOf	#/definitions/ResamplingType
	config_dir	Config Dir
		type	string
		default	/home/nikola/Tests/test_pydantic
	output	Output
		default	bands	1
			zoom_levels	8
		allOf	#/definitions/MapcheteOutputConfig
ProcessorConfig	ProcessorConfig
	type	object
	properties
	type	#/definitions/ProcessorType
	regex	Regex
		type	string
	local	#/definitions/LocalProcessorConfig
	mapchete	#/definitions/MapcheteProcessorConfig
PathConfig	PathConfig
	type	object
	properties
	path	Path
		type	string
StorageType	StorageType
	An enumeration.
	type	string
	enum	swift, s3, local, sshfs
S3FilesystemConfig	S3FilesystemConfig
	type	object
	properties
	access_key_id	Access Key Id
		type	string
		default
	secret_access_key	Secret Access Key
		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
FilesystemConfig	FilesystemConfig
	type	object
	properties
	type	#/definitions/StorageType
	s3	#/definitions/S3FilesystemConfig
	swift	#/definitions/SwiftFileystemConfig
	local	#/definitions/LocalFilesystemConfig
InputType	InputType
	An enumeration.
	type	string
	enum	archive, file, http
ArchiveDataAssetConfig	ArchiveDataAssetConfig
	type	object
	properties
	key	Key
		type	string
	asset	Asset
		type	string
	regex	Regex
		type	string
ArchiveConfig	ArchiveConfig
	type	object
	properties
	asset_map	Asset Map
		type	array
		items	#/definitions/ArchiveDataAssetConfig
FileDataAssetConfig	FileDataAssetConfig
	type	object
	properties
	key	Key
		type	string
	asset	Asset
		type	string
FileConfig	FileConfig
	type	object
	properties
	asset_map	Asset Map
		type	array
		items	#/definitions/FileDataAssetConfig
HTTPConfig	HTTPConfig
	type	object
	properties
	asset_map	Asset Map
		type	array
		items	#/definitions/FileDataAssetConfig
	streaming	Streaming
		type	boolean
DataInputConfig	DataInputConfig
	type	object
	properties
	type	#/definitions/InputType
	archive	#/definitions/ArchiveConfig
	file	#/definitions/FileConfig
	http	#/definitions/HTTPConfig
DataType	DataType
	An enumeration.
	type	string
	enum	uint8, int8, uint16, int16, uint32, int32, float32, float64, complex64, complex128
OutputDriver	OutputDriver
	An enumeration.
	type	string
	enum	GTiff
GeoTiffDriverConfig	GeoTiffDriverConfig
	type	object
	properties
	cog	Cog
		type	boolean
		default	True
	overviews	Overviews
		type	boolean
		default	True
DataOutputConfig	DataOutputConfig
	type	object
	properties
	path	Path
		type	string
	asset	Asset
		type	string
	processors	Processors
		type	array
		items	type	string
	dtype	default	uint16
		allOf	#/definitions/DataType
	driver	default	GTiff
		allOf	#/definitions/OutputDriver
	gtiff	Gtiff
		default	cog	True
			overviews	True
		allOf	#/definitions/GeoTiffDriverConfig
	nodata	Nodata
		type	integer
		default	null
DataConfig	DataConfig
	type	object
	properties
	input	#/definitions/DataInputConfig
	output	#/definitions/DataOutputConfig
FilesystemCollectionConfig	FilesystemCollectionConfig
	type	object
	properties
	source	Source
		type	string
	target	Target
		type	string
MetadataAssetConfig	MetadataAssetConfig
	type	object
	properties
	file_name_regex	File Name Regex
		type	string
	input_asset	Input Asset
		type	string
	output_asset	Output Asset
		type	string
MetadataReaderType	MetadataReaderType
	An enumeration.
	type	string
	enum	xml, json
PropertyConfig	PropertyConfig
	type	object
	properties
	from_property	From Property
		type	string
	to_property	To Property
		type	string
	format_function	Format Function
		type	string
MetadataReaderConfig	MetadataReaderConfig
	type	object
	properties
	type	#/definitions/MetadataReaderType
	asset	Asset
		type	string
	file_regex	File Regex
		type	string
	property_mapping	Property Mapping
		type	array
		items	#/definitions/PropertyConfig
StaticMetadataConfig	StaticMetadataConfig
	type	object
	properties
	name	Name
		type	string
	value	Value
		type	string
MetadataConfig	MetadataConfig
	type	object
	properties
	assets	Assets
		type	array
		items	#/definitions/MetadataAssetConfig
	readers	Readers
		type	array
		items	#/definitions/MetadataReaderConfig
	static	Static
		type	array
		items	#/definitions/StaticMetadataConfig
	extractors	Extractors
		type	array
		items	#/definitions/MetadataExtractorConfig
MetadataExtractorConfig	MetadataExtractorConfig
	type	object
	properties
	function	Function
		Function to run when extracting data
		type	string
	asset	Asset
		Asset to run the extractor on
		type	string
CollectionConfig	CollectionConfig
	type	object
	properties
	data	Data
		type	array
		items	#/definitions/DataConfig
	filesystems	Filesystems
		default	source	null
			target	null
		allOf	#/definitions/FilesystemCollectionConfig
	metadata	Metadata
		default	assets
			readers
			static
			extractors
		allOf	#/definitions/MetadataConfig