1.16.32
flytekit.models.security
Directory
Classes
| Class | Description |
|---|---|
Identity |
|
OAuth2Client |
|
OAuth2TokenRequest |
|
Secret |
See cookbook:secrets for usage examples. |
SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about. |
flytekit.models.security.Identity
Parameters
class Identity(
iam_role: typing.Optional[str] = None,
k8s_service_account: typing.Optional[str] = None,
oauth2_client: typing.Optional[flytekit.models.security.OAuth2Client] = None,
execution_identity: typing.Optional[str] = None,
)| Parameter | Type | Description |
|---|---|---|
iam_role |
typing.Optional[str] |
|
k8s_service_account |
typing.Optional[str] |
|
oauth2_client |
typing.Optional[flytekit.models.security.OAuth2Client] |
|
execution_identity |
typing.Optional[str] |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.security_pb2.Identity,
) -> Identity| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.core.security_pb2.Identity |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.security.OAuth2Client
Parameters
class OAuth2Client(
client_id: str,
client_secret: str,
)| Parameter | Type | Description |
|---|---|---|
client_id |
str |
|
client_secret |
str |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.security_pb2.OAuth2Client,
) -> OAuth2Client| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.core.security_pb2.OAuth2Client |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.security.OAuth2TokenRequest
Parameters
class OAuth2TokenRequest(
name: str,
client: flytekit.models.security.OAuth2Client,
idp_discovery_endpoint: typing.Optional[str] = None,
token_endpoint: typing.Optional[str] = None,
type_: <enum 'Type'> = Type.CLIENT_CREDENTIALS,
)| Parameter | Type | Description |
|---|---|---|
name |
str |
|
client |
flytekit.models.security.OAuth2Client |
|
idp_discovery_endpoint |
typing.Optional[str] |
|
token_endpoint |
typing.Optional[str] |
|
type_ |
<enum 'Type'> |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.security_pb2.OAuth2TokenRequest,
) -> OAuth2TokenRequest| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.core.security_pb2.OAuth2TokenRequest |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.security.Secret
See cookbook:secrets for usage examples.
Parameters
class Secret(
group: typing.Optional[str] = None,
key: typing.Optional[str] = None,
group_version: typing.Optional[str] = None,
mount_requirement: <enum 'MountType'> = MountType.ANY,
env_var: typing.Optional[str] = None,
)| Parameter | Type | Description |
|---|---|---|
group |
typing.Optional[str] |
|
key |
typing.Optional[str] |
|
group_version |
typing.Optional[str] |
|
mount_requirement |
<enum 'MountType'> |
|
env_var |
typing.Optional[str] |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.security_pb2.Secret,
) -> Secret| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.core.security_pb2.Secret |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.security.SecurityContext
This is a higher level wrapper object that for the most part users shouldn’t have to worry about. You should be able to just use {{< py_class_ref flytekit.Secret >}} instead.
Parameters
class SecurityContext(
run_as: typing.Optional[flytekit.models.security.Identity] = None,
secrets: typing.Optional[typing.List[flytekit.models.security.Secret]] = None,
tokens: typing.Optional[typing.List[flytekit.models.security.OAuth2TokenRequest]] = None,
)| Parameter | Type | Description |
|---|---|---|
run_as |
typing.Optional[flytekit.models.security.Identity] |
|
secrets |
typing.Optional[typing.List[flytekit.models.security.Secret]] |
|
tokens |
typing.Optional[typing.List[flytekit.models.security.OAuth2TokenRequest]] |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.security_pb2.SecurityContext,
) -> SecurityContext| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.core.security_pb2.SecurityContext |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()