com.morpheusdata.core

Interface CloudProvider

All Superinterfaces:

PluginProvider

public interface CloudProvider
extends PluginProvider

Provides a standard set of methods for interacting with cloud integrations or on-prem service providers. This includes syncing assets related to things like VirtualMachines or Containers for various cloud types. For integrating with actual provisioning a ProvisioningProvider is also available. TODO : Still a Work In Progress and not yet supported

Method Summary

Modifier and Type	Method and Description
ServiceResponse	deleteCloud(Cloud cloudInfo) Called when a Cloud From Morpheus is removed.
java.util.Collection<BackupProvider>	getAvailableBackupProviders() Grabs available backup providers related to the target Cloud Plugin.
java.util.Collection<ProvisioningProvider>	getAvailableProvisioningProviders() Grabs available provisioning providers related to the target Cloud Plugin.
java.util.Collection<ComputeServerType>	getComputeServerTypes() Grabs all ComputeServerType objects that this CloudProvider can represent during a sync or during a provision.
java.util.Collection<OptionType>	getOptionTypes() Provides a Collection of OptionType inputs that define the required input fields for defining a cloud integration
ProvisioningProvider	getProvisioningProvider(java.lang.String providerCode) Grabs the singleton instance of the provisioning provider based on the code defined in its implementation.
ServiceResponse	initializeCloud(Cloud cloudInfo) Called when a Cloud From Morpheus is first saved.
void	refresh(Cloud cloudInfo) Zones/Clouds are refreshed periodically by the Morpheus Environment.
void	refreshDaily(Cloud cloudInfo) Zones/Clouds are refreshed periodically by the Morpheus Environment.
ServiceResponse	validate(Cloud cloudInfo) Validates the submitted cloud information to make sure it is functioning correctly.

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 define the required input fields for defining a cloud integration

Returns:

Collection of OptionType

getComputeServerTypes

java.util.Collection<ComputeServerType> getComputeServerTypes()

Grabs all ComputeServerType objects that this CloudProvider can represent during a sync or during a provision.

Returns:

collection of ComputeServerType

getAvailableProvisioningProviders

java.util.Collection<ProvisioningProvider> getAvailableProvisioningProviders()

Grabs available provisioning providers related to the target Cloud Plugin. Some clouds have multiple provisioning providers or some clouds allow for service based providers on top like (Docker or Kubernetes).

Returns:

Collection of ProvisioningProvider

getAvailableBackupProviders

java.util.Collection<BackupProvider> getAvailableBackupProviders()

Grabs available backup providers related to the target Cloud Plugin.

Returns:

Collection of BackupProvider

getProvisioningProvider

ProvisioningProvider getProvisioningProvider(java.lang.String providerCode)

Grabs the singleton instance of the provisioning provider based on the code defined in its implementation. Typically Providers are singleton and instanced in the Plugin class

Parameters:

providerCode - String representation of the provider short code

Returns:

the ProvisioningProvider requested

validate

ServiceResponse validate(Cloud cloudInfo)

Validates the submitted cloud information to make sure it is functioning correctly. If a ServiceResponse is not marked as successful then the validation results will be bubbled up to the user.

Parameters:

cloudInfo - cloud

Returns:

ServiceResponse

initializeCloud

ServiceResponse initializeCloud(Cloud cloudInfo)

Called when a Cloud From Morpheus is first saved. This is a hook provided to take care of initial state assignment that may need to take place.

Parameters:

cloudInfo - instance of the cloud object that is being initialized.

Returns:

ServiceResponse

refresh

void refresh(Cloud cloudInfo)

Zones/Clouds are refreshed periodically by the Morpheus Environment. This includes things like caching of brownfield environments and resources such as Networks, Datastores, Resource Pools, etc.

Parameters:

cloudInfo - cloud

refreshDaily

void refreshDaily(Cloud cloudInfo)

Zones/Clouds are refreshed periodically by the Morpheus Environment. This includes things like caching of brownfield environments and resources such as Networks, Datastores, Resource Pools, etc. This represents the long term sync method that happens daily instead of every 5-10 minute cycle

Parameters:

cloudInfo - cloud

deleteCloud

ServiceResponse deleteCloud(Cloud cloudInfo)

Called when a Cloud From Morpheus is removed. This is a hook provided to take care of cleaning up any state.

Parameters:

cloudInfo - instance of the cloud object that is being removed.

Returns:

ServiceResponse