flytekit.configuration.PlatformConfig#
- class flytekit.configuration.PlatformConfig(endpoint='localhost:30080', insecure=False, insecure_skip_verify=False, ca_cert_file_path=None, console_endpoint=None, command=None, proxy_command=None, client_id=None, client_credentials_secret=None, scopes=<factory>, auth_mode=AuthType.STANDARD, audience=None, rpc_retries=3, http_proxy_url=None)[source]#
This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically).
- Parameters:
endpoint (str) – DNS for Flyte backend
insecure (bool) – Whether or not to use SSL
insecure_skip_verify (bool) – Whether to skip SSL certificate verification
console_endpoint (str | None) – endpoint for console if different from Flyte backend
command (List[str] | None) – This command is executed to return a token using an external process
proxy_command (List[str] | None) – This command is executed to return a token for proxy authorization using an external process
client_id (str | None) – This is the public identifier for the app which handles authorization for a Flyte deployment. More details here: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/.
client_credentials_secret (str | None) – Used for service auth, which is automatically called during pyflyte. This will allow the Flyte engine to read the password directly from the environment variable. Note that this is less secure! Please only use this if mounting the secret as a file is impossible
scopes (List[str]) – List of scopes to request. This is only applicable to the client credentials flow
auth_mode (AuthType) – The OAuth mode to use. Defaults to pkce flow
ca_cert_file_path (str | None) – [optional] str Root Cert to be loaded and used to verify admin
http_proxy_url (str | None) – [optional] HTTP Proxy to be used for OAuth requests
audience (str | None)
rpc_retries (int)
Methods
- classmethod auto(config_file=None)[source]#
Reads from Config file, and overrides from Environment variables. Refer to ConfigEntry for details :param config_file: :return:
- Parameters:
config_file (str | ConfigFile | None)
- Return type:
Attributes
- auth_mode: AuthType = 'standard'[source]
- endpoint: str = 'localhost:30080'
- insecure: bool = False
- insecure_skip_verify: bool = False
- rpc_retries: int = 3