com.netflix.genie.web.spring.autoconfigure.tasks.leader

Class LeaderAutoConfiguration

java.lang.Object

com.netflix.genie.web.spring.autoconfigure.tasks.leader.LeaderAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value={AgentCleanupProperties.class,ClusterCheckerProperties.class,DatabaseCleanupProperties.class,LeadershipProperties.class,UserMetricsProperties.class,ZookeeperLeadershipProperties.class})
 @AutoConfigureAfter(value={TasksAutoConfiguration.class,org.springframework.cloud.zookeeper.ZookeeperAutoConfiguration.class})
public class LeaderAutoConfiguration
extends java.lang.Object

Beans for Leadership of a Genie cluster.

Since:

3.1.0

Constructor Summary

Constructors

Constructor and Description
LeaderAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
AgentJobCleanupTask	agentJobCleanupTask(JobSearchService jobSearchService, JobPersistenceService jobPersistenceService, AgentCleanupProperties agentCleanupProperties, io.micrometer.core.instrument.MeterRegistry registry) If required, get a AgentJobCleanupTask instance for use.
ClusterCheckerTask	clusterCheckerTask(GenieHostInfo genieHostInfo, ClusterCheckerProperties properties, JobSearchService jobSearchService, JobPersistenceService jobPersistenceService, AgentConnectionPersistenceService agentConnectionPersistenceService, org.springframework.web.client.RestTemplate restTemplate, org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties, io.micrometer.core.instrument.MeterRegistry registry) Create a ClusterCheckerTask if one hasn't been supplied.
DatabaseCleanupTask	databaseCleanupTask(DatabaseCleanupProperties cleanupProperties, JobPersistenceService jobPersistenceService, ClusterPersistenceService clusterPersistenceService, FilePersistenceService filePersistenceService, TagPersistenceService tagPersistenceService, io.micrometer.core.instrument.MeterRegistry registry) Create a DatabaseCleanupTask if one is required.
org.springframework.integration.zookeeper.config.LeaderInitiatorFactoryBean	leaderInitiatorFactory(org.apache.curator.framework.CuratorFramework client, ZookeeperLeadershipProperties zookeeperLeadershipProperties) The leadership initialization factory bean which will create a LeaderInitiator to kick off the leader election process within this node for the cluster if Zookeeper is configured.
LeadershipTasksCoordinator	leadershipTasksCoordinator(org.springframework.scheduling.TaskScheduler taskScheduler, java.util.Set<LeadershipTask> tasks) Create the LeadershipTasksCoordination bean used to start and stop all leadership related tasks based on whether leadership is granted or revoked.
LocalLeader	localLeader(GenieEventBus genieEventBus, LeadershipProperties leadershipProperties) If Zookeeper isn't available and this node is forced to be the leader create the local leader bean which will fire appropriate events.
UserMetricsTask	userMetricsTask(io.micrometer.core.instrument.MeterRegistry registry, JobSearchService jobSearchService, UserMetricsProperties userMetricsProperties) If required get a UserMetricsTask instance for use.

Methods inherited from class java.lang.Object

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

Constructor Detail

LeaderAutoConfiguration

public LeaderAutoConfiguration()

Method Detail

leadershipTasksCoordinator

@Bean
 @ConditionalOnMissingBean(value=LeadershipTasksCoordinator.class)
public LeadershipTasksCoordinator leadershipTasksCoordinator(@Qualifier(value="genieTaskScheduler")
                                                                                                                                      org.springframework.scheduling.TaskScheduler taskScheduler,
                                                                                                                                      java.util.Set<LeadershipTask> tasks)

Create the LeadershipTasksCoordination bean used to start and stop all leadership related tasks based on whether leadership is granted or revoked.

Parameters:

taskScheduler - The task scheduler to use for scheduling leadership tasks

tasks - The leadership tasks to schedule

Returns:

The leader coordinator

leaderInitiatorFactory

@Bean
 @ConditionalOnBean(value=org.apache.curator.framework.CuratorFramework.class)
 @ConditionalOnMissingBean(value=org.springframework.integration.zookeeper.config.LeaderInitiatorFactoryBean.class)
public org.springframework.integration.zookeeper.config.LeaderInitiatorFactoryBean leaderInitiatorFactory(org.apache.curator.framework.CuratorFramework client,
                                                                                                                                                                                                                                                                                                                   ZookeeperLeadershipProperties zookeeperLeadershipProperties)

The leadership initialization factory bean which will create a LeaderInitiator to kick off the leader election process within this node for the cluster if Zookeeper is configured.

Parameters:

client - The curator framework client to use

zookeeperLeadershipProperties - The Zookeeper properties to use

Returns:

The factory bean

localLeader

@Bean
 @ConditionalOnMissingBean(value={org.apache.curator.framework.CuratorFramework.class,LocalLeader.class})
public LocalLeader localLeader(GenieEventBus genieEventBus,
                                                                                                                                               LeadershipProperties leadershipProperties)

If Zookeeper isn't available and this node is forced to be the leader create the local leader bean which will fire appropriate events.

Parameters:

genieEventBus - The genie event bus implementation to use

leadershipProperties - Properties related to static leadership configuration for the Genie cluster

Returns:

The local leader bean

clusterCheckerTask

@Bean
 @ConditionalOnMissingBean(value=ClusterCheckerTask.class)
public ClusterCheckerTask clusterCheckerTask(GenieHostInfo genieHostInfo,
                                                                                                              ClusterCheckerProperties properties,
                                                                                                              JobSearchService jobSearchService,
                                                                                                              JobPersistenceService jobPersistenceService,
                                                                                                              AgentConnectionPersistenceService agentConnectionPersistenceService,
                                                                                                              @Qualifier(value="genieRestTemplate")
                                                                                                              org.springframework.web.client.RestTemplate restTemplate,
                                                                                                              org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties,
                                                                                                              io.micrometer.core.instrument.MeterRegistry registry)

Create a ClusterCheckerTask if one hasn't been supplied.

Parameters:

genieHostInfo - Information about the host this Genie process is running on

properties - The properties to use to configure the task

jobSearchService - The job search service to use

jobPersistenceService - The job persistence service to use

agentConnectionPersistenceService - The agent connection persistence service

restTemplate - The rest template for http calls

webEndpointProperties - The properties where Spring actuator is running

registry - The spectator registry for getting metrics

Returns:

The ClusterCheckerTask instance

databaseCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.database-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=DatabaseCleanupTask.class)
public DatabaseCleanupTask databaseCleanupTask(DatabaseCleanupProperties cleanupProperties,
                                                                                                                                                                                                                                  JobPersistenceService jobPersistenceService,
                                                                                                                                                                                                                                  ClusterPersistenceService clusterPersistenceService,
                                                                                                                                                                                                                                  FilePersistenceService filePersistenceService,
                                                                                                                                                                                                                                  TagPersistenceService tagPersistenceService,
                                                                                                                                                                                                                                  io.micrometer.core.instrument.MeterRegistry registry)

Create a DatabaseCleanupTask if one is required.

Parameters:

cleanupProperties - The properties to use to configure this task

jobPersistenceService - The persistence service to use to cleanup the data store

clusterPersistenceService - The cluster service to use to delete terminated clusters

filePersistenceService - The file service to use to delete unused file references

tagPersistenceService - The tag service to use to delete unused tag references

registry - The metrics registry

Returns:

The DatabaseCleanupTask instance to use if the conditions match

userMetricsTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.user-metrics.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=UserMetricsTask.class)
public UserMetricsTask userMetricsTask(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                                                                                                                  JobSearchService jobSearchService,
                                                                                                                                                                                                                  UserMetricsProperties userMetricsProperties)

If required get a UserMetricsTask instance for use.

Parameters:

registry - The metrics registry

jobSearchService - The job search service

userMetricsProperties - The properties

Returns:

The UserMetricsTask instance

agentJobCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.agent-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=AgentJobCleanupTask.class)
public AgentJobCleanupTask agentJobCleanupTask(JobSearchService jobSearchService,
                                                                                                                                                                                                                               JobPersistenceService jobPersistenceService,
                                                                                                                                                                                                                               AgentCleanupProperties agentCleanupProperties,
                                                                                                                                                                                                                               io.micrometer.core.instrument.MeterRegistry registry)

If required, get a AgentJobCleanupTask instance for use.

Parameters:

jobSearchService - The job search service

jobPersistenceService - the job persistence service

agentCleanupProperties - the agent cleanup properties

registry - the metrics registry

Returns:

a AgentJobCleanupTask