com.morpheusdata.core

Interface ProvisioningProvider

All Superinterfaces:

PluginProvider

public interface ProvisioningProvider
extends PluginProvider

Provides methods for interacting with the provisioning engine of Morpheus. This is akin to dealing with requests made from "Add Instance" or from Application Blueprints

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getMaxNetworks() Returns the maximum number of network interfaces that can be chosen when provisioning with this type
java.lang.String	getName() Returns the Name of the Provisioning Provider
java.util.Collection<OptionType>	getOptionTypes() Provides a Collection of OptionType inputs that need to be made available to various provisioning Wizards
java.lang.String	getProvisionTypeCode() Provides a unique code for the implemented provisioning provider (i.e.
ServiceResponse	getServerDetails(ComputeServer server) Method called at different phases to get the current status of a ComputeServer.
java.lang.Boolean	hasDatastores() Determines if this provision type has datastores that can be selected or not.
java.lang.Boolean	hasNetworks() Determines if this provision type has networks that can be selected or not.
ServiceResponse	removeWorkload(Workload workload, java.util.Map opts) This is the key method called to destroy / remove a workload.
ServiceResponse	resizeWorkload(Instance instance, Workload workload, ServicePlan plan, java.util.Map opts) Issues the remote calls to scale a workload element.
ServiceResponse	restartWorkload(Workload workload) Issues the remote calls to restart a workload element.
ServiceResponse<WorkloadResponse>	runWorkload(Workload workload, java.util.Map opts) This method is a key entry point in provisioning a workload.
ServiceResponse	startWorkload(Workload workload) Issues the remote calls necessary to start a workload element for running.
ServiceResponse	stopWorkload(Workload workload) Issues the remote calls necessary top stop a workload element from running.
ServiceResponse	validateWorkload(java.util.Map opts) Validates the provided provisioning options of a workload

Methods inherited from interface com.morpheusdata.core.PluginProvider

getMorpheusContext, getPlugin, getProviderCode, getProviderName, isPlugin

Method Detail

getOptionTypes

java.util.Collection<OptionType> getOptionTypes()

Provides a Collection of OptionType inputs that need to be made available to various provisioning Wizards

Returns:

Collection of OptionTypes

getProvisionTypeCode

java.lang.String getProvisionTypeCode()

Provides a unique code for the implemented provisioning provider (i.e. vmware, azure,ecs,etc.)

Returns:

unique String code

getName

java.lang.String getName()

Returns the Name of the Provisioning Provider

Returns:

Name

hasDatastores

java.lang.Boolean hasDatastores()

Determines if this provision type has datastores that can be selected or not.

Returns:

Boolean representation of whether or not this provision type has datastores

hasNetworks

java.lang.Boolean hasNetworks()

Determines if this provision type has networks that can be selected or not.

Returns:

Boolean representation of whether or not this provision type has datastores

getMaxNetworks

java.lang.Integer getMaxNetworks()

Returns the maximum number of network interfaces that can be chosen when provisioning with this type

Returns:

maximum number of networks or 0,null if unlimited.

validateWorkload

ServiceResponse validateWorkload(java.util.Map opts)

Validates the provided provisioning options of a workload

Parameters:

opts - options

Returns:

Response from API

runWorkload

ServiceResponse<WorkloadResponse> runWorkload(Workload workload,
                                              java.util.Map opts)

This method is a key entry point in provisioning a workload. This could be a vm, a container, or something else. Information associated with the passed Workload object is used to kick off the workload provision request

Parameters:

workload - the Workload object we intend to provision along with some of the associated data needed to determine how best to provision the workload

opts - additional configuration options that may have been passed during provisioning

Returns:

Response from API

stopWorkload

ServiceResponse stopWorkload(Workload workload)

Issues the remote calls necessary top stop a workload element from running.

Parameters:

workload - the Workload we want to shut down

Returns:

Response from API

startWorkload

ServiceResponse startWorkload(Workload workload)

Issues the remote calls necessary to start a workload element for running.

Parameters:

workload - the Workload we want to start up.

Returns:

Response from API

restartWorkload

ServiceResponse restartWorkload(Workload workload)

Issues the remote calls to restart a workload element. In some cases this is just a simple alias call to do a stop/start, however, in some cases cloud providers provide a direct restart call which may be preferred for speed.

Parameters:

workload - the Workload we want to restart.

Returns:

Response from API

removeWorkload

ServiceResponse removeWorkload(Workload workload,
                               java.util.Map opts)

This is the key method called to destroy / remove a workload. This should make the remote calls necessary to remove any assets associated with the workload.

Parameters:

workload - to remove

opts - map of options

Returns:

Response from API

getServerDetails

ServiceResponse getServerDetails(ComputeServer server)

Method called at different phases to get the current status of a ComputeServer.

Parameters:

server - to check status

Returns:

Response from API

resizeWorkload

ServiceResponse resizeWorkload(Instance instance,
                               Workload workload,
                               ServicePlan plan,
                               java.util.Map opts)

Issues the remote calls to scale a workload element.

Parameters:

instance - to resize

workload - to resize

plan - containing the new size

opts - additional options

Returns:

Response from API