Configuration¶
-
ai.backend.client.config.
get_env
(key, default=<object object>, *, clean=<function <lambda>>)[source]¶ Retrieves a configuration value from the environment variables. The given key is uppercased and prefixed by
"BACKEND_"
and then"SORNA_"
if the former does not exist.- Parameters
key (
str
) – The key name.default (
Any
) – The default value returned when there is no corresponding environment variable.clean (
Callable
[[str
],Any
]) – A single-argument function that is applied to the result of lookup (in both successes and the default value for failures). The default is returning the value as-is.
- Returns
The value processed by the clean function.
-
ai.backend.client.config.
get_config
()[source]¶ Returns the configuration for the current process. If there is no explicitly set
APIConfig
instance, it will generate a new one from the current environment variables and defaults.
-
ai.backend.client.config.
set_config
(conf)[source]¶ Sets the configuration used throughout the current process.
-
class
ai.backend.client.config.
APIConfig
(*, endpoint=None, endpoint_type=None, domain=None, group=None, version=None, user_agent=None, access_key=None, secret_key=None, hash_type=None, vfolder_mounts=None, skip_sslcert_validation=None, connection_timeout=None, read_timeout=None, announcement_handler=None)[source]¶ Represents a set of API client configurations. The access key and secret key are mandatory – they must be set in either environment variables or as the explicit arguments.
- Parameters
endpoint (
Union
[str
,URL
,None
]) – The URL prefix to make API requests via HTTP/HTTPS. If this is given asstr
and contains multiple URLs separated by comma, the underlying HTTP request-response facility will perform client-side load balancing and automatic fail-over using them, assuming that all those URLs indicates a single, same cluster. The users of the API and CLI will get network connection errors only when all of the given endpoints fail – intermittent failures of a subset of endpoints will be hidden with a little increased latency.endpoint_type (
Optional
[str
]) – Either"api"
or"session"
. If the endpoint type is"api"
(the default if unspecified), it uses the access key and secret key in the configuration to access the manager API server directly. If the endpoint type is"session"
, it assumes the endpoint is a Backend.AI console server which provides cookie-based authentication with username and password. In the latter, users need to usebackend.ai login
andbackend.ai logout
to manage their sign-in status, or the API equivalent inlogin()
andlogout()
methods.user_agent (
Optional
[str
]) – A custom user-agent string which is sent to the API server as aUser-Agent
HTTP header.access_key (
Optional
[str
]) – The API access key. If deliberately set to an empty string, the API requests will be made without signatures (anonymously).hash_type (
Optional
[str
]) – The hash type to generate per-request authentication signatures.vfolder_mounts (
Optional
[Iterable
[str
]]) – A list of vfolder names (that must belong to the given access key) to be automatically mounted upon anyKernel.get_or_create()
calls.
-
DEFAULTS
= {'connection_timeout': 10.0, 'domain': 'default', 'endpoint': 'https://api.backend.ai', 'endpoint_type': 'api', 'group': 'default', 'hash_type': 'sha256', 'read_timeout': None, 'version': 'v4.20190615'}¶ The default values for config parameterse settable via environment variables xcept the access and secret keys.
-
endpoint
¶ The currently active endpoint URL. This may change if there are multiple configured endpoints and the current one is not accessible.
- Return type
-
skip_sslcert_validation
¶ Whether to skip SSL certificate validation for the API gateway.
- Return type
-
connection_timeout
¶ The maximum allowed duration for making TCP connections to the server.
- Return type
-
read_timeout
¶ The maximum allowed waiting time for the first byte of the response from the server.
- Return type