Working with the Digital Ocean API

Create a DO account

If you don't already have one, create a DO account. By using this link, you'll start with $10 in credits (enough for >600 hours of computing on a 1 gb machine), and if you become a digital ocean customer we'll get some DO credits for us to offset our costs for testing. Thanks :)

Authenticate

The best way to authenticate is to generate a personal access token (https://cloud.digitalocean.com/settings/tokens/new) and save it in an environment variable called DO_PAT. If you don't do this, you'll be prompted to authenticate in your browser the first time you use analogsea.

SSH keys

analogsea allows you to interact with your droplet(s) from R via SSH. To do this you need to setup SSH keys with Digital Ocean. Make sure you provide Digitial Ocean your public key at https://cloud.digitalocean.com/ssh_keys. GitHub has some good advice on creating a new public key if you don't already have one: https://help.github.com/articles/generating-ssh-keys/.

Note that when using ssh, you'll likely get warnings like

The authenticity of host can't be established …

This is normal, don't be worried about this.

Note that if you want to connect over SSH to a droplet you have to create the droplet with an SSH key with the ssh_keys parameter. If you don't you can still interact with the droplet via the Digital Ocean API, but you can't access the droplet over SSH.

Create a droplet

droplet_create() will create a droplet on your account. You can run it as below without any inputs, and it will use sensible defaults:

You can set all of these options in your .Rprofile file like options(do_size = "8gb") for a default of 8 GB.

The name given to the droplet is picked at random from a list of 1000 random names.

You can of course set any of these parameters.

droplet_create()

You can also create many droplets at once:

droplets_create()

Get a droplet or droplets

Listing droplets can be done in singular or plural fashion. droplet() accepts a droplet ID, while droplets() list all droplets.

If you don't have any droplets yet, you will get an empty list running droplets(), and you of course can't pass in a droplet ID number to droplet() if you don't have any droplets yet.

library("analogsea")
droplets()
#> named list()

Create a droplet

droplet_create()
#> Waiting for create .................
#> <droplet>ErodedPosterity (31860257)
#>   IP:        162.243.139.148
#>   Status:    new
#>   Region:    San Francisco 1
#>   Image:     14.04.5 x64
#>   Size:      512mb
#>   Volumes:

After creating a droplet and running droplets() again, we see a list of our droplet(s)

(drops <- droplets())

Or we can pass in a droplet id to droplet(). There is a print.droplet() method that is used to print a brief summary of each droplet.

droplet(drops[[1]]$id)
#> <droplet>droppy (31859471)
#>   IP:        159.203.214.8
#>   Status:    active
#>   Region:    San Francisco 1
#>   Image:     14.04.5 x64
#>   Size:      512mb
#>   Volumes:

Get more detailed information on your droplet with summary(). This is a summary.droplet() method, that is just a little more verbose than the print.droplet() method

droplet(drops[[1]]$id) %>% summary
#> <droplet_detail>droppy (31859471)
#>   Status: active
#>   Region: San Francisco 1
#>   Image: 14.04.5 x64
#>   Size: 512mb ($0.00744 / hr)
#>   Estimated cost ($): 0.002
#>   Locked: FALSE
#>   Created at: 2016-11-11T18:50:51Z UTC
#>   Networks:
#>      v4: ip_address (159.203.214.8), netmask (255.255.240.0), gateway (159.203.208.1), type (public)
#>      v6: none
#>   Kernel:
#>   Snapshots:
#>   Backups:
#>   Tags:

Actions on droplets

Delete

You can delete a droplet with droplet_delete(). Be careful, as this completely removes your droplet. Backup your droplet or make an image if you want to use the droplet later.

droplet_create() %>%
  droplet_delete()
#> Waiting for create ..............................

Actions

List actions on a droplet, newer ones at the top. Here, list actions

drops[[1]] %>% droplet_actions()
#> [[1]]
#> <action> rename (166715389)
#>   Status: completed
#>   Resource: droplet 31859471
#>
#> [[2]]
#> <action> create (166715005)
#>   Status: completed
#>   Resource: droplet 31859471

Then rename and list actions again

drops[[1]] %>%
  droplet_rename(name = "droppy") %>%
  droplet_wait() %>%
  droplet_actions()
#> Waiting for rename ...
#> [[1]]
#> <action> rename (166715389)
#>   Status: completed
#>   Resource: droplet 31859471
#>
#> [[2]]
#> <action> create (166715005)
#>   Status: completed
#>   Resource: droplet 31859471

Snapshot

Making a snapshot of a droplet can be done with droplet_snapshot(). This action requires that you turn off the droplet first, then take the snapshot. First, create a droplet

d <- droplet_create(size = "2gb")

Then power off, and take a snapshot, which gives an action object describing that the snapshot is in progress.

d %>%
  droplet_power_off() %>%
  droplet_wait() %>%
  droplet_snapshot(name = "mynewsnap")
#> Waiting for power_off ...................................................
#> <action> snapshot (166715834)
#>   Status: in-progress
#>   Resource: droplet 31859617

Regions

The regions() function lists region slug names, full names, available sizes, whether the region is available at all, and features.

This helps you get an overview of region details, which you can select from when creating droplets

regions()
#>    slug            name
#> 1  nyc1      New York 1
#> 2  sfo1 San Francisco 1
#> 3  nyc2      New York 2
#> 4  ams2     Amsterdam 2
#> 5  sgp1     Singapore 1
#> 6  lon1        London 1
#> 7  nyc3      New York 3
#> 8  ams3     Amsterdam 3
#> 9  fra1     Frankfurt 1
#> 10 tor1       Toronto 1
#> 11 sfo2 San Francisco 2
#> 12 blr1     Bangalore 1
#>                                                                                          sizes
#> 1  512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 2                                            512mb, 1gb, 2gb, 4gb, 8gb, 16gb, 32gb, 48gb, 64gb
#> 3                                            512mb, 1gb, 2gb, 4gb, 8gb, 16gb, 32gb, 48gb, 64gb
#> 4                                            512mb, 1gb, 2gb, 4gb, 8gb, 16gb, 32gb, 48gb, 64gb
#> 5                                            512mb, 1gb, 2gb, 4gb, 8gb, 16gb, 32gb, 48gb, 64gb
#> 6  512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 7  512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 8                                            512mb, 1gb, 2gb, 4gb, 8gb, 16gb, 32gb, 48gb, 64gb
#> 9  512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 10 512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 11 512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#> 12 512mb, 1gb, 2gb, 4gb, 8gb, 16gb, m-16gb, 32gb, m-32gb, 48gb, m-64gb, 64gb, m-128gb, m-224gb
#>    available                                             features
#> 1       TRUE private_networking, backups, ipv6, metadata, storage
#> 2       TRUE          private_networking, backups, ipv6, metadata
#> 3       TRUE          private_networking, backups, ipv6, metadata
#> 4       TRUE          private_networking, backups, ipv6, metadata
#> 5       TRUE          private_networking, backups, ipv6, metadata
#> 6       TRUE          private_networking, backups, ipv6, metadata
#> 7       TRUE          private_networking, backups, ipv6, metadata
#> 8       TRUE          private_networking, backups, ipv6, metadata
#> 9       TRUE private_networking, backups, ipv6, metadata, storage
#> 10      TRUE          private_networking, backups, ipv6, metadata
#> 11      TRUE private_networking, backups, ipv6, metadata, storage
#> 12      TRUE          private_networking, backups, ipv6, metadata

Sizes

The sizes() function lists size slug names, associated memory, vcpus, disk size, prices, and regions where the size is available.

This helps you get an overview of sizes, which you can select from when creating droplets

sizes()
#>       slug memory vcpus disk transfer price_monthly price_hourly available
#> 1    512mb    512     1   20        1             5      0.00744      TRUE
#> 2      1gb   1024     1   30        2            10      0.01488      TRUE
#> 3      2gb   2048     2   40        3            20      0.02976      TRUE
#> 4      4gb   4096     2   60        4            40      0.05952      TRUE
#> 5      8gb   8192     4   80        5            80      0.11905      TRUE
#> 6     16gb  16384     8  160        6           160      0.23810      TRUE
#> 7   m-16gb  16384     2   30        6           120      0.17857      TRUE
#> 8     32gb  32768    12  320        7           320      0.47619      TRUE
#> 9   m-32gb  32768     4   90        7           240      0.35714      TRUE
#> 10    48gb  49152    16  480        8           480      0.71429      TRUE
#> 11  m-64gb  65536     8  200        8           480      0.71429      TRUE
#> 12    64gb  65536    20  640        9           640      0.95238      TRUE
#> 13 m-128gb 131072    16  340        9           960      1.42857      TRUE
#> 14 m-224gb 229376    32  500       10          1680      2.50000      TRUE
#>                                                                          region
#> 1  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 2  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 3  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 4  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 5  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 6  ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 7                                      blr1, fra1, lon1, nyc1, nyc3, sfo2, tor1
#> 8        ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 9                                      blr1, fra1, lon1, nyc1, nyc3, sfo2, tor1
#> 10       ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 11                                     blr1, fra1, lon1, nyc1, nyc3, sfo2, tor1
#> 12       ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sgp1, tor1
#> 13                                     blr1, fra1, lon1, nyc1, nyc3, sfo2, tor1
#> 14                                     blr1, fra1, lon1, nyc1, nyc3, sfo2, tor1

Keys

We suggest you use SSH keys to interact with Digital Ocean from analogsea. There are a variety of functions for working with SSH keys.

List your keys

keys()
#> $`Scott Chamberlain`
#> <key> Scott Chamberlain (89103)
#>   Fingerprint: 6b:2e:f6:be:e7:b4:58:0e:2a:a0:23:7e:16:ac:fc:17
#>
#> $`Scott Chamberlain`
#> <key> Scott Chamberlain (700950)
#>   Fingerprint: ba:5e:64:f4:c7:53:d1:5c:22:24:f0:84:12:f4:7b:03

Get a key by id

key(keys()[[1]]$id)
#> <key> Scott Chamberlain (89103)
#>   Fingerprint: 6b:2e:f6:be:e7:b4:58:0e:2a:a0:23:7e:16:ac:fc:17

You can also create a key, rename a key, and delete a key

k <- key_create("key", readLines("~/.ssh/id_rsa.pub"))
k <- key_rename(k, "new_name")
key_delete(k)

Note that if you're on Windows you may experience some problems connecting over SSH. We hope to resolve these problems as soon as possible.

Images

The images() function can list both your own private images, and public images. If public=FALSE only your private images are listed, while if public=TRUE, your private images are listed along with publicly avaialble images.

images(page = 4, per_page = 5)
#> $`24 x64`
#> <image> 24 x64 (18027532)
#>   Slug:    fedora-24-x64 [public]
#>   Distro:  Fedora
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1
#>
#> $`GitLab 8.9.4 CE on 14.04`
#> <image> GitLab 8.9.4 CE on 14.04 (18285322)
#>   Slug:    gitlab [public]
#>   Distro:  Ubuntu
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1
#>
#> $`7.11 x32`
#> <image> 7.11 x32 (18290419)
#>   Slug:     [public]
#>   Distro:  Debian
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1
#>
#> $`7.2 x64`
#> <image> 7.2 x64 (18325354)
#>   Slug:     [public]
#>   Distro:  CentOS
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1
#>
#> $`10.3 zfs`
#> <image> 10.3 zfs (18818640)
#>   Slug:    freebsd-10-3-x64-zfs [public]
#>   Distro:  FreeBSD
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1

You can also do various actions on images. First, you can pass in an image ID to the image() function to get an image object.

img <- images(per_page = 1)[[1]]
image(img$id)
#> <image> 1192.2.0 (beta) (20666772)
#>   Slug:    coreos-beta [public]
#>   Distro:  CoreOS
#>   Regions: nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1

You can rename an image

img %>% image_rename(name = "analog")

You can transfer an image to another region

image(img$id) %>% image_transfer(region = "sfo1")

Domains

You can use domain names for your droplets on Digital Ocean. analogsea has a variety of functions to work with domain names.

List domain names

domains()
#> $fishbaseapi.info
#> <domain> fishbaseapi.info
#>   ttl: 1800

Create a new domain name

dom <- paste0(sample(words, 1), ".info")
domain_create(name = dom, ip_address = "127.0.0.1")
#> <domain> leptometer.info
#>   ttl:

Get a single domain by domain name

domain(dom)
#> <domain> leptometer.info
#>   ttl: 1800

Create a domain record, list records and delete the one just created

domain(dom) %>%
  domain_record_create(type = "TXT", name = "hello", data = "world")
#> <domain_record> 19285352
#>   TXT world
records <- domain(dom) %>% domain_records()
domain_record_delete(records[[length(records)]])

List records

domain(dom) %>% domain_records()
#> [[1]]
#> <domain_record> 19285348
#>   NS ns1.digitalocean.com
#>
#> [[2]]
#> <domain_record> 19285349
#>   NS ns2.digitalocean.com
#>
#> [[3]]
#> <domain_record> 19285350
#>   NS ns3.digitalocean.com
#>
#> [[4]]
#> <domain_record> 19285351
#>   A 127.0.0.1

Delete a domain name, returns nothing if delete is successful

domain(dom) %>% domain_delete()