droplet_ssh: Remotely execute ssh code, upload & download files.

In analogsea: Interface to 'Digital Ocean'

Remotely execute ssh code, upload & download files.

Description

Assumes that you have ssh & scp installed, and password-less login set up on the droplet.

Usage

droplet_ssh(
  droplet,
  ...,
  user = "root",
  keyfile = NULL,
  ssh_passwd = NULL,
  verbose = FALSE
)

droplet_upload(
  droplet,
  local,
  remote,
  user = "root",
  keyfile = NULL,
  ssh_passwd = NULL,
  verbose = FALSE
)

droplet_download(
  droplet,
  remote,
  local,
  user = "root",
  keyfile = NULL,
  ssh_passwd = NULL,
  verbose = FALSE,
  overwrite = FALSE
)

Arguments

droplet	A droplet, or something that can be coerced to a droplet by as.droplet.
...	Shell commands to run. Multiple commands are combined with && so that execution will halt after the first failure.
user	User name. Defaults to "root".
keyfile	Optional private key file.
ssh_passwd	Optional passphrase or callback function for authentication. Refer to the ssh::ssh_connect documentation for more details.
verbose	If TRUE, will print command before executing it.
local, remote	Local and remote paths.
overwrite	If TRUE, then overwrite destination files if they already exist.

Details

Uploads and downloads are recursive, so if you specify a directory, everything inside the directory will also be downloaded.

With the chang to package ssh, we create ssh session objects (C pointers) internally, and cache them, then look them up in the cache based on combination of user and IP address. That is, there's separate sessions for each user for the same IP address.

ssh sessions are cleaned up at the end of your R session.

Value

On success, the droplet (invisibly). On failure, throws an error.

Examples

## Not run: 
d <- droplet_create() %>% droplet_wait()

# Upgrade system packages
d %>%
  droplet_ssh("apt-get update") %>%
  droplet_ssh("sudo apt-get upgrade -y --force-yes") %>%
  droplet_ssh("apt-get autoremove -y")

# Install R
d %>%
  droplet_ssh("apt-get install r-base-core r-base-dev --yes --force-yes")

# Upload and download files -------------------------------------------------

tmp <- tempfile()
saveRDS(mtcars, tmp)
d %>% droplet_upload(tmp, ".")
d %>% droplet_ssh("ls")

tmp2 <- tempdir()
d %>% droplet_download(basename(tmp), tmp2)
mtcars2 <- readRDS(file.path(tmp2, basename(tmp)))

stopifnot(all.equal(mtcars, mtcars2))


## another upload/download example
tmp <- tempfile(fileext = ".txt")
writeLines("foo bar", tmp)
readLines(tmp)
d %>% droplet_upload(tmp, ".")
d %>% droplet_ssh("ls")

tmp2 <- tempdir()
unlink(tmp)
d %>% droplet_download(basename(tmp), tmp2)
readLines(file.path(tmp2, basename(tmp)))

## End(Not run)

analogsea documentation built on May 9, 2022, 1:05 a.m.