Skip to main content

Configuration settings

This section documents all the available parameters that can be used to customize the functionality of SCHEMA api.

For each setting, we present all of the aspects that are required in order for users to understand the resulting effect. Some of these settings, that we find the need to explicitly explain at this point are:

  • Volatile: we denote as volatile, configuration settings that are strongly recommended to be determined upon deployment and remain static throughout the life of SCHEMA api. These are, in general, settings that enforce data integrity rules; changing any of these settings while SCHEMA api is already deployed and in use may result to data conflicts and hence should be avoided or used with extreme care

  • Required: required configuration settings must be defined otherwise SCHEMA api won't be deployed

  • Variable interpolation in examples: Many settings are documented with example values. In some of these cases, there is the need to denote the relationship with another variable or the use of another variable's value. In these cases, we denote as <VAR0>, the value of VAR0.

    For example, if we want to say that VAR0, is equal to the value of VAR1, we will write:

    VAR0=<VAR1>

SCHEMA_API_CONTEXT_MIN_ACTIVE_TASKS​

volatile
Domain: int Any integer greater than 0
Default: 1

Controls the minimum number of active tasks that a context can have

SCHEMA_API_CONTEXT_MIN_CPU​

volatile
Domain: int Any integer greater than 0
Default: 1

Controls the minimum number of CPU cores that a context task can have

SCHEMA_API_CONTEXT_MIN_PROCESS_TIME_SECONDS​

volatile
Domain: int Any integer greater than 0
Default: 60

Controls the minimum number of seconds that a context task can run

SCHEMA_API_CONTEXT_MIN_RAM_GB​

volatile
Domain: int Any integer greater than 0
Default: 1

Controls the minimum number of RAM in GBs that a context task can allocate

SCHEMA_API_CONTEXT_MIN_TASKS​

volatile
Domain: int Any integer greater than 0
Default: 1

Controls the minimum number of tasks that a context can run

SCHEMA_API_CONTEXT_NAME_SLUG_PATTERN​

volatile
Domain: str RegEx - without the start-of-line (^) and end-of-line ($) flags
Default: Value of SCHEMA_API_SLUG_PATTERN
Examples: [a-z0-9][-a-z0-9]+, [-_a-zA-Z0-9]+

A Regular Expression that is used to restrict the acceptable format that contexts' names might have

danger

Slugs are strings that can be safely represented as part of a URL, that contain no whitespace or other characters that can be confused as part of the URL syntax.

The supplied context slug regular expression must match only strings that can be used as slugs, otherwise resources may not be be able to get stored or retrieved.

SCHEMA_API_CONTEXT_NAME_SLUG_PATTERN_VIOLATION_MESSAGE​

volatile
Domain: str
Default: Context name must abide by the following regular expression: <SCHEMA_API_CONTEXT_NAME_SLUG_PATTERN>
Examples: "Invalid context name format"

A message that is served as a response to HTTP requests, that provide a context name slug which is not matched by the operating SCHEMA_API_CONTEXT_NAME_SLUG_PATTERN

SCHEMA_API_TASK_API_CLASS​

required, volatile
Domain: str A valid Python reference path, to a subclass of api.taskapis.BaseTaskApi
Examples: api.taskapis.TesTaskApi

Python reference path to a class that implements the abstract class of api.taskapis.BaseTaskApi and is used by SCHEMA API to directly schedule submitted tasks

SCHEMA_API_TASK_API_CREATE_ENDPOINT​

required, volatile
Domain: str URL
Examples: https://some-tesk-deployment/v1/tasks

URL to a task scheduling API's (e.g. TESK) endpoint that is used to submit tasks

SCHEMA_API_TASK_API_GET_ENDPOINT​

required, volatile
Domain: str URL
Examples: https://some-tesk-deployment/v1/tasks

URL to a task scheduling API's (e.g. TESK) endpoint that is used to retrieve submitted task details

SCHEMA_API_TASK_API_STATUS_TTL_SECONDS​

Domain: int URL
Default: 5
Examples: 2, 10

Minimum number of seconds to wait between polling task scheduling API (e.g. TESK) for submitted tasks' status update

SCHEMA_API_AUTHORIZATION_HEADER_PREFIX​

Domain: str
Default: Bearer
Examples: Token

A string value that prepends the API tokens, inside the Authorization header definition. For example for SCHEMA_API_AUTHORIZATION_HEADER_PREFIX='Bearer', a valid Authorization header value may be Bearer abcdef012345689

SCHEMA_API_MINIMUM_USERNAME_LENGTH​

volatile
Domain: int Any integer greater than 0
Default: 1
Examples: 6, 8

Controls the minimum amount of characters for an AuthEntity's username

SCHEMA_API_TOKEN_KEY_LENGTH​

volatile
Domain: int Any integer greater than 0
Default: 8
Examples: 4, 16

Controls the number of API token characters that are used to create the API token index

SCHEMA_API_TOKEN_BYTE_LENGTH​

volatile
Domain: int Any of the values 64, 128 or 256
Default: 128

Controls the issued API token size in bytes

SCHEMA_API_USERNAME_SLUG_PATTERN​

volatile
Domain: str RegEx - without the start-of-line (^) and end-of-line ($) flags
Default: Value of SCHEMA_API_SLUG_PATTERN
Examples: [a-z0-9][-a-z0-9]+, [-_a-zA-Z0-9]+

A Regular Expression that is used to restrict the acceptable format that AuthEntity usernames might have

danger

Slugs are strings that can be safely represented as part of a URL, that contain no whitespace or other characters that can be confused as part of the URL syntax.

The supplied username slug regular expression must match only strings that can be used as slugs, otherwise resources may not be be able to get stored or retrieved.

SCHEMA_API_USERNAME_SLUG_PATTERN_VIOLATION_MESSAGE​

volatile
Domain: str
Default: Context name must abide by the following regular expression: <SCHEMA_API_USERNAME_SLUG_PATTERN>
Examples: "Invalid username format"

A message that is served as a response to HTTP requests, that provide a username slug which is not matched by the operating SCHEMA_API_USERNAME_SLUG_PATTERN

SCHEMA_API_USE_AUTH​

volatile
Domain: bool
Default: False

A switch for enabling/disabling auth module

SCHEMA_API_DB_HOST​

volatile
Domain: str URL
Default: '127.0.0.1'
Examples: '26.132.49.108', 'my-db-server.com'

URL to host of the database server

SCHEMA_API_DB_NAME​

volatile
Domain: str
Default: 'schema-api-db'

Name of the database

SCHEMA_API_DB_PORT​

volatile
Domain: str
Default: '5432'

Port of the database server

SCHEMA_API_DB_USER​

volatile
Domain: str
Default: 'schema-api'

User name to use to connect to the database