distribglm (version 0.4.1)

do_provision_glm_api: Deploy GLM API on Digital Ocean (DO)

Description

Deploy GLM API on Digital Ocean (DO)

Usage

do_provision_glm_api(
  ...,
  application_name = "glm",
  port = 8000,
  example = FALSE,
  r_packages = NULL,
  github_r_packages = NULL
)
do_remove_glm_api(droplet, application_name = "glm", ...)
do_deploy_glm_api(
  ...,
  application_name = "glm",
  port = 8000,
  docs = TRUE,
  forward = TRUE,
  example = FALSE
)
do_deploy_glm_api_only(
  droplet,
  application_name = "glm",
  port = 8000,
  docs = TRUE,
  forward = TRUE,
  ...
)
do_list_plumber(droplet, ...)

Arguments

...

arguments to pass to do_provision from plumberDeploy package

application_name

Name of application, passed to path argument of do_deploy_api function from plumberDeploy package

port

port to deploy on Digital Ocean

example

If TRUE, will deploy an example API named hello to the server on port 8000.

r_packages

Additional R packages to install, using install.packages

github_r_packages

Additional R packages to install from GitHub, using remotes::install_github

droplet

droplet to deploy on

docs

enable the Swagger interface, passed to do_deploy_api function from plumberDeploy package

forward

setup requests targeting the root URL on the server to point to this application, passed to do_deploy_api function from plumberDeploy package

Value

A droplet instance

Examples

# NOT RUN {
  d = analogsea::droplets()
  if (length(d) == 0) {
    droplet = NULL
  } else {
    droplet = d[[1]]
  }
  droplet = do_provision_glm_api(droplet = droplet, region = "sfo3")
  droplet = do_deploy_glm_api_only(droplet)
  ip = droplet$network$v4[[1]]$ip_address
  applet_url = paste0("http://", ip, "/", droplet$application_name,
                      "/__docs__/")
  if (interactive()) {
    browseURL(applet_url)
  }
# }