com.google.cloud.tools.jib.frontend

Class CredentialRetrieverFactory

java.lang.Object

com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

public class CredentialRetrieverFactory
extends Object

Static factories for various CredentialRetrievers.

Method Summary

Modifier and Type	Method and Description
CredentialRetriever	dockerConfig() Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at $USER_HOME/.docker/config.json).
CredentialRetriever	dockerConfig(Path dockerConfigFile) Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.
CredentialRetriever	dockerCredentialHelper(Path credentialHelper) Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
CredentialRetriever	dockerCredentialHelper(String credentialHelperSuffix) Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
static CredentialRetrieverFactory	forImage(ImageReference imageReference, JibLogger logger) Creates a new CredentialRetrieverFactory for an image.
CredentialRetriever	inferCredentialHelper() Creates a new CredentialRetriever that tries common Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry as gcr.io.
CredentialRetriever	known(Credential credential, String credentialSource)
CredentialRetrieverFactory	setImageReference(ImageReference imageReference)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forImage

public static CredentialRetrieverFactory forImage(ImageReference imageReference,
                                                  JibLogger logger)

Creates a new CredentialRetrieverFactory for an image.

Parameters:

imageReference - the image the credential are for

logger - a logger for logging

Returns:

a new CredentialRetrieverFactory

setImageReference

public CredentialRetrieverFactory setImageReference(ImageReference imageReference)

known

public CredentialRetriever known(Credential credential,
                                 String credentialSource)

dockerCredentialHelper

public CredentialRetriever dockerCredentialHelper(String credentialHelperSuffix)

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

Parameters:

credentialHelperSuffix - the credential helper executable suffix, following docker-credential- (ie. gcr for docker-credential-gcr)

Returns:

a new CredentialRetriever

dockerCredentialHelper

public CredentialRetriever dockerCredentialHelper(Path credentialHelper)

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

Parameters:

credentialHelper - the credential helper executable

Returns:

a new CredentialRetriever

See Also:

https://github.com/docker/docker-credential-helpers#development

inferCredentialHelper

public CredentialRetriever inferCredentialHelper()

Creates a new CredentialRetriever that tries common Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry as gcr.io.

Returns:

a new CredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig()

Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at $USER_HOME/.docker/config.json).

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig(Path dockerConfigFile)

Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.

Parameters:

dockerConfigFile - the path to the Docker config file

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever