flytekit.configuration.PlatformConfig#

class flytekit.configuration.PlatformConfig(endpoint='localhost:30081', insecure=False, insecure_skip_verify=False, command=None, client_id=None, client_credentials_secret=None, scopes=<factory>, auth_mode=AuthType.STANDARD)[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) – Wether to skip SSL certificate verification

  • command (Optional[List[str]]) – This command is executed to return a token using an external process.

  • client_id (Optional[str]) – 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 (Optional[str]) – 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 (flytekit.configuration.AuthType) – The OAuth mode to use. Defaults to pkce flow.

Return type

None

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 (Optional[Union[str, flytekit.configuration.file.ConfigFile]]) –

Return type

flytekit.configuration.PlatformConfig

classmethod for_endpoint(endpoint, insecure=False)[source]#
Parameters
  • endpoint (str) –

  • insecure (bool) –

Return type

flytekit.configuration.PlatformConfig

Attributes

auth_mode: flytekit.configuration.AuthType = 'standard'#
client_credentials_secret: Optional[str] = None#
client_id: Optional[str] = None#
command: Optional[List[str]] = None#
endpoint: str = 'localhost:30081'#
insecure: bool = False#
insecure_skip_verify: bool = False#
scopes: List[str]#