vm_from_template: Launch a vm from a template file and a extension file...

Description Usage Arguments

View source: R/azure_vm.R

Description

Launch a vm from a template file and a extension file provided Remember to set your working directory prior to use.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
vm_from_template(
  vmName,
  templateFile,
  shellScript,
  userPassword,
  adminPasswordOrKey = getOption("azuresshkey"),
  cpuSize = c("CPU-4GB", "CPU-7GB", "CPU-8GB", "CPU-14GB", "CPU-16GB", "GPU-56GB"),
  ubuntuOSVersion = c("18.04-LTS", "20_04-lts", "20_04-daily-lts-gen2"),
  adminUsername = getOption("azureuser"),
  webUsername = getOption("azureuser"),
  dnsNameForPublicIP = getOption("azureuser"),
  storageAccount = getOption("azurestor"),
  scriptContainer = getOption("azurecontainer"),
  storageKey = getOption("storageaccesskey"),
  resourceGroup = getOption("azurerg"),
  storageContainer = getOption("azurecontainer"),
  wait = TRUE
)

Arguments

vmName

the name of the VM, also used as a prefix on all related resources created during the deployment

templateFile

the file path to the template json used to deploy the VM and other resources

shellScript

the file path to the extension script file #' @param userPassword Rstudio password

adminPasswordOrKey

ssh public key used to access the vm through ssh

cpuSize

the size of the cpu, one of the following list ("CPU-4GB", "CPU-7GB", "CPU-8GB", "CPU-14GB", "CPU-16GB", "GPU-56GB")

ubuntuOSVersion

the Ubuntu version of the VM, one of the following list ("18.04-LTS", "20_04-lts", "20_04-daily-lts-gen2")

adminUsername

the Username used to login to the VM, default to the azureuser option

webUsername

the Username used to login to RStudio, default to the azureuser option

dnsNameForPublicIP

unique naming for the PublicIP resource, default to the azureuser option

storageAccount

the name of the storage account linked to the vm, default to azurestor option

scriptContainer

the name of the container where the extension script is hosted, default to azurecontainer option

storageKey

the access key to the storage account linked to the vm, default to storageaccesskey option

resourceGroup

the name of the resource group that will contain all resources created, default to azurerg option

storageContainer

the name of the container to be mounted to the vm

wait

if true, wait until the vm deployment is complete to return, default true


billspat/bayesrun documentation built on March 20, 2021, 11:15 p.m.