org.thales.punch.platform.api

Interface IKubernetesCluster

public interface IKubernetesCluster

Method Summary

Modifier and Type	Method and Description
String	getAnalyticsBaseImageName() The base docker image name for analytics jobs.
String	getApiAccessToken() The access token used to authenticate to the Kubernetes API server.
String	getApiUrl() This Kubernetes API server.
String	getDockerHost() The docker host URL with which you can build Docker images.
String	getName() The logical name of the cluster.
String	getRegistryHostname() Sometimes, OpenShift / Kubernetes nodes may not be able to resolve the the public registry URL, and may use its internal service hostname to pull images.
String	getRegistryName() Safe name of the private registry your Kubernetes cluster is using.
String	getRegistryUrl() The URL of the private registry your Kubernetes cluster is using.
String	getRegistryUsername() If defined, the username to use, to authenticate with the registry your Kubernetes cluster is using;
String	getRegitryPassword() If defined, the password to use, to authenticate with the registry your Kubernetes cluster is using;
String	getTopologyBaseImageName() The base docker image name for topology jobs.
Boolean	registryRequiresAuthentication() Whether or not the registry requires authentication.
Boolean	shouldValidateSsl() Whether or not the Kubernetes client should verify domain certificates.

Method Detail

getName

String getName()

The logical name of the cluster. It is the name of the cluster section in the punchplatform.properties.

Returns:

The corresponding Kubernetes cluster name.

getApiAccessToken

String getApiAccessToken()

The access token used to authenticate to the Kubernetes API server.

Returns:

The corresponding Kubernetes API access token.

getApiUrl

String getApiUrl()

This Kubernetes API server.

Returns:

The corresponding Kubernetes API url.

shouldValidateSsl

Boolean shouldValidateSsl()

Whether or not the Kubernetes client should verify domain certificates.

Returns:

The corresponding SSL setting.

getDockerHost

String getDockerHost()

The docker host URL with which you can build Docker images.

Returns:

The corresponding docker daemon URL.

getRegistryName

String getRegistryName()

Safe name of the private registry your Kubernetes cluster is using.

Returns:

The corresponding docker registry name.

getRegistryUrl

String getRegistryUrl()

The URL of the private registry your Kubernetes cluster is using.

Returns:

The corresponding docker registry URL.

getRegistryHostname

String getRegistryHostname()

Sometimes, OpenShift / Kubernetes nodes may not be able to resolve the the public registry URL, and may use its internal service hostname to pull images. This returns the hostname of the private registry your Kubernetes cluster is using. Default returned value should be the public registry URL if the service hostname is undefined.

Returns:

The corresponding of the docker registry hostname.

getRegistryUsername

String getRegistryUsername()

If defined, the username to use, to authenticate with the registry your Kubernetes cluster is using;

Returns:

The corresponding docker registry username.

getRegitryPassword

String getRegitryPassword()

If defined, the password to use, to authenticate with the registry your Kubernetes cluster is using;

Returns:

The corresponding docker registry username.

registryRequiresAuthentication

Boolean registryRequiresAuthentication()

Whether or not the registry requires authentication.

Returns:

The result you expect.

getTopologyBaseImageName

String getTopologyBaseImageName()

The base docker image name for topology jobs.

Returns:

The result you expect.

getAnalyticsBaseImageName

String getAnalyticsBaseImageName()

The base docker image name for analytics jobs.

Returns:

The result you expect.