Skip to content

DigitalOcean plugin for Waldur Site Agent

This plugin integrates Waldur Site Agent with DigitalOcean using the python-digitalocean SDK. It provisions droplets based on marketplace orders and exposes droplet metadata back to Waldur.

Configuration

Example configuration for an offering:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
offerings:
  - name: DigitalOcean VM
    waldur_api_url: https://waldur.example.com/api/
    waldur_api_token: <TOKEN>
    waldur_offering_uuid: <OFFERING_UUID>
    backend_type: digitalocean
    order_processing_backend: digitalocean
    reporting_backend: digitalocean
    membership_sync_backend: digitalocean
    backend_settings:
      token: <DIGITALOCEAN_API_TOKEN>
      default_region: ams3
      default_image: ubuntu-22-04-x64
      default_size: s-1vcpu-1gb
      default_user_data: |
        #cloud-config
        packages:
          - htop
      default_tags:
        - waldur
    backend_components:
      cpu:
        measured_unit: Cores
        unit_factor: 1
        accounting_type: limit
        label: CPU
      ram:
        measured_unit: MiB
        unit_factor: 1
        accounting_type: limit
        label: RAM
      disk:
        measured_unit: MiB
        unit_factor: 1
        accounting_type: limit
        label: Disk

Resource attributes

You can override defaults per resource using attributes passed from Waldur:

  • region or backend_region_id
  • image or backend_image_id
  • size or backend_size_id
  • user_data or cloud_init
  • ssh_key_id, ssh_key_fingerprint, or ssh_public_key
  • ssh_key_name (optional when using ssh_public_key)
  • tags (list of strings)

If ssh_public_key is provided, the plugin will create the key in DigitalOcean if it does not already exist.

Resize via limits

To resize droplets from UPDATE orders, you can provide a size mapping:

1
2
3
4
5
6
backend_settings:
  size_mapping:
    s-1vcpu-1gb:
      cpu: 1
      ram: 1024
      disk: 25

When limits match an entry in size_mapping, the droplet will be resized to the corresponding size_slug.