upmind/provision-provider-servers

This provision category contains common functions used in provisioning flows for servers on various popular cloud platforms

v4.0.1 2024-05-16 11:32 UTC

Requires

• upmind/linode-api: ^1.2
• upmind/provision-provider-base: ^3.4

GPL-3.0

• Harry Lewis

README

This provision category contains the common functions used in provisioning flows for servers on various popular cloud platforms.

• Installation
• Usage
  • Quick-start
• Supported Providers
• Functions
• Changelog
• Contributing
• Credits
• License
• Upmind

Installation

composer require upmind/provision-provider-servers

Usage

This library makes use of upmind/provision-provider-base primitives which we suggest you familiarize yourself with by reading the usage section in the README.

Quick-start

The easiest way to see this provision category in action and to develop/test changes is to install it in upmind/provision-workbench.

Alternatively you can start using it for your business immediately with Upmind.com - the ultimate web hosting billing and management solution.

If you wish to develop a new Provider, please refer to the WORKFLOW guide.

Supported Providers

The following providers are currently implemented:

• Linode
• SolusVM v1
• Virtualizor
• Virtuozzo Hybrid Server 7
• OnApp

Functions

Function	Parameters	Return Data	Description
create()	CreateParams	ServerInfoResult	Create and boot a new server
getInfo()	ServerIdentifierParams	ServerInfoResult	Get information about a server such as its label, current state (running/rebooting etc), image (e.g., ubuntu), size and region
getConnection()	ServerIdentifierParams	ConnectionResult	Get a command to connect to a server
changeRootPassword()	ChangeRootPasswordParams	ServerInfoResult	Update the root password used to SSH into a server
resize()	ResizeParams	ServerInfoResult	Redeploy an existing server with a different resource allocation
reinstall()	ReinstallParams	ServerInfoResult	Reinstall (wipe/reset) an existing server server using a particular image
reboot()	ServerIdentifierParams	ServerInfoResult	Reboot (shutdown then power-on) a running server
shutdown()	ServerIdentifierParams	ServerInfoResult	Shut down a running server
powerOn()	ServerIdentifierParams	ServerInfoResult	Boot a powered-off server
suspend()	ServerIdentifierParams	ServerInfoResult	Suspend a server
unsuspend()	ServerIdentifierParams	ServerInfoResult	Unsuspend a server
attachRecoveryIso()	ServerIdentifierParams	ServerInfoResult	Attach recovery ISO
detachRecoveryIso()	ServerIdentifierParams	ServerInfoResult	Detach recovery ISO
terminate()	ServerIdentifierParams	EmptyResult	Terminate (delete) an existing server

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Harry Lewis
• Codeline
• All Contributors

License

GNU General Public License version 3 (GPLv3). Please see License File for more information.

Upmind

Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com