From 8660f9286fbe40cf01f908875a4ed3123aa5bb4f Mon Sep 17 00:00:00 2001 From: manjularajamani <100277950+manjularajamani@users.noreply.github.com> Date: Tue, 30 Jan 2024 12:52:40 +0530 Subject: [PATCH 1/4] feat: Add instructions for Deploying Node-RED on ACI --- docs/getting-started/azure.md | 181 +++++++++++++++++++++++++++++++++- 1 file changed, 178 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/azure.md b/docs/getting-started/azure.md index 44d7f515..fe55d4be 100644 --- a/docs/getting-started/azure.md +++ b/docs/getting-started/azure.md @@ -7,8 +7,21 @@ redirect_from: - /docs/platforms/azure --- -This guide takes you through the steps to get Node-RED running on an Azure -Virtual Machine instance. +This guide takes you through the steps to get Node-RED running on an Microsoft Azure +environment. + +There are two approaches: + +1. Running on the Azure Virtual Machine instance (VM) +2. Running on Azure Container instance (ACI) + +#### Prerequisites +- Before starting, ensure that you have an Azure account with an active subscription +- Log in to the [Azure console](https://portal.azure.com/) + +*Note:* As of Node-RED 1.0, the repository on **Docker Hub** was renamed to `nodered/node-red`. + +## Running on Azure Virtual Machine instance #### Create the base image @@ -47,7 +60,10 @@ previous stage. Once logged in you need to install node.js and Node-RED - curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - + curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash + source ~/.bashrc + nvm install --lts + nvm install 14.17.6 sudo apt-get install -y nodejs build-essential sudo npm install -g --unsafe-perm node-red @@ -67,3 +83,162 @@ can use pm2: pm2 startup *Note:* this final command will prompt you to run a further command - make sure you do as it says. + +## Running on Azure Container Instance + +#### Create Azure Container Registry +1. Create a [Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-portal?tabs=azure-cli) and store the Node-RED image in the container registry + + +2. Log in to a registry using Azure CLI + +``` + az login + az acr login --name myregistry + docker login myregistry.azurecr.io +``` + +#### Create an Azure file share + Run the following script to create a storage account to host the file share, and the share itself. The storage account name must be globally unique, so the script adds a random value to the base string. + +``` +## Change these parameters as needed + RESOURCE_GROUP=myResourceGroup + STORAGE_ACCOUNT_NAME=storageaccount$RANDOM + LOCATION=eastus + FILE_SHARE_NAME=node-red-share + IMAGE=myregistry.azurecr.io/node-red:latest + ACI_NAME=node-red + +## Create the storage account with the parameters + az storage account create \ + --resource-group $RESOURCE_GROUP \ + --name $STORAGE_ACCOUNT_NAME \ + --location $LOCATION \ + --sku Standard_LRS + +## Create the file share + az storage share create \ + --name $FILE_SHARE_NAME \ + --account-name $STORAGE_ACCOUNT_NAME +``` + +#### Get storage credentials +To mount an Azure file share as a volume in Azure Container Instances, you need three values: the storage account name, the share name, and the storage access key. + +- **Storage account name** - If you used the preceding script, the storage account name was stored in the `$STORAGE_ACCOUNT_NAME` variable. To see the account name, type + +``` +echo $STORAGE_ACCOUNT_NAME +``` + +- **Share name** - This value is already known (defined as node-red-share in the preceding script). To see the file share name +``` +echo $FILE_SHARE_NAME +``` +- **Storage account key** - This value can be found using the following command + +``` +STORAGE_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) + +echo $STORAGE_KEY +``` + +#### Deploy Node-Red on container instance and mount volume - CLI +To mount an Azure file share as a volume in a container by using the Azure CLI, specify the share and volume mount point when you create the container with az container create. If you followed the previous steps, you can mount the share you created earlier by using the following command to create a container + +``` +az container create \ + --resource-group $RESOURCE_GROUP \ + --name $ACI_NAME \ + --image $IMAGE \ + --dns-name-label unique-acidemo-label \ + --ports 1880 \ + --azure-file-volume-account-name $STORAGE_ACCOUNT_NAME \ + --azure-file-volume-account-key $STORAGE_KEY \ + --azure-file-volume-share-name $FILE_SHARE_NAME \ + --azure-file-volume-mount-path /aci/logs/ + +``` +The `--dns-name-label` value must be unique within the Azure region where you create the container instance + +#### Using Bash +You can combine the aforementioned commands and execute the bash script to create an Azure Container Instance for Node-RED. +Here is the bash script for Node-RED + +``` +#!/usr/bin/env bash + +RESOURCE_GROUP=myResourceGroup +STORAGE_ACCOUNT_NAME=storageaccount$RANDOM +LOCATION=eastus +FILE_SHARE_NAME=node-red-share +IMAGE=myregistry.azurecr.io/node-red:latest +ACI_NAME=node-red + +# Azure Login +az login + +# ACR Login +az acr login --name myregistry.azurecr.io + +# Check if Resource Group exists +if az group show --name $RESOURCE_GROUP &>/dev/null; then + echo "Resource group '$RESOURCE_GROUP' already exists." +else + # Creating Resource Group + az group create --name $RESOURCE_GROUP --location $LOCATION + echo "Resource group '$RESOURCE_GROUP' created." +fi + +# Check if Storage Account exists +if az storage account show --name $STORAGE_ACCOUNT_NAME --resource-group $RESOURCE_GROUP &>/dev/null; then + echo "Storage account '$STORAGE_ACCOUNT_NAME' already exists." +else + # Creating Storage Account + az storage account create \ + --resource-group $RESOURCE_GROUP \ + --name $STORAGE_ACCOUNT_NAME \ + --location $LOCATION \ + --sku Standard_LRS + echo "Storage account '$STORAGE_ACCOUNT_NAME' created." +fi + +# Creating File Share +az storage share create \ + --name $FILE_SHARE_NAME \ + --account-name $STORAGE_ACCOUNT_NAME + +echo "File share '$FILE_SHARE_NAME' created." + +echo $STORAGE_ACCOUNT_NAME + +STORAGE_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) +echo $STORAGE_KEY + +# Creating Azure Container Instance for Node-Red +if az container show --resource-group $RESOURCE_GROUP --name $ACI_NAME &>/dev/null; then + echo "Azure Container Instance '$ACI_NAME' already exists." +else + # Creating Azure Container Instance for Node-Red + az container create \ + --resource-group $RESOURCE_GROUP \ + --name $ACI_NAME \ + --image $IMAGE \ + --dns-name-label unique-acidemo-label \ + --ports 1880 \ + --azure-file-volume-account-name $STORAGE_ACCOUNT_NAME \ + --azure-file-volume-account-key $STORAGE_KEY \ + --azure-file-volume-share-name $FILE_SHARE_NAME \ + --azure-file-volume-mount-path /aci/logs/ + + echo "Azure Container Instance '$ACI_NAME' created." +fi +``` +After executing the file, you can make the application accessible by using the `public IP` or `Fully Qualified Domain Name (FQDN)` of the Azure Container Instance. + +![Alt text](node-red.png) + +Additionally, you can verify whether the file share is properly mounted using Azure Container Instances (ACI) + +![Alt text](aci.png) \ No newline at end of file From 3c9828c5ef2785be17422c2eb978199189a7327e Mon Sep 17 00:00:00 2001 From: Manjula Rajamani <100277950+manjularajamani@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:02:45 +0530 Subject: [PATCH 2/4] Update azure.md --- docs/getting-started/azure.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/azure.md b/docs/getting-started/azure.md index fe55d4be..c2e92e11 100644 --- a/docs/getting-started/azure.md +++ b/docs/getting-started/azure.md @@ -237,8 +237,9 @@ fi ``` After executing the file, you can make the application accessible by using the `public IP` or `Fully Qualified Domain Name (FQDN)` of the Azure Container Instance. -![Alt text](node-red.png) +![node-red](https://github.com/manjularajamani/node-red.github.io/assets/100277950/f146edad-21f6-4879-a46c-6d400c41ef6a) + Additionally, you can verify whether the file share is properly mounted using Azure Container Instances (ACI) -![Alt text](aci.png) \ No newline at end of file +![aci](https://github.com/manjularajamani/node-red.github.io/assets/100277950/4060dca2-c1c7-4bb1-96ee-3dd371547aea) From 861f4e8d400bc2248cf54f3f4c7a7b6c9113ea04 Mon Sep 17 00:00:00 2001 From: manjularajamani <100277950+manjularajamani@users.noreply.github.com> Date: Tue, 26 Mar 2024 22:45:56 +0530 Subject: [PATCH 3/4] feat: Add error handling --- docs/getting-started/azure.md | 64 ++++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 24 deletions(-) diff --git a/docs/getting-started/azure.md b/docs/getting-started/azure.md index c2e92e11..d7e60dbc 100644 --- a/docs/getting-started/azure.md +++ b/docs/getting-started/azure.md @@ -103,7 +103,7 @@ can use pm2: ``` ## Change these parameters as needed - RESOURCE_GROUP=myResourceGroup + RESOURCE_GROUP=MyResourceGroup STORAGE_ACCOUNT_NAME=storageaccount$RANDOM LOCATION=eastus FILE_SHARE_NAME=node-red-share @@ -118,9 +118,13 @@ can use pm2: --sku Standard_LRS ## Create the file share - az storage share create \ - --name $FILE_SHARE_NAME \ - --account-name $STORAGE_ACCOUNT_NAME + az storage share-rm create \ + --resource-group $RESOURCE_GROUP \ + --storage-account $STORAGE_ACCOUNT_NAME \ + --name $FILE_SHARE_NAME \ + --quota 1024 \ + --enabled-protocols SMB \ + --output table ``` #### Get storage credentials @@ -139,9 +143,9 @@ echo $FILE_SHARE_NAME - **Storage account key** - This value can be found using the following command ``` -STORAGE_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) +STORAGE_ACCOUNT_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) -echo $STORAGE_KEY +echo $STORAGE_ACCOUNT_KEY ``` #### Deploy Node-Red on container instance and mount volume - CLI @@ -155,7 +159,7 @@ az container create \ --dns-name-label unique-acidemo-label \ --ports 1880 \ --azure-file-volume-account-name $STORAGE_ACCOUNT_NAME \ - --azure-file-volume-account-key $STORAGE_KEY \ + --azure-file-volume-account-key $STORAGE_ACCOUNT_KEY \ --azure-file-volume-share-name $FILE_SHARE_NAME \ --azure-file-volume-mount-path /aci/logs/ @@ -169,25 +173,31 @@ Here is the bash script for Node-RED ``` #!/usr/bin/env bash -RESOURCE_GROUP=myResourceGroup +RESOURCE_GROUP=MyResourceGroup STORAGE_ACCOUNT_NAME=storageaccount$RANDOM LOCATION=eastus FILE_SHARE_NAME=node-red-share -IMAGE=myregistry.azurecr.io/node-red:latest +IMAGE=testingregistrydevops.azurecr.io/node-red:latest ACI_NAME=node-red +# Function to handle errors +handle_error() { + echo "Error: $1" >&2 + exit 1 +} + # Azure Login -az login +az login || handle_error "Failed to login to Azure" # ACR Login -az acr login --name myregistry.azurecr.io +az acr login --name testingregistrydevops.azurecr.io || handle_error "Failed to login to ACR" # Check if Resource Group exists if az group show --name $RESOURCE_GROUP &>/dev/null; then echo "Resource group '$RESOURCE_GROUP' already exists." else # Creating Resource Group - az group create --name $RESOURCE_GROUP --location $LOCATION + az group create --name $RESOURCE_GROUP --location $LOCATION || handle_error "Failed to create resource group" echo "Resource group '$RESOURCE_GROUP' created." fi @@ -200,21 +210,27 @@ else --resource-group $RESOURCE_GROUP \ --name $STORAGE_ACCOUNT_NAME \ --location $LOCATION \ - --sku Standard_LRS + --sku Standard_LRS || handle_error "Failed to create storage account" echo "Storage account '$STORAGE_ACCOUNT_NAME' created." fi # Creating File Share -az storage share create \ +echo "Creating file share '$FILE_SHARE_NAME'..." +if az storage share-rm create \ + --resource-group $RESOURCE_GROUP \ + --storage-account $STORAGE_ACCOUNT_NAME \ --name $FILE_SHARE_NAME \ - --account-name $STORAGE_ACCOUNT_NAME - -echo "File share '$FILE_SHARE_NAME' created." - -echo $STORAGE_ACCOUNT_NAME + --quota 1024 \ + --enabled-protocols SMB \ + --output table &>/dev/null; then + echo "File share '$FILE_SHARE_NAME' created successfully." +else + handle_error "Failed to create file share '$FILE_SHARE_NAME'" +fi -STORAGE_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) -echo $STORAGE_KEY +# Fetch Storage Account Key +STORAGE_ACCOUNT_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv) +echo $STORAGE_ACCOUNT_KEY # Creating Azure Container Instance for Node-Red if az container show --resource-group $RESOURCE_GROUP --name $ACI_NAME &>/dev/null; then @@ -228,9 +244,9 @@ else --dns-name-label unique-acidemo-label \ --ports 1880 \ --azure-file-volume-account-name $STORAGE_ACCOUNT_NAME \ - --azure-file-volume-account-key $STORAGE_KEY \ + --azure-file-volume-account-key $STORAGE_ACCOUNT_KEY \ --azure-file-volume-share-name $FILE_SHARE_NAME \ - --azure-file-volume-mount-path /aci/logs/ + --azure-file-volume-mount-path /aci/logs/ || handle_error "Failed to create container instance" echo "Azure Container Instance '$ACI_NAME' created." fi @@ -242,4 +258,4 @@ After executing the file, you can make the application accessible by using the ` Additionally, you can verify whether the file share is properly mounted using Azure Container Instances (ACI) -![aci](https://github.com/manjularajamani/node-red.github.io/assets/100277950/4060dca2-c1c7-4bb1-96ee-3dd371547aea) +![alt text]() \ No newline at end of file From f1bd45be008fa1d7fa12c572ea4fc0ce5f932e6d Mon Sep 17 00:00:00 2001 From: Manjula Rajamani <100277950+manjularajamani@users.noreply.github.com> Date: Wed, 27 Mar 2024 11:00:16 +0530 Subject: [PATCH 4/4] Update azure.md --- docs/getting-started/azure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/azure.md b/docs/getting-started/azure.md index d7e60dbc..b25cdbbd 100644 --- a/docs/getting-started/azure.md +++ b/docs/getting-started/azure.md @@ -258,4 +258,4 @@ After executing the file, you can make the application accessible by using the ` Additionally, you can verify whether the file share is properly mounted using Azure Container Instances (ACI) -![alt text]() \ No newline at end of file +![aci ](https://github.com/manjularajamani/node-red.github.io/assets/100277950/29ace90a-e509-415d-9fca-621a3db9e437)