Mandatory parameter to define a Functions Definition Language file. Note that "functions" instead of "services" has been used in order to keep compatibility with SCAR
Main object with the definition of the OSCAR services to be deployed. The components of the array are Service maps, where the key of every service is the identifier of the cluster where the service (defined as the value of the entry on the map) will be deployed.
Service
Field
Description
namestring
The name of the service
imagestring
Docker image for the service
alpineboolean
Alpine parameter to set if image is based on Alpine. If true a custom release of faas-supervisor will be used. Optional (default: false)
scriptstring
Local path to the user script to be executed in the service container
image_pull_secretsstring array
Array of Kubernetes secrets. Only needed to use private images located on private registries.
memorystring
Memory limit for the service following the kubernetes format. Optional (default: 256Mi)
cpustring
CPU limit for the service following the kubernetes format. Optional (default: 0.2)
total_memorystring
Limit for the memory used by all the service's jobs running simultaneously. Apache YuniKorn scheduler is required to work. Same format as Memory, but internally translated to MB (integer). Optional (default: "")
total_cpustring
Limit for the virtual CPUs used by all the service's jobs running simultaneously. Apache YuniKorn scheduler is required to work. Same format as CPU, but internally translated to millicores (integer). Optional (default: "")
The user-defined environment variables assigned to the service. Optional
annotationsmap[string]string
User-defined Kubernetes annotations to be set in job's definition. Optional
labelsmap[string]string
User-defined Kubernetes labels to be set in job's definition. Optional
SynchronousSettings
Field
Description
min_scaleinteger
Minimum number of active replicas (pods) for the service. Optional. (default: 0)
max_scaleinteger
Maximum number of active replicas (pods) for the service. Optional. (default: 0 (Unlimited))
StorageIOConfig
Field
Description
storage_providerstring
Reference to the storage provider defined in storage_providers. This string is composed by the provider's name (minio, s3, onedata) and identifier (defined by the user), separated by a point (e.g. "minio.myidentifier")
pathstring
Path in the storage provider. In MinIO and S3 the first directory of the specified path is translated into the bucket's name (e.g. "bucket/folder/subfolder")
suffixstring array
Array of suffixes for filtering the files to be uploaded. Only used in the output field. Optional
prefixstring array
Array of prefixes for filtering the files to be uploaded. Only used in the output field. Optional
EnvVarsMap
Field
Description
Variablesmap[string]string
Map to define the environment variables that will be available in the service container