Skip to content

Deployment Guide

Jump to bottom
Yashraj Mungale edited this page Oct 14, 2020 · 11 revisions

Prerequisites

To begin, you will need:

  • An Azure subscription where you can create the following kinds of resources:

  • App service

  • App service plan

  • Bot channels registration

  • Azure storage account

  • Application Insights

  • A group chat in Microsoft Teams with group of members. (You can add and remove members later!)

  • A copy of the Scrum app GitHub repo

Step 1: Register Azure AD applications

Register one Azure AD applications in your tenant's directory

  1. Log in to the Azure Portal for your subscription, and go to the "App registrations" blade here.

  2. Click on "New registration", and create an Azure AD application.

    • Name: The name of your Teams app - if you are following the template for a default deployment, we recommend "Scrum Status Bot".
    • Supported account types: Select "Accounts in any organizational directory (Any Azure AD directory - Multitenant)"
    • Leave the "Redirect URI" field blank.

  3. Click on the "Register" button.

  4. When the app is registered, you'll be taken to the app's "Overview" page. Copy the Application (client) ID; we will need it later. Verify that the "Supported account types" is set to Multiple organizations.

  5. On the side rail in the Manage section, navigate to the "Certificates & secrets" section. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select an expiry time (As per the requirement). Click "Add".

  1. Once the client secret is created, copy its Value; we will need it later.

At this point you have 2 unique values:

  • Application (client) ID for the bot
  • Client secret for the bot
  • Directory (tenant) ID

We recommend that you copy these values into a text file, using an application like Notepad. We will need these values later.

Step 2: Deploy to your Azure subscription

  1. Click on the "Deploy to Azure" button below.

    Deploy to Azure

  2. When prompted, log in to your Azure subscription.

  3. Azure will create a "Custom deployment" based on the ARM template and ask you to fill in the template parameters.

  4. Select a subscription and resource group.

  • We recommend creating a new resource group.

  • The resource group location MUST be in a datacenter that supports: Application Insights; Storage Account. For an up-to-date list, click here, and select a region where the following services are available:

  • Application Insights

  • Storage Account

  1. Enter a "Base Resource Name", which the template uses to generate names for the other resources.
  • The app service names [Base Resource Name] must be available(not taken); otherwise, the deployment will fail with a Conflict error.
  • Remember the base resource name that you selected. We will need it later.

  1. Fill in the various IDs in the template:

  2. Bot Client ID: The application (client) ID of the Microsoft Teams Bot app

  3. Bot Client Secret: The client secret of the Microsoft Teams Bot app

  4. Tenant Id: The tenant ID of Bot

Make sure that the values are copied as-is, with no extra spaces. The template checks that GUIDs are exactly 36 characters.

  1. If you wish to change the app name, description, and icon from the defaults, modify the corresponding template parameters.

  2. Click on "Review+Create" to start the deployment.It will validate the parameters provided in the template .Once the validation is passed,click on create to start the deployment.

  1. Wait for the deployment to finish. You can check the progress of the deployment from the "Notifications" pane of the Azure Portal. It can take more than 10 minutes for the deployment to finish.

  2. After the deployment is successful, open the deployment details blade and click on "Outputs" option visible in the navigation menu on the left and note down the mentioned values below. We will need them later in the deployment process.

  • BotId - This is the Microsoft Application ID for the Scrum Status Bot.

  • AppDomain - This is the base domain for the Scrum Status Bot.

Step 3: Create the Teams app packages

Create Teams app package: to install in group chat.

  1. Open the Manifest\manifest.json file in a text editor.

  2. Change the placeholder fields in the manifest to values appropriate for your organization.

  • developer.name (What's this?)
  • developer.websiteUrl
  • developer.privacyUrl
  • developer.termsOfUseUrl

  1. Change the <<botId>> placeholder to your Azure AD application's ID from above. This is the same GUID that you entered in the template under "Bot Client ID".

  2. In the "validDomains" section, replace the <<appDomain>> with your Bot App Service's domain. This will be [BaseResourceName].azurewebsites.net. For example if you chose "scrumstatusbot" as the base name, change the placeholder to scrumstatusbot.azurewebsites.net. Please ensure to not add https:// in valid domains.

  1. Create a ZIP package with the manifest.json,color.png, and outline.png. The two image files are the icons for your app in Teams.
  • Name this package ScrumStatus.zip.
  • Make sure that the 3 files are the top level of the ZIP package, with no nested folders.

Step 4: Run the apps in Microsoft Teams

  1. If your tenant has sideloading apps enabled, you can install your app by following the instructions here

  2. You can also upload it to your tenant's app catalog, so that it can be available for everyone in your tenant to install. See here

  3. Install the scrum status bot (the ScrumStatusBot.zip package) to your group chat.

Troubleshooting

Please see our Troubleshooting page.

Clone this wiki locally