Troubleshooting Rimo3 resource deployment in Azure

Troubleshoot issues with the Rimo3 Azure Marketplace offering, resource deployment and Gateway installation.

Deploying Rimo3 resources into your Azure tenant happens in three phases:

  1. Configure the Rimo3 Marketplace offering (MPO)
  2. Create the resources (deployment script)
  3. Install & register the Gateway Agent (extension script)

Configure the Rimo3 Marketplace offering (MPO)

In the first phase of deployment you will configure the Rimo3 MPO and choose which resources to create new and for which you will use existing resources.

Registration Key not validated as a valid JWT token

  • If the registration key fails validation check that the last thing copied to the clipboard was the Registration key by either pasting it into a text editor or inspecting it in the clipboard history (Windows key + V).
  • If the Registration Key appears to be correct but still fails validation you can return the the Onboarding questionnaire and copy a new Registration key.

You maybe prompted to confirm generating a new Registration key and that this might impact an in progress deployment.  In this case it is okay to generate the new Regarstration Key.

MPO fails validation because the storage account already exists.

  • Ensure that you created a new storage account and didn't use the placeholder storage account name.

Resource validation fails due to an Azure Policy

The Rimo3 MPO is designed to be a flexible as possible but sometimes policies can block some of the default configurations of the resources it creates, especially in highly secured environments.  Policies can block resources for any number of reason, the error should give more details of the resource being blocked and why. 

In most cases temporarily relaxing the policy for the Rimo3 resource group will allow the MPO to complete and deploy the resources, after with the deployed resources can be further configured to comply with the required policies and the policy itself reinstated for the Rimo3 resource group.

Create the resources (deployment script)

Once you have configured the MPO and click on create the deployment script executes and Azure starts creating and configuring the Rimo3 resources.

Resource creation taking longer than expected

Typically resources are created within 5 minutes but can sometime take longer.  As long as the deployment in Azure is not reporting any errors then the deployment should complete, even if it takes a little longer than expected.

Registration Key fails validation

Previously the MPO validated that the Registration Key was a valid JWT, now the deployment script is validating the Registration Key against the Rimo3 Web host.  If validation fails it is typically because the Registration Key:

  • Has expired, it is valid for 4 hours rom when it is copied.
  • Has already been used to successfully register a Gateway Agent, this typically happens when redeploying resources. 

In both cases the easiest thing to do is return to step 2 of the Onboarding Wizard, copy a new Registration key and complete the MPO again.

Install & register the Gateway Agent (extension script)

Once the Rimo3 Gateway virtual machine (VM) has been created an extension script will run to install and configure the Gateway Agent.  The extension script reports errors in the following location in the Azure Portal:

  • Browse to the Gateway VM
  • In the left-hand menu expand Settings and select Extensions + applications
  • Click on GWScriptExtention
  • On the right-hand fly in click on View detailed status

Registration Key fails validation

By this time the Registration key will have already been successfully validated, if it fails validation at this point it is likely that a new Registration Key has been generated before the deployment completed, in which case the deployment process will need to be rerun, albeit some resources, such as the Resource Group, Vnet & Subnet, and Storage Account can be reused.

Gateway installation is taking longer than expected

The gateway can take up to 20 minutes to download, install, and register.  A number of factors can impact the time taken, such as performance of the Azure CDN or VM performance.  As long as there are no errors in the extension script log the installation should complete, even if it takes a little longer than expected.