io.fabric8.kubernetes.api

Class Controller

java.lang.Object

io.fabric8.kubernetes.api.Controller

public class Controller
extends Object

Applies DTOs to the current Kubernetes master

Constructor Summary

Constructors

Constructor and Description
Controller()
Controller(KubernetesClient kubernetes)

Method Summary

Methods

Modifier and Type	Method and Description
String	apply(File file)
void	apply(Object dto, String sourceName) Applies the given DTOs onto the Kubernetes master
void	applyBuildConfig(io.fabric8.openshift.api.model.BuildConfig entity, String sourceName)
void	applyDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig entity, String sourceName)
void	applyEntity(Object dto, String sourceName) Applies the given DTOs onto the Kubernetes master
void	applyImageStream(io.fabric8.openshift.api.model.ImageStream entity, String sourceName)
String	applyJson(byte[] json) Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.
String	applyJson(File json) Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.
String	applyJson(InputStream json) Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.
String	applyJson(String json) Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.
void	applyList(io.fabric8.kubernetes.api.model.KubernetesList list, String sourceName)
void	applyNamespace(io.fabric8.kubernetes.api.model.Namespace entity)
void	applyOAuthClient(io.fabric8.openshift.api.model.OAuthClient entity, String sourceName)
void	applyPod(io.fabric8.kubernetes.api.model.Pod pod, String sourceName)
void	applyReplicationController(io.fabric8.kubernetes.api.model.ReplicationController replicationController, String sourceName)
void	applyRoute(io.fabric8.openshift.api.model.Route entity, String sourceName)
void	applyService(io.fabric8.kubernetes.api.model.Service service, String sourceName)
Object	applyTemplate(io.fabric8.openshift.api.model.template.Template entity, String sourceName) Creates/updates the template and processes it returning the processed DTOs
String	applyYaml(File yaml) Applies the given YAML to the underlying REST APIs in a single operation without needing to explicitly parse first.
String	applyYaml(String yaml) Applies the given YAML to the underlying REST APIs in a single operation without needing to explicitly parse first.
protected void	doCreateOAuthClient(io.fabric8.openshift.api.model.OAuthClient entity, String sourceName)
protected void	doCreatePod(io.fabric8.kubernetes.api.model.Pod pod, String namespace, String sourceName)
protected void	doCreateReplicationController(io.fabric8.kubernetes.api.model.ReplicationController replicationController, String namespace, String sourceName)
protected void	doCreateService(io.fabric8.kubernetes.api.model.Service service, String namespace, String sourceName)
protected void	doCreateTemplate(io.fabric8.openshift.api.model.template.Template entity, String namespace, String sourceName)
String	getNamespace()
boolean	isAllowCreate() Returns true if this controller allows new resources to be created in the given namespace
boolean	isIgnoreRunningOAuthClients()
boolean	isIgnoreServiceMode() If enabled then all services are ignored to avoid them being recreated.
boolean	isProcessTemplatesLocally()
boolean	isRecreateMode() If enabled then updates are performed by deleting the resource first then creating it
protected boolean	isRunning(io.fabric8.kubernetes.api.model.HasMetadata entity)
boolean	isServicesOnlyMode() If enabled then only services are created/updated to allow services to be created/updated across a number of apps before any pods/replication controllers are updated
boolean	isThrowExceptionOnError()
protected void	onApplyError(String message, Exception e) Logs an error applying some JSON to Kubernetes and optionally throws an exception
protected void	printSummary(Object kubeResource)
Object	processTemplate(io.fabric8.openshift.api.model.template.Template entity, String sourceName)
void	setAllowCreate(boolean allowCreate)
void	setIgnoreRunningOAuthClients(boolean ignoreRunningOAuthClients)
void	setIgnoreServiceMode(boolean ignoreServiceMode)
void	setNamespace(String namespace)
void	setProcessTemplatesLocally(boolean processTemplatesLocally)
void	setRecreateMode(boolean recreateMode)
void	setServicesOnlyMode(boolean servicesOnlyMode)
void	setThrowExceptionOnError(boolean throwExceptionOnError)
protected void	validatePodSpec(io.fabric8.kubernetes.api.model.PodSpec podSpec, String namespace) Lets verify that any dependencies are available; such as volumes or secrets

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Controller

public Controller(KubernetesClient kubernetes)

Method Detail

apply

public String apply(File file)
             throws Exception

Throws:

Exception

applyJson

public String applyJson(byte[] json)
                 throws Exception

Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

applyJson

public String applyJson(String json)
                 throws Exception

Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

applyJson

public String applyJson(File json)
                 throws Exception

Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

applyYaml

public String applyYaml(String yaml)
                 throws Exception

Applies the given YAML to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

applyYaml

public String applyYaml(File yaml)
                 throws Exception

Applies the given YAML to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

applyJson

public String applyJson(InputStream json)
                 throws Exception

Applies the given JSON to the underlying REST APIs in a single operation without needing to explicitly parse first.

Throws:

Exception

apply

public void apply(Object dto,
         String sourceName)
           throws Exception

Applies the given DTOs onto the Kubernetes master

Throws:

Exception

applyEntity

public void applyEntity(Object dto,
               String sourceName)
                 throws Exception

Applies the given DTOs onto the Kubernetes master

Throws:

Exception

applyOAuthClient

public void applyOAuthClient(io.fabric8.openshift.api.model.OAuthClient entity,
                    String sourceName)

doCreateOAuthClient

protected void doCreateOAuthClient(io.fabric8.openshift.api.model.OAuthClient entity,
                       String sourceName)

applyTemplate

public Object applyTemplate(io.fabric8.openshift.api.model.template.Template entity,
                   String sourceName)
                     throws Exception

Creates/updates the template and processes it returning the processed DTOs

Throws:

Exception

doCreateTemplate

protected void doCreateTemplate(io.fabric8.openshift.api.model.template.Template entity,
                    String namespace,
                    String sourceName)

processTemplate

public Object processTemplate(io.fabric8.openshift.api.model.template.Template entity,
                     String sourceName)

printSummary

protected void printSummary(Object kubeResource)
                     throws IOException

Throws:

IOException

applyRoute

public void applyRoute(io.fabric8.openshift.api.model.Route entity,
              String sourceName)

applyBuildConfig

public void applyBuildConfig(io.fabric8.openshift.api.model.BuildConfig entity,
                    String sourceName)

applyDeploymentConfig

public void applyDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig entity,
                         String sourceName)

applyImageStream

public void applyImageStream(io.fabric8.openshift.api.model.ImageStream entity,
                    String sourceName)

applyList

public void applyList(io.fabric8.kubernetes.api.model.KubernetesList list,
             String sourceName)
               throws Exception

Throws:

Exception

applyService

public void applyService(io.fabric8.kubernetes.api.model.Service service,
                String sourceName)
                  throws Exception

Throws:

Exception

doCreateService

protected void doCreateService(io.fabric8.kubernetes.api.model.Service service,
                   String namespace,
                   String sourceName)

applyNamespace

public void applyNamespace(io.fabric8.kubernetes.api.model.Namespace entity)

applyReplicationController

public void applyReplicationController(io.fabric8.kubernetes.api.model.ReplicationController replicationController,
                              String sourceName)
                                throws Exception

Throws:

Exception

doCreateReplicationController

protected void doCreateReplicationController(io.fabric8.kubernetes.api.model.ReplicationController replicationController,
                                 String namespace,
                                 String sourceName)

validatePodSpec

protected void validatePodSpec(io.fabric8.kubernetes.api.model.PodSpec podSpec,
                   String namespace)

Lets verify that any dependencies are available; such as volumes or secrets

applyPod

public void applyPod(io.fabric8.kubernetes.api.model.Pod pod,
            String sourceName)
              throws Exception

Throws:

Exception

doCreatePod

protected void doCreatePod(io.fabric8.kubernetes.api.model.Pod pod,
               String namespace,
               String sourceName)

getNamespace

public String getNamespace()

setNamespace

public void setNamespace(String namespace)

isThrowExceptionOnError

public boolean isThrowExceptionOnError()

setThrowExceptionOnError

public void setThrowExceptionOnError(boolean throwExceptionOnError)

isProcessTemplatesLocally

public boolean isProcessTemplatesLocally()

setProcessTemplatesLocally

public void setProcessTemplatesLocally(boolean processTemplatesLocally)

isRunning

protected boolean isRunning(io.fabric8.kubernetes.api.model.HasMetadata entity)

onApplyError

protected void onApplyError(String message,
                Exception e)

Logs an error applying some JSON to Kubernetes and optionally throws an exception

isAllowCreate

public boolean isAllowCreate()

Returns true if this controller allows new resources to be created in the given namespace

setAllowCreate

public void setAllowCreate(boolean allowCreate)

isRecreateMode

public boolean isRecreateMode()

If enabled then updates are performed by deleting the resource first then creating it

setRecreateMode

public void setRecreateMode(boolean recreateMode)

setServicesOnlyMode

public void setServicesOnlyMode(boolean servicesOnlyMode)

isServicesOnlyMode

public boolean isServicesOnlyMode()

If enabled then only services are created/updated to allow services to be created/updated across a number of apps before any pods/replication controllers are updated

isIgnoreServiceMode

public boolean isIgnoreServiceMode()

If enabled then all services are ignored to avoid them being recreated. This is useful if you want to recreate ReplicationControllers and Pods but leave Services as they are to avoid the portalIP addresses changing

setIgnoreServiceMode

public void setIgnoreServiceMode(boolean ignoreServiceMode)

isIgnoreRunningOAuthClients

public boolean isIgnoreRunningOAuthClients()

setIgnoreRunningOAuthClients

public void setIgnoreRunningOAuthClients(boolean ignoreRunningOAuthClients)