Package com.yahoo.vespa.model.admin

Class Slobrok

java.lang.Object

com.yahoo.config.model.producer.AnyConfigProducer

com.yahoo.config.model.producer.TreeConfigProducer<AnyConfigProducer>

com.yahoo.vespa.model.AbstractService

com.yahoo.vespa.model.admin.Slobrok

All Implemented Interfaces:

com.yahoo.config.ConfigInstance.Producer, com.yahoo.vespa.config.core.StateserverConfig.Producer, ConfigProducer, NetworkPortRequestor, Service, Serializable

public class Slobrok
extends AbstractService
implements com.yahoo.vespa.config.core.StateserverConfig.Producer

Represents a Slobrok service.

Author:

gjoranv

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BASEPORT

Fields inherited from class com.yahoo.vespa.model.AbstractService

portsMeta

Fields inherited from class com.yahoo.config.model.producer.AnyConfigProducer

log

Constructor Summary

Constructors

Constructor	Description
Slobrok(TreeConfigProducer<?> parent, int index, com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags)

Method Summary

Modifier and Type	Method	Description
void	allocatePorts(int start, PortAllocBridge from)	allocate the ports you need
void	getConfig(com.yahoo.vespa.config.core.StateserverConfig.Builder builder)
String	getConnectionSpec()
int	getHealthPort()	The service HTTP port for health status
int	getPortCount()	Returns the number of ports needed by this service.
Optional<String>	getStartupCommand()	Must be overridden by services that should be started by config-sentinel.
int	getWantedPort()	Returns the desired base port for the first instance of the service type.

Methods inherited from class com.yahoo.vespa.model.AbstractService

addEnvironmentVariable, addEnvironmentVariable, appendJvmOptions, defaultPreload, distributeCpuSocketAffinity, getAffinity, getDefaultMetricDimensions, getEnvStringForTesting, getEnvVars, getHost, getHostName, getHostResource, getId, getIndex, getJvmOptions, getNumPortsAllocated, getPortsMeta, getPreLoad, getPreShutdownCommand, getRelativePort, getServiceInfo, getServiceName, getServicePropertyString, getServicePropertyString, getServiceType, initService, isInitialized, prependJvmOptions, remove, requiresWantedPort, setAffinity, setBasePort, setCoreOnOOM, setHostResource, setJvmOptions, setMMapNoCoreLimit, setNoVespaMalloc, setPreLoad, setProp, setProp, setVespaMalloc, setVespaMallocDebug, setVespaMallocDebugStackTrace, toString

Methods inherited from class com.yahoo.config.model.producer.TreeConfigProducer

addChild, addDescendantService, getChildren, getChildrenByTypeRecursive, getConfigClassLoader, getDescendantServices, removeChild, validate

Methods inherited from class com.yahoo.config.model.producer.AnyConfigProducer

addConfigId, addUserConfig, cascadeConfig, currentConfigId, findInheritedClassLoader, getConfigId, getMonitoringService, getParent, getRoot, getSubId, getUserConfigs, hostSystem, mergeUserConfigs, setParent, setUserConfigs, stateIsHosted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.vespa.model.ConfigProducer

addUserConfig, cascadeConfig, dump, getChildren, getConfigId, getDescendantServices, getUserConfigs, hostSystem, validate

Methods inherited from interface com.yahoo.vespa.model.NetworkPortRequestor

getConfigId

Methods inherited from interface com.yahoo.vespa.model.Service

getLogctlSpecs

Field Details

BASEPORT

public static final int BASEPORT

See Also:

• Constant Field Values

Constructor Details

Slobrok

public Slobrok(TreeConfigProducer<?> parent,
 int index,
 com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags)

Parameters:

parent - the parent ConfigProducer.

index - unique index for all slobroks

Method Details

getConfig

public void getConfig(com.yahoo.vespa.config.core.StateserverConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.vespa.config.core.StateserverConfig.Producer

getWantedPort

public int getWantedPort()

Description copied from class: AbstractService

Returns the desired base port for the first instance of the service type. Returns '0' as default, which means that the service type should use the default port allocation mechanism.

Specified by:

getWantedPort in interface NetworkPortRequestor

Overrides:

getWantedPort in class AbstractService

Returns:

The desired base port for the first instance of the service type.

getStartupCommand

public Optional<String> getStartupCommand()

Description copied from class: AbstractService

Must be overridden by services that should be started by config-sentinel. The returned value will be used in config-sentinel configuration. Returns empty by default.

Specified by:

getStartupCommand in interface Service

Overrides:

getStartupCommand in class AbstractService

Returns:

empty by default.

allocatePorts

public void allocatePorts(int start,
 PortAllocBridge from)

Description copied from interface: NetworkPortRequestor

allocate the ports you need

Specified by:

allocatePorts in interface NetworkPortRequestor

getPortCount

public int getPortCount()

Description copied from interface: NetworkPortRequestor

Returns the number of ports needed by this service. User-defined ports for container http servers should not be counted, as those ports are required to be outside Vespa's port range.

Specified by:

getPortCount in interface NetworkPortRequestor

Returns:

The number of ports needed by the slobrok.

getHealthPort

public int getHealthPort()

Description copied from class: AbstractService

The service HTTP port for health status

Specified by:

getHealthPort in interface Service

Overrides:

getHealthPort in class AbstractService

Returns:

The port on which the state server should respond

getConnectionSpec

public String getConnectionSpec()

Returns:

The connection spec to this Slobrok