Skip to content
This repository has been archived by the owner on Oct 8, 2023. It is now read-only.

Latest commit

 

History

History
72 lines (47 loc) · 6.64 KB

DEPLOYMENT.md

File metadata and controls

72 lines (47 loc) · 6.64 KB
Raw

deployment portal is deprecated, please install it using the manual steps descript in the backend readme.

One Click Deployment

The Bing Maps Fleet Tracker Deployment Portal provides a one click deployment experience. You will need to have an active Azure subscription before you can deploy using the portal.

The deployment portal will prompt you for login, read your Azure Subscription information and then prompt you to enter some required information (e.g. your Bing Maps Subscription Key). It will then deploy the necessary resources to your Azure Subscription.

None of the data entered on the deployment portal is stored by Bing Maps Fleet Tracker. It is only used to configure your deployment.

Note: MSDN accounts cannot deploy to the West US region.

Creating a New Deployment

  1. Go to the Bing Maps Fleet Tracker Deployment Portal.

  2. Sign in with the account you have your Azure subscription on.

    If you have multiple Azure subscriptions tied to the same account, you will be able to specify which one to use while deploying.

  3. Enter a name for your deployment in the Deployment Name field. Availability of the name will be checked.

  4. You are required to enter a valid Bing Maps Subscription Key for usage in the map controls and geocoding. You can obtain a bing maps key by following this article.

  5. You will need to create a Microsoft Application which will be used for authentication in your portal.

    1. Go to Microsoft Application Portal
    2. Sign in with any Microsoft account
    3. Go to App Registration page and Click the Add new registration button
    4. Enter an application name of your choosing and select supported account types
    5. Choose web under Redirect URL and enter Redirect URL as "https://{YOUR_DEPLOYMENT_NAME}.azurewebsites.net/signin-oidc"
    6. Click Register button
    7. Click the application you just created and note down the Application Id field, as you will need to enter this in the Bing Maps Fleet Tracker Portal.
    8. Click the Certificates & secrets button on the left and click the + New client secret button. Give the secret a description, choose its expiration date and then click add. Note down the secret specified here, as you will need to enter this in the Bing Maps Fleet Tracker Portal.
    9. Return to the portal. Enter the Application Id and Appliation Secret that you noted down.

  6. You have the option to enter a SendGrid Api Key and Email if you wish to use the geofence email notifications feature. You can sign up for SendGrid keys from the SendGrid website.

  7. Click the Deploy button and wait until the deployment finishes. You may view the resources being allocated by clicking on the View in Azure link.

    Once the deployment finishes, you can go to your newly published website at "https://{YOUR_DEPLOYMENT_NAME}.azurewebsites.net/".

Mobile Client

The background tracking mobile client is available for Android as a downloadable APK at this link. You can also build the mobile client by following these steps. For the iOS mobile client, you will need to build your own from source by following the aforementioned steps.

Updating an Existing Deployment

This project is actively developed and maintained. You will receive update notifications on your administration portal informing you of the latest available version. You can also see the version information in your administration portal in the settings tab.

The update process does not reset your data and should be seamless. If your deployment is already up-to-date and working, redeploying will do nothing. If your deployment had previously failed to deploy any resource for any reason, running the update process will deploy any missing resources.

You can also use the deployment process to change any of the secrets you entered while deploying the portal originally (eg. Bing Maps Subscription Key). You will not be required to re-enter these secrets on update.

You can only use the update functionality with Bing Maps Fleet Tracker deployments that have been created through the deployment portal, if you build and deploy from Visual Studio, you will be unable to use this functionality.

  1. Go to the Bing Maps Fleet Tracker Deployment Portal.
  2. Sign in with the account you have your Azure subscription and deployment on. If you have multiple Azure subscriptions you will need to specify the one your deployment exists on.
  3. Enter the name of your deployment in the Deployment Name field. You should receive a prompt pointing you to an update link. Click on the update link.
  4. Any deployment secrets that you entered previously will be pre-populated with their old values. You may update values here if you wish.
  5. Click the Deploy button and wait until the deployment finishes. You may view the resources being allocated by clicking on the "View in Azure" link. Once the deployment finishes, you can go to your newly published website at "https://{YOUR_DEPLOYMENT_NAME}.azurewebsites.net/".

Troubleshooting a Failed Deployment

Occasionally the deployment script may fail for some reason or another. If that happens, you can view the detailed error in the Azure portal by following the Open in Azure link.

In most cases, rerunning the deployment using the [update functionality](#updating an existing deployment) will most likely fix the issue.

If the issue persists, please open a Github issue and include the error message from the azure portal.

Upgrading your azure resources to handle more assets

The deployment portal deploys the compute resources (Web App) and data resources (SQL Server) at the smallest possible tier to save you hosting cost.

The default deployed configuration (B1 Web App and S1 Sql Server) should be able to support approximately 150 tracked assets. The exact number of assets a deployment support depends on your use case.

If you want to track more than 150 assets, then you should upgrade your web app by Scaling Up (increasing the machine CPU and RAM resources) and Scaling Out (increasing the number of machines). Additionally, you will need to upgrade the Sql Server database by increasing the DTUs. This article shows you how to scale up azure resources.