Interface FlowControlK8sElement

All Known Implementing Classes:

ConfigPullScriptDeployer, SecretDeployer, StatefulSetDeployer

public interface FlowControlK8sElement

A kubernetes element (eg. statefulset, secret, etc.) that can be deployed or undeployed. In general, these map to k8s "kinds"

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FlowControlK8sElement.ElementDeployException
static enum	FlowControlK8sElement.ImagePullPolicy
static interface	FlowControlK8sElement.K8sDeployContext
static interface	FlowControlK8sElement.K8sInstallationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	kSetting_TemplateResource

Method Summary

Modifier and Type	Method	Description
void	deploy(FlowControlK8sElement.K8sDeployContext ctx)	Deploy this element with the given context.
default io.continual.flowcontrol.model.FlowControlRuntimeState	getRuntimeState(FlowControlK8sElement.K8sInstallationContext ctx)	If appropriate, get the runtime state associated with this element.
boolean	isDeployed(FlowControlK8sElement.K8sInstallationContext ctx)	Is this element deployed?
default boolean	isRuntimeProvider()	Return true if this element is a runtime provider.
void	undeploy(FlowControlK8sElement.K8sInstallationContext ctx)	Undeploy this element given the namespace and deployment ID

Field Details

kSetting_TemplateResource

static final String kSetting_TemplateResource

See Also:

• Constant Field Values

Method Details

deploy

void deploy(FlowControlK8sElement.K8sDeployContext ctx)
     throws FlowControlK8sElement.ElementDeployException

Deploy this element with the given context. Elements should have names based on the deployment ID because that's what's presented during undeploy.

Parameters:

ctx -

Throws:

FlowControlK8sElement.ElementDeployException

isDeployed

boolean isDeployed(FlowControlK8sElement.K8sInstallationContext ctx)
            throws FlowControlK8sElement.ElementDeployException

Is this element deployed?

Parameters:

ctx -

Throws:

FlowControlK8sElement.ElementDeployException

isRuntimeProvider

default boolean isRuntimeProvider()

Return true if this element is a runtime provider. Generally the statefulset element would return true and anything else would return false;

Returns:

true if this element is a runtime provider

getRuntimeState

default io.continual.flowcontrol.model.FlowControlRuntimeState getRuntimeState(FlowControlK8sElement.K8sInstallationContext ctx)
                                                                        throws FlowControlK8sElement.ElementDeployException

If appropriate, get the runtime state associated with this element. If the element is not current deployed, return null.

Parameters:

ctx -

Returns:

a runtime state or null

Throws:

FlowControlK8sElement.ElementDeployException

undeploy

void undeploy(FlowControlK8sElement.K8sInstallationContext ctx)
       throws FlowControlK8sElement.ElementDeployException

Undeploy this element given the namespace and deployment ID

Parameters:

ctx -

Throws:

FlowControlK8sElement.ElementDeployException