io.continual.flowcontrol.controlapi

Interface ConfigTransferService

All Known Implementing Classes:

ConfigFetchService, DummyConfigTransfer

public interface ConfigTransferService

A config transfer service prepares a job's configuration for transfer onto the working compute nodes. The service is expected to be used in conjunction with node setup code that understands the key/value map returned by the deploy call and can use it to retrieve the job configuration later. For example, using a k8s controller, the working pods may have an init container that pulls configuration using key/values pushed to the environment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfigTransferService.ServiceException

Method Summary

Modifier and Type	Method and Description
Map<String,String>	deployConfiguration(FlowControlJob job) Prepare a configuration to be pulled into a running deployment and return a fetch key
InputStream	fetch(String byKey) Fetch a configuration based on a key generated by the deployConfiguration call

Method Detail

deployConfiguration

Map<String,String> deployConfiguration(FlowControlJob job)
                                throws ConfigTransferService.ServiceException

Prepare a configuration to be pulled into a running deployment and return a fetch key

Parameters:

job -

Returns:

a key to fetch the config

Throws:

ConfigTransferService.ServiceException

fetch

InputStream fetch(String byKey)
           throws ConfigTransferService.ServiceException

Fetch a configuration based on a key generated by the deployConfiguration call

Parameters:

byKey -

Returns:

an input stream, or null if not found/invalid

Throws:

ConfigTransferService.ServiceException