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,ArchiveStatusCleanupProperties.class,DatabaseCleanupProperties.class,LeadershipProperties.class,UserMetricsProperties.class})
 @AutoConfigureAfter(value={TasksAutoConfiguration.class,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(DataServices dataServices, AgentCleanupProperties agentCleanupProperties, io.micrometer.core.instrument.MeterRegistry registry, AgentRoutingService agentRoutingService) If required, get a AgentJobCleanupTask instance for use.
ArchiveStatusCleanupTask	archiveStatusCleanupTask(DataServices dataServices, AgentRoutingService agentRoutingService, ArchiveStatusCleanupProperties archiveStatusCleanupProperties, io.micrometer.core.instrument.MeterRegistry registry) If required, get a ArchiveStatusCleanupTask instance for use.
ClusterLeaderService	curatorClusterLeaderService(org.springframework.integration.zookeeper.leader.LeaderInitiator leaderInitiator) Create a ClusterLeaderService based on Zookeeper/Curator if LeaderInitiator is available and the bean does not already exist.
DatabaseCleanupTask	databaseCleanupTask(DatabaseCleanupProperties cleanupProperties, org.springframework.core.env.Environment environment, DataServices dataServices, io.micrometer.core.instrument.MeterRegistry registry) Create a DatabaseCleanupTask if one is required.
LeaderElectionActuator	leaderElectionActuator(ClusterLeaderService clusterLeaderService) Create a LeaderElectionActuator bean if one is not already defined and if ClusterLeaderService is available.
LeaderTasksCoordinator	leaderTasksCoordinator(org.springframework.scheduling.TaskScheduler taskScheduler, java.util.Set<LeaderTask> tasks) Create the LeadershipTasksCoordination bean used to start and stop all leadership related tasks based on whether leadership is granted or revoked.
ClusterLeaderService	localClusterLeaderService(LocalLeader localLeader) Create a ClusterLeaderService based on static configuration if LocalLeader is available and the bean does not already exist.
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, DataServices dataServices, 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

leaderTasksCoordinator

@Bean
 @ConditionalOnMissingBean(value=LeaderTasksCoordinator.class)
public LeaderTasksCoordinator leaderTasksCoordinator(@Qualifier(value="genieTaskScheduler")
                                                                                                                          org.springframework.scheduling.TaskScheduler taskScheduler,
                                                                                                                          java.util.Set<LeaderTask> 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

databaseCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.database-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=DatabaseCleanupTask.class)
public DatabaseCleanupTask databaseCleanupTask(DatabaseCleanupProperties cleanupProperties,
                                                                                                                                                                                                                                  org.springframework.core.env.Environment environment,
                                                                                                                                                                                                                                  DataServices dataServices,
                                                                                                                                                                                                                                  io.micrometer.core.instrument.MeterRegistry registry)

Create a DatabaseCleanupTask if one is required.

Parameters:

cleanupProperties - The properties to use to configure this task

environment - The application Environment to pull properties from

dataServices - The DataServices encapsulation instance to use

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,
                                                                                                                                                                                                                  DataServices dataServices,
                                                                                                                                                                                                                  UserMetricsProperties userMetricsProperties)

If required get a UserMetricsTask instance for use.

Parameters:

registry - The metrics registry

dataServices - The DataServices instance to use

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(DataServices dataServices,
                                                                                                                                                                                                                               AgentCleanupProperties agentCleanupProperties,
                                                                                                                                                                                                                               io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                                                                                                                               AgentRoutingService agentRoutingService)

If required, get a AgentJobCleanupTask instance for use.

Parameters:

dataServices - The DataServices encapsulation instance to use

agentCleanupProperties - the agent cleanup properties

registry - the metrics registry

agentRoutingService - the agent routing service

Returns:

a AgentJobCleanupTask

archiveStatusCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.archive-status-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=ArchiveStatusCleanupTask.class)
public ArchiveStatusCleanupTask archiveStatusCleanupTask(DataServices dataServices,
                                                                                                                                                                                                                                                       AgentRoutingService agentRoutingService,
                                                                                                                                                                                                                                                       ArchiveStatusCleanupProperties archiveStatusCleanupProperties,
                                                                                                                                                                                                                                                       io.micrometer.core.instrument.MeterRegistry registry)

If required, get a ArchiveStatusCleanupTask instance for use.

Parameters:

dataServices - The DataServices encapsulation instance to use

agentRoutingService - the agent routing service

archiveStatusCleanupProperties - the archive status cleanup properties

registry - the metrics registry

Returns:

a AgentJobCleanupTask

curatorClusterLeaderService

@Bean
 @ConditionalOnBean(value=org.springframework.integration.zookeeper.leader.LeaderInitiator.class)
 @ConditionalOnMissingBean(value=ClusterLeaderService.class)
public ClusterLeaderService curatorClusterLeaderService(org.springframework.integration.zookeeper.leader.LeaderInitiator leaderInitiator)

Create a ClusterLeaderService based on Zookeeper/Curator if LeaderInitiator is available and the bean does not already exist.

Parameters:

leaderInitiator - the Spring Zookeeper/Curator based leader election component

Returns:

a ClusterLeaderService

localLeader

@Bean
 @ConditionalOnMissingBean(value={org.springframework.integration.zookeeper.leader.LeaderInitiator.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

localClusterLeaderService

@Bean
 @ConditionalOnBean(value=LocalLeader.class)
 @ConditionalOnMissingBean(value=ClusterLeaderService.class)
public ClusterLeaderService localClusterLeaderService(LocalLeader localLeader)

Create a ClusterLeaderService based on static configuration if LocalLeader is available and the bean does not already exist.

Parameters:

localLeader - the configuration-based leader election component

Returns:

a ClusterLeaderService

leaderElectionActuator

@Bean
 @ConditionalOnBean(value=ClusterLeaderService.class)
 @ConditionalOnMissingBean(value=LeaderElectionActuator.class)
public LeaderElectionActuator leaderElectionActuator(ClusterLeaderService clusterLeaderService)

Create a LeaderElectionActuator bean if one is not already defined and if ClusterLeaderService is available. This bean is an endpoint that gets registered in Spring Actuator.

Parameters:

clusterLeaderService - the cluster leader service

Returns:

a LeaderElectionActuator