salt.cloud.clouds.digital_ocean¶

DigitalOcean Cloud Module¶

The DigitalOcean cloud module is used to control access to the DigitalOcean VPS system.

Note

Due to Digital Ocean deprecating its original API, this salt-cloud driver for Digital Ocean will be deprecated in Salt Beryllium. The digital_ocean_v2 driver that is currently available on all 2015.5.x releases will be used instead. Starting in Beryllium, the digital_ocean_v2.py driver will be renamed to digital_ocean.py and this driver will be removed. Please convert any original digital_ocean provider configs to use the new digital_ocean_v2 provider configs.

Use of this module only requires the api_key parameter to be set. Set up the cloud configuration at /etc/salt/cloud.providers or /etc/salt/cloud.providers.d/digital_ocean.conf:

my-digital-ocean-config:
  # DigitalOcean account keys
  client_key: wFGEwgregeqw3435gDger
  api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
  provider: digital_ocean

depends:	requests

salt.cloud.clouds.digital_ocean.avail_images(call=None)¶: Return a list of the images that are on the provider

salt.cloud.clouds.digital_ocean.avail_locations(call=None)¶: Return a dict of all available VM locations on the cloud provider with relevant data

salt.cloud.clouds.digital_ocean.avail_sizes(call=None)¶: Return a list of the image sizes that are on the provider

salt.cloud.clouds.digital_ocean.create(vm_)¶: Create a single VM from a data dict

salt.cloud.clouds.digital_ocean.create_node(args)¶: Create a node

salt.cloud.clouds.digital_ocean.destroy(name, call=None)¶

Destroy a node. Will check termination protection and warn if enabled.

CLI Example:

salt-cloud --destroy mymachine

salt.cloud.clouds.digital_ocean.get_configured_provider()¶: Return the first configured instance.

salt.cloud.clouds.digital_ocean.get_image(vm_)¶: Return the image object to use

salt.cloud.clouds.digital_ocean.get_keyid(keyname)¶: Return the ID of the keyname

salt.cloud.clouds.digital_ocean.get_location(vm_)¶: Return the VM's location

salt.cloud.clouds.digital_ocean.get_size(vm_)¶: Return the VM's size. Used by create_node().

salt.cloud.clouds.digital_ocean.list_keypairs(call=None)¶: Return a dict of all available VM locations on the cloud provider with relevant data

salt.cloud.clouds.digital_ocean.list_nodes(call=None)¶: Return a list of the VMs that are on the provider

salt.cloud.clouds.digital_ocean.list_nodes_full(call=None)¶: Return a list of the VMs that are on the provider

salt.cloud.clouds.digital_ocean.list_nodes_select(call=None)¶: Return a list of the VMs that are on the provider, with select fields

salt.cloud.clouds.digital_ocean.query(method='droplets', droplet_id=None, command=None, args=None)¶: Make a web call to DigitalOcean

salt.cloud.clouds.digital_ocean.script(vm_)¶: Return the script deployment object

salt.cloud.clouds.digital_ocean.show_instance(name, call=None)¶: Show the details from DigitalOcean concerning a droplet

salt.cloud.clouds.digital_ocean.show_keypair(kwargs=None, call=None)¶: Show the details of an SSH keypair