Skip to content

prefect_docker.credentials

Module containing docker credentials.

Classes

DockerRegistryCredentials

Bases: Block

Block used to manage credentials for interacting with a Docker Registry.

Examples:

Log into Docker Registry. 

from prefect_docker import DockerHost, DockerRegistryCredentials

docker_host = DockerHost()
docker_registry_credentials = DockerRegistryCredentials(
    username="my_username",
    password="my_password",
    registry_url="registry.hub.docker.com",
)
with docker_host.get_client() as client:
    docker_registry_credentials.login(client)

Source code in prefect_docker/credentials.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class DockerRegistryCredentials(Block):
    """
    Block used to manage credentials for interacting with a Docker Registry.

    Examples:
        Log into Docker Registry.
        ```python
        from prefect_docker import DockerHost, DockerRegistryCredentials

        docker_host = DockerHost()
        docker_registry_credentials = DockerRegistryCredentials(
            username="my_username",
            password="my_password",
            registry_url="registry.hub.docker.com",
        )
        with docker_host.get_client() as client:
            docker_registry_credentials.login(client)
        ```
    """

    _block_type_name = "Docker Registry Credentials"
    _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/14a315b79990200db7341e42553e23650b34bb96-250x250.png"  # noqa
    _description = "Store credentials for interacting with a Docker Registry."

    username: str = Field(
        default=..., description="The username to log into the registry with."
    )
    password: SecretStr = Field(
        default=..., description="The password to log into the registry with."
    )
    registry_url: str = Field(
        default=...,
        description=(
            'The URL to the registry. Generally, "http" or "https" can be omitted.'
        ),
        example="index.docker.io",
    )
    reauth: bool = Field(
        default=True,
        description="Whether or not to reauthenticate on each interaction.",
    )

    async def login(self, client: docker.DockerClient):
        """
        Authenticates a given Docker client with the configured Docker registry.

        Args:
            client: A Docker Client.
        """
        logger = get_run_logger()
        logger.debug(f"Logging into {self.registry_url}.")
        await run_sync_in_worker_thread(
            client.login,
            username=self.username,
            password=self.password.get_secret_value(),
            registry=self.registry_url,
            # See https://github.com/docker/docker-py/issues/2256 for information on
            # the default value for reauth.
            reauth=self.reauth,
        )

Functions

login async

Authenticates a given Docker client with the configured Docker registry.

Parameters:

Name Type Description Default
client DockerClient

A Docker Client.

 required
Source code in prefect_docker/credentials.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
async def login(self, client: docker.DockerClient):
    """
    Authenticates a given Docker client with the configured Docker registry.

    Args:
        client: A Docker Client.
    """
    logger = get_run_logger()
    logger.debug(f"Logging into {self.registry_url}.")
    await run_sync_in_worker_thread(
        client.login,
        username=self.username,
        password=self.password.get_secret_value(),
        registry=self.registry_url,
        # See https://github.com/docker/docker-py/issues/2256 for information on
        # the default value for reauth.
        reauth=self.reauth,
    )