Package org.apache.hadoop.yarn.api

Interface CsiAdaptorPlugin

All Superinterfaces:

CsiAdaptorProtocol

public interface CsiAdaptorPlugin
extends CsiAdaptorProtocol

csi-adaptor is a plugin, user can provide customized implementation according to this interface. NM will init and load this into a NM aux service, and it can run multiple csi-adaptor servers. User needs to implement all the methods defined in CsiAdaptorProtocol, and plus the methods in this interface.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDriverName()	Returns the driver name of the csi-driver this adaptor works with.
void	init(java.lang.String driverName, org.apache.hadoop.conf.Configuration conf)	A csi-adaptor implementation can init its state within this function.

Methods inherited from interface org.apache.hadoop.yarn.api.CsiAdaptorProtocol

getPluginInfo, nodePublishVolume, nodeUnpublishVolume, validateVolumeCapacity

Method Detail

init

void init(java.lang.String driverName,
          org.apache.hadoop.conf.Configuration conf)
   throws YarnException

A csi-adaptor implementation can init its state within this function. Configuration is available so the implementation can retrieve some customized configuration from yarn-site.xml.

Parameters:

driverName - the name of the csi-driver.

conf - configuration.

Throws:

YarnException - exceptions from yarn servers.

getDriverName

java.lang.String getDriverName()

Returns the driver name of the csi-driver this adaptor works with. The name should be consistent on all the places being used, ideally it should come from the value when init is done.

Returns:

the name of the csi-driver that this adaptor works with.