com.spotify.helios.master

Interface MasterModel

All Known Implementing Classes:

ZooKeeperMasterModel

public interface MasterModel

The interface that describes the kinds of information the Helios master needs from it's configuration/coordination store.

Method Summary

Modifier and Type	Method and Description
void	addDeploymentGroup(com.spotify.helios.common.descriptors.DeploymentGroup deploymentGroup)
void	addJob(com.spotify.helios.common.descriptors.Job job)
void	deployJob(String host, com.spotify.helios.common.descriptors.Deployment job)
void	deployJob(String host, com.spotify.helios.common.descriptors.Deployment job, String token)
void	deregisterHost(String host)
com.spotify.helios.common.descriptors.AgentInfo	getAgentInfo(String host)
com.spotify.helios.common.descriptors.Deployment	getDeployment(String host, com.spotify.helios.common.descriptors.JobId jobId)
com.spotify.helios.common.descriptors.DeploymentGroup	getDeploymentGroup(String name)
List<String>	getDeploymentGroupHosts(String name)
Map<String,com.spotify.helios.common.descriptors.DeploymentGroup>	getDeploymentGroups()
com.spotify.helios.common.descriptors.DeploymentGroupStatus	getDeploymentGroupStatus(String name)
Map<String,String>	getHostLabels(String host) Returns labels for host.
com.spotify.helios.common.descriptors.HostStatus	getHostStatus(String host)
com.spotify.helios.common.descriptors.Job	getJob(com.spotify.helios.common.descriptors.JobId jobId)
List<com.spotify.helios.common.descriptors.TaskStatusEvent>	getJobHistory(com.spotify.helios.common.descriptors.JobId jobId)
List<com.spotify.helios.common.descriptors.TaskStatusEvent>	getJobHistory(com.spotify.helios.common.descriptors.JobId jobId, String host)
Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Job>	getJobs()
com.spotify.helios.common.descriptors.JobStatus	getJobStatus(com.spotify.helios.common.descriptors.JobId jobId)
List<String>	getRunningMasters()
boolean	isHostUp(String host)
List<String>	listHosts()
void	registerHost(String host, String id)
void	removeDeploymentGroup(String name)
com.spotify.helios.common.descriptors.Job	removeJob(com.spotify.helios.common.descriptors.JobId jobId)
com.spotify.helios.common.descriptors.Job	removeJob(com.spotify.helios.common.descriptors.JobId jobId, String token)
void	rollingUpdate(com.spotify.helios.common.descriptors.DeploymentGroup deploymentGroup, com.spotify.helios.common.descriptors.JobId jobId, com.spotify.helios.common.descriptors.RolloutOptions options)
void	rollingUpdateStep()
void	stopDeploymentGroup(String deploymentGroupName)
com.spotify.helios.common.descriptors.Deployment	undeployJob(String host, com.spotify.helios.common.descriptors.JobId jobId)
com.spotify.helios.common.descriptors.Deployment	undeployJob(String host, com.spotify.helios.common.descriptors.JobId jobId, String token)
void	updateDeployment(String host, com.spotify.helios.common.descriptors.Deployment deployment)
void	updateDeployment(String host, com.spotify.helios.common.descriptors.Deployment deployment, String token)
void	updateDeploymentGroupHosts(String groupName, List<String> hosts)

Method Detail

registerHost

void registerHost(String host,
                  String id)

deregisterHost

void deregisterHost(String host)
             throws HostNotFoundException,
                    HostStillInUseException

Throws:

HostNotFoundException

HostStillInUseException

listHosts

List<String> listHosts()

getHostStatus

com.spotify.helios.common.descriptors.HostStatus getHostStatus(String host)

getHostLabels

Map<String,String> getHostLabels(String host)

Returns labels for host. Returns an empty map for hosts not found in the store.

isHostUp

boolean isHostUp(String host)

getAgentInfo

com.spotify.helios.common.descriptors.AgentInfo getAgentInfo(String host)

addJob

void addJob(com.spotify.helios.common.descriptors.Job job)
     throws JobExistsException

Throws:

JobExistsException

getJob

com.spotify.helios.common.descriptors.Job getJob(com.spotify.helios.common.descriptors.JobId jobId)

getJobs

Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Job> getJobs()

getJobStatus

com.spotify.helios.common.descriptors.JobStatus getJobStatus(com.spotify.helios.common.descriptors.JobId jobId)

removeJob

com.spotify.helios.common.descriptors.Job removeJob(com.spotify.helios.common.descriptors.JobId jobId)
                                             throws JobDoesNotExistException,
                                                    JobStillDeployedException

Throws:

JobDoesNotExistException

JobStillDeployedException

removeJob

com.spotify.helios.common.descriptors.Job removeJob(com.spotify.helios.common.descriptors.JobId jobId,
                                                    String token)
                                             throws JobDoesNotExistException,
                                                    JobStillDeployedException,
                                                    TokenVerificationException

Throws:

JobDoesNotExistException

JobStillDeployedException

TokenVerificationException

deployJob

void deployJob(String host,
               com.spotify.helios.common.descriptors.Deployment job)
        throws HostNotFoundException,
               JobAlreadyDeployedException,
               JobDoesNotExistException,
               JobPortAllocationConflictException

Throws:

HostNotFoundException

JobAlreadyDeployedException

JobDoesNotExistException

JobPortAllocationConflictException

deployJob

void deployJob(String host,
               com.spotify.helios.common.descriptors.Deployment job,
               String token)
        throws HostNotFoundException,
               JobAlreadyDeployedException,
               JobDoesNotExistException,
               JobPortAllocationConflictException,
               TokenVerificationException

Throws:

HostNotFoundException

JobAlreadyDeployedException

JobDoesNotExistException

JobPortAllocationConflictException

TokenVerificationException

getDeployment

com.spotify.helios.common.descriptors.Deployment getDeployment(String host,
                                                               com.spotify.helios.common.descriptors.JobId jobId)

undeployJob

com.spotify.helios.common.descriptors.Deployment undeployJob(String host,
                                                             com.spotify.helios.common.descriptors.JobId jobId)
                                                      throws HostNotFoundException,
                                                             JobNotDeployedException

Throws:

HostNotFoundException

JobNotDeployedException

undeployJob

com.spotify.helios.common.descriptors.Deployment undeployJob(String host,
                                                             com.spotify.helios.common.descriptors.JobId jobId,
                                                             String token)
                                                      throws HostNotFoundException,
                                                             JobNotDeployedException,
                                                             TokenVerificationException

Throws:

HostNotFoundException

JobNotDeployedException

TokenVerificationException

updateDeployment

void updateDeployment(String host,
                      com.spotify.helios.common.descriptors.Deployment deployment)
               throws HostNotFoundException,
                      JobNotDeployedException

Throws:

HostNotFoundException

JobNotDeployedException

updateDeployment

void updateDeployment(String host,
                      com.spotify.helios.common.descriptors.Deployment deployment,
                      String token)
               throws HostNotFoundException,
                      JobNotDeployedException,
                      TokenVerificationException

Throws:

HostNotFoundException

JobNotDeployedException

TokenVerificationException

getRunningMasters

List<String> getRunningMasters()

getJobHistory

List<com.spotify.helios.common.descriptors.TaskStatusEvent> getJobHistory(com.spotify.helios.common.descriptors.JobId jobId)
                                                                   throws JobDoesNotExistException

Throws:

JobDoesNotExistException

getJobHistory

List<com.spotify.helios.common.descriptors.TaskStatusEvent> getJobHistory(com.spotify.helios.common.descriptors.JobId jobId,
                                                                          String host)
                                                                   throws JobDoesNotExistException

Throws:

JobDoesNotExistException

addDeploymentGroup

void addDeploymentGroup(com.spotify.helios.common.descriptors.DeploymentGroup deploymentGroup)
                 throws DeploymentGroupExistsException

Throws:

DeploymentGroupExistsException

getDeploymentGroup

com.spotify.helios.common.descriptors.DeploymentGroup getDeploymentGroup(String name)
                                                                  throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

getDeploymentGroups

Map<String,com.spotify.helios.common.descriptors.DeploymentGroup> getDeploymentGroups()

getDeploymentGroupHosts

List<String> getDeploymentGroupHosts(String name)
                              throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

updateDeploymentGroupHosts

void updateDeploymentGroupHosts(String groupName,
                                List<String> hosts)
                         throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

getDeploymentGroupStatus

com.spotify.helios.common.descriptors.DeploymentGroupStatus getDeploymentGroupStatus(String name)
                                                                              throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

removeDeploymentGroup

void removeDeploymentGroup(String name)
                    throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

rollingUpdate

void rollingUpdate(com.spotify.helios.common.descriptors.DeploymentGroup deploymentGroup,
                   com.spotify.helios.common.descriptors.JobId jobId,
                   com.spotify.helios.common.descriptors.RolloutOptions options)
            throws DeploymentGroupDoesNotExistException,
                   JobDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException

JobDoesNotExistException

rollingUpdateStep

void rollingUpdateStep()

stopDeploymentGroup

void stopDeploymentGroup(String deploymentGroupName)
                  throws DeploymentGroupDoesNotExistException

Throws:

DeploymentGroupDoesNotExistException