com.openshift.internal.restclient.model

Class ReplicationController

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.ReplicationController

All Implemented Interfaces:

ResourcePropertyKeys, IAnnotatable, IApiVersionable, IKindable, ITypeMeta, ICapable, Annotatable, IReplicationController, IResource, JSONSerializeable

Direct Known Subclasses:

DeploymentConfig

public class ReplicationController
extends KubernetesResource
implements IReplicationController

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ENV
protected static String	IMAGE
protected static String	SERVICEACCOUNTNAME
protected static String	SPEC_REPLICAS
protected static String	SPEC_SELECTOR
static String	SPEC_TEMPLATE_CONTAINERS
protected static String	SPEC_TEMPLATE_LABELS
protected static String	STATUS_REPLICA
protected static String	VOLUMES

Fields inherited from interface com.openshift.restclient.model.IReplicationController

DEPLOYMENT_PHASE

Fields inherited from interface com.openshift.internal.restclient.model.properties.ResourcePropertyKeys

ANNOTATIONS, APIVERSION, CREATION_TIMESTAMP, FROM, KIND, LABELS, METADATA, METADATA_NAME, METADATA_NAMESPACE, METADATA_RESOURCE_VERSION, METADATA_UID, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE

Constructor Summary

Constructors

Constructor and Description
ReplicationController(org.jboss.dmr.ModelNode node, IClient client, Map<String,String[]> propertyKeys)

Method Summary

Modifier and Type	Method and Description
IContainer	addContainer(DockerImageURI tag, Set<IPort> containerPorts, Map<String,String> envVars) Add a container to the pod that will be spun up as part of this deployment, defaulting the name to the image name
IContainer	addContainer(String name) Add a container with the given name
IContainer	addContainer(String name, DockerImageURI tag, Set<IPort> containerPorts, Map<String,String> envVars, List<String> emptyDirVolumes) Add a container to the pod that will be spun up as part of this deployment.
void	addTemplateLabel(String key, String value) Add or update a label to the template spec;
void	addVolume(IVolumeSource volumeSource) Adds a volume to the pod spec.
<T extends IVolumeSource> T	addVolume(String volumetype, String name) Add a volume source of the given type with the given name.
IContainer	getContainer(String name) Retrieve a container by name or null if it is not found
Collection<IContainer>	getContainers() Retrieve the containers defined in spec
int	getCurrentReplicaCount() Returns the current number of replicas
int	getDesiredReplicaCount() Returns the desired number of replicas
Collection<IEnvironmentVariable>	getEnvironmentVariables() Return the list of env vars of the first container
Collection<IEnvironmentVariable>	getEnvironmentVariables(String containerName) Return the list of env vars for the given container or an empty list if the container is not found
Collection<String>	getImages() Retrieves the list of images deployed in the pod containers from this controller
int	getReplicas()
Map<String,String>	getReplicaSelector() Returns the selector used by the controller
String	getServiceAccountName() Retrieves the service account used by the controller
Map<String,String>	getTemplateLabels() Returns the labels for the template in this replication controller
Set<IVolumeSource>	getVolumes() The volumes associated with the pod spec
void	removeEnvironmentVariable(String name) Removes an environment variable with the given name.
void	removeEnvironmentVariable(String containerName, String name) Removes an environment variable with the given name and value on the given container.
void	setContainers(Collection<IContainer> containers)
void	setDesiredReplicaCount(int count) Sets a new desired number of replicas
void	setEnvironmentVariable(String name, String value) Set an environment variable to the given name and value on the first container in the list of containers
void	setEnvironmentVariable(String containerName, String name, String value) Set an environment variable to the given name and value on the given container.
void	setReplicas(int count)
void	setReplicaSelector(Map<String,String> selector) Set the selector using the map of values
void	setReplicaSelector(String key, String value)
void	setServiceAccountName(String serviceAccountName) Sets the service account to run this replication controller under.
void	setVolumes(Set<IVolumeSource> volumeSources) Sets the volumes associated with the pod spec.

Methods inherited from class com.openshift.internal.restclient.model.KubernetesResource

accept, addLabel, asBoolean, asBoolean, asInt, asInt, asMap, asSet, asString, asString, equals, get, get, getAnnotation, getAnnotations, getApiVersion, getCapabilities, getCapability, getClient, getCreationTimeStamp, getEnvMap, getKind, getLabels, getMetadata, getModifiableCapabilities, getName, getNamespace, getNamespaceName, getNode, getPath, getProject, getPropertyKeys, getResourceVersion, has, hashCode, isAnnotatedWith, refresh, removeAnnotation, set, set, set, set, set, set, set, set, set, setAnnotation, setEnvMap, setName, setNamespace, setNode, supports, toJson, toJson, toPrettyString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.openshift.restclient.model.IResource

addLabel, getAnnotation, getAnnotations, getCapabilities, getCreationTimeStamp, getLabels, getMetadata, getName, getNamespace, getNamespaceName, getProject, getResourceVersion, isAnnotatedWith, removeAnnotation, setAnnotation

Methods inherited from interface com.openshift.restclient.capability.ICapable

accept, getCapability, supports

Methods inherited from interface com.openshift.restclient.api.models.IApiVersionable

getApiVersion

Methods inherited from interface com.openshift.restclient.api.models.IKindable

getKind

Methods inherited from interface com.openshift.restclient.model.JSONSerializeable

toJson, toJson

Field Detail

SPEC_TEMPLATE_CONTAINERS

public static final String SPEC_TEMPLATE_CONTAINERS

See Also:

Constant Field Values

SPEC_TEMPLATE_LABELS

protected static final String SPEC_TEMPLATE_LABELS

See Also:

Constant Field Values

VOLUMES

protected static final String VOLUMES

See Also:

Constant Field Values

SPEC_REPLICAS

protected static final String SPEC_REPLICAS

See Also:

Constant Field Values

SPEC_SELECTOR

protected static final String SPEC_SELECTOR

See Also:

Constant Field Values

STATUS_REPLICA

protected static final String STATUS_REPLICA

See Also:

Constant Field Values

SERVICEACCOUNTNAME

protected static final String SERVICEACCOUNTNAME

See Also:

Constant Field Values

IMAGE

protected static final String IMAGE

See Also:

Constant Field Values

ENV

protected static final String ENV

See Also:

Constant Field Values

Constructor Detail

ReplicationController

public ReplicationController(org.jboss.dmr.ModelNode node,
                             IClient client,
                             Map<String,String[]> propertyKeys)

Method Detail

setEnvironmentVariable

public void setEnvironmentVariable(String name,
                                   String value)

Description copied from interface: IReplicationController

Set an environment variable to the given name and value on the first container in the list of containers

Specified by:

setEnvironmentVariable in interface IReplicationController

setEnvironmentVariable

public void setEnvironmentVariable(String containerName,
                                   String name,
                                   String value)

Description copied from interface: IReplicationController

Set an environment variable to the given name and value on the given container. Returns silently if the containerName is not found

Specified by:

setEnvironmentVariable in interface IReplicationController

removeEnvironmentVariable

public void removeEnvironmentVariable(String name)

Description copied from interface: IReplicationController

Removes an environment variable with the given name. Returns silently if the name is not found

Specified by:

removeEnvironmentVariable in interface IReplicationController

removeEnvironmentVariable

public void removeEnvironmentVariable(String containerName,
                                      String name)

Description copied from interface: IReplicationController

Removes an environment variable with the given name and value on the given container. Returns silently if the containerName or the name is not found

Specified by:

removeEnvironmentVariable in interface IReplicationController

getEnvironmentVariables

public Collection<IEnvironmentVariable> getEnvironmentVariables()

Description copied from interface: IReplicationController

Return the list of env vars of the first container

Specified by:

getEnvironmentVariables in interface IReplicationController

getEnvironmentVariables

public Collection<IEnvironmentVariable> getEnvironmentVariables(String containerName)

Description copied from interface: IReplicationController

Return the list of env vars for the given container or an empty list if the container is not found

Specified by:

getEnvironmentVariables in interface IReplicationController

getDesiredReplicaCount

public int getDesiredReplicaCount()

Description copied from interface: IReplicationController

Returns the desired number of replicas

Specified by:

getDesiredReplicaCount in interface IReplicationController

getReplicas

public int getReplicas()

Specified by:

getReplicas in interface IReplicationController

setDesiredReplicaCount

public void setDesiredReplicaCount(int count)

Description copied from interface: IReplicationController

Sets a new desired number of replicas

Specified by:

setDesiredReplicaCount in interface IReplicationController

setReplicas

public void setReplicas(int count)

Specified by:

setReplicas in interface IReplicationController

getReplicaSelector

public Map<String,String> getReplicaSelector()

Description copied from interface: IReplicationController

Returns the selector used by the controller

Specified by:

getReplicaSelector in interface IReplicationController

setReplicaSelector

public void setReplicaSelector(String key,
                               String value)

Specified by:

setReplicaSelector in interface IReplicationController

setReplicaSelector

public void setReplicaSelector(Map<String,String> selector)

Description copied from interface: IReplicationController

Set the selector using the map of values

Specified by:

setReplicaSelector in interface IReplicationController

getCurrentReplicaCount

public int getCurrentReplicaCount()

Description copied from interface: IReplicationController

Returns the current number of replicas

Specified by:

getCurrentReplicaCount in interface IReplicationController

getImages

public Collection<String> getImages()

Description copied from interface: IReplicationController

Retrieves the list of images deployed in the pod containers from this controller

Specified by:

getImages in interface IReplicationController

getContainer

public IContainer getContainer(String name)

Description copied from interface: IReplicationController

Retrieve a container by name or null if it is not found

Specified by:

getContainer in interface IReplicationController

Returns:

the container or null if not found

getContainers

public Collection<IContainer> getContainers()

Description copied from interface: IReplicationController

Retrieve the containers defined in spec

Specified by:

getContainers in interface IReplicationController

Returns:

collection of containers or empty collection

getTemplateLabels

public Map<String,String> getTemplateLabels()

Description copied from interface: IReplicationController

Returns the labels for the template in this replication controller

Specified by:

getTemplateLabels in interface IReplicationController

addTemplateLabel

public void addTemplateLabel(String key,
                             String value)

Description copied from interface: IReplicationController

Add or update a label to the template spec;

Specified by:

addTemplateLabel in interface IReplicationController

addContainer

public IContainer addContainer(DockerImageURI tag,
                               Set<IPort> containerPorts,
                               Map<String,String> envVars)

Description copied from interface: IReplicationController

Add a container to the pod that will be spun up as part of this deployment, defaulting the name to the image name

Specified by:

addContainer in interface IReplicationController

Parameters:

tag - the docker uri

containerPorts - the container ports

addContainer

public IContainer addContainer(String name,
                               DockerImageURI tag,
                               Set<IPort> containerPorts,
                               Map<String,String> envVars,
                               List<String> emptyDirVolumes)

Description copied from interface: IReplicationController

Add a container to the pod that will be spun up as part of this deployment.

Specified by:

addContainer in interface IReplicationController

Parameters:

name - the name of the container

tag - the docker uri

containerPorts - the container ports

emptyDirVolumes - the set of emptyDir volumes to add to the config

addContainer

public IContainer addContainer(String name)

Description copied from interface: IReplicationController

Add a container with the given name

Specified by:

addContainer in interface IReplicationController

setContainers

public void setContainers(Collection<IContainer> containers)

Specified by:

setContainers in interface IReplicationController

getVolumes

public Set<IVolumeSource> getVolumes()

Description copied from interface: IReplicationController

The volumes associated with the pod spec

Specified by:

getVolumes in interface IReplicationController

setVolumes

public void setVolumes(Set<IVolumeSource> volumeSources)

Description copied from interface: IReplicationController

Sets the volumes associated with the pod spec. Existing volumes will be overwritten.

Specified by:

setVolumes in interface IReplicationController

Parameters:

volumeSources - The volumes to assign to the pod spec.

addVolume

public void addVolume(IVolumeSource volumeSource)

Description copied from interface: IReplicationController

Adds a volume to the pod spec. If a volume with the same name already exists, the volume is not added.

Specified by:

addVolume in interface IReplicationController

Parameters:

volumeSource - The volume to add to the pod spec

addVolume

public <T extends IVolumeSource> T addVolume(String volumetype,
                                             String name)

Description copied from interface: IReplicationController

Add a volume source of the given type with the given name. Unimplemented types will return a generic volumesource impl

Specified by:

addVolume in interface IReplicationController

Returns:

setServiceAccountName

public void setServiceAccountName(String serviceAccountName)

Description copied from interface: IReplicationController

Sets the service account to run this replication controller under.

Specified by:

setServiceAccountName in interface IReplicationController

getServiceAccountName

public String getServiceAccountName()

Description copied from interface: IReplicationController

Retrieves the service account used by the controller

Specified by:

getServiceAccountName in interface IReplicationController