Skip to content

Latest commit

 

History

History
executable file
·
101 lines (66 loc) · 4.53 KB

README.md

File metadata and controls

executable file
·
101 lines (66 loc) · 4.53 KB

CycleCloud ARM

Deploying Azure CycleCloud into a subscription using an Azure Resource Manager template

Quick Start: Deploy Azure CycleCloud

Introduction

  • This repo contains an ARM template for deploying Azure CycleCloud.
  • There are two ARM templates in here:
    • deploy-vnet.json creates a VNET with 3 separate subnets:
      1. cycle: The subnet in which the CycleCloud server is started in.
      2. compute: A /22 subnet for the HPC clusters
      3. user: The subnet for creating login nodes.
    • deploy-cyclecloud.json provisions and sets up the CycleCloud application server.
  • If you have a VNET (or subnets) that you want to deploy in, you can skip the the Vnet deployment.

Pre-requisites

  1. Azure CLI 2.0 installed and configured with an Azure subscription

  2. Service principal in your Azure Active Directory

  • Using the AZ CLI:
    $ az ad sp create-for-rbac --name CycleCloudApp --years 1
    {
        "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "displayName": "CycleCloudApp",
        "name": "http://CycleCloudApp",
        "password": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "tenant": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  • Save the output -- you'll need the appId, password and tenant id.
  1. Azure subscription ID.
  • The easiest way to retrieve it:
        $ az account list -o table

Using the templates

  • Clone the repo

      $ git clone https://github.com/CycleCloudCommunity/cyclecloud_arm.git

Create a Resource Group and VNET

  • If you already have a VNET in a Resource Group that you would like to deploy CycleCloud in, skip this step and use the VNET and resource group in the next section

  • Create a resource group in the region of your choice:

      $ az group create --name "{RESOURCE-GROUP}" --location "{REGION}"

  • Build the Virtual Network and subnets. By default the vnet is named cyclevnet .

      $ az group deployment create --name "vnet_deployment" --resource-group "{RESOURCE-GROUP}" --template-file deploy-vnet.json --parameters params-vnet.json

Deploy CycleCloud

  1. Edit params-cyclecloud.json, updating these parameters:
  • rsaPublicKey: The public key staged into the Cycle and Jumpbox VMs
  • The follwing attributes from the service principal: applicationSecret, tenantId, applicationId

  1. Deploy the CycleCloud server:

     $ az group deployment create --name "cyclecloud_deployment" --resource-group "{RESOURCE-GROUP}" --template-file deploy-cyclecloud.json --parameters params-cyclecloud.json

The deployment process runs the installation script cyclecloud_install.py as a custom extension script, which installs and sets up CycleCloud.

Login to the CycleCloud application server

  • To connect to the CycleCloud webserver, first retrieve the FQDN of the CycleServer VM from the Azure Portal, then browse to https://cycleserverfqdn/. The installation uses a self-signed SSL certificate which may show up with a warning in your browser. You could also reach the webserver through the VM's public IP address:

      az vm list-ip-addresses -o table -g ${RESOURCE-GROUP}

  • The first time you access the webserver, the Azure CycleCloud End User License Agreement will be displayed, and you will be prompted to accept it.

  • After that, you will be prompted to create an admin user for the application server. For consistency, it is recommended that you use cycleadmin as the username.

Initialize the CycleCloud CLI

  • The CycleCloud CLI is required for importing custom cluster templates and projects, and is installed in the Azure CycleCLoud VM.

  • To use the CLI, SSH into the VM with the private key that matches the public key supplied in the parameter file. The SSH user is cycleadmin by default unless you modified that in the params-cyclecloud.json file.

  • Once on the CycleCloud server, test the CycleCloud CLI

      $ cyclecloud locker list

Check installation logs

  • The Cycle Server installation logs are located in the /var/lib/waagent/custom-script/download/0 directory.

Create your cluster

  • Build your cluster in Cycle by using the provided templates