Skip to content

Deployment guide

Jump to bottom
Pranav Krishnamurthy edited this page Aug 2, 2019 · 24 revisions

Prerequisites

To begin, you will need:

  • An Azure subscription where you can create the following kinds of resources:
    • An app service
    • An app service plan
    • Bot channels registration
    • Azure storage account
    • Azure search
    • QnAMaker cognitive service
    • Application Insights
    • Valid UPN's list of the individuals who will need access to configuration web app.
  • A copy of the FAQ++ app GitHub repo (https://github.com/OfficeDev/microsoft-teams-faqplusplus-app)

Step 1: Register FAQ++ Configuration Microsoft Azure AD application

Register two Azure AD applications in your tenant's directory: one for the FAQ++ Bot, and another for the configuration app. Prior to having any apps registered, ensure to have a resource group properly created.

  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.

    1. Name: The name of your configuration application (i.e. "Configuration App")
    2. Supported account types: Select "Account in this organizational directory only"

    image1

    1. Copy the Client ID and Tenant ID values which will be used in the deployment. It is recommended that you copy these values into a text file, using an application like Notepad. The ClientID is the application ID of the configuration web app. The TenantID is the tenant ID of your Azure subscription.

    image2

    1. Ensure that the for the Configuration Web App, the id_tokens authorization is enabled. To do so, after you have registered the configuration web app through app registrations, navigate to the tab that reads "Authentication" and in the middle pane scroll down to the point where the text reads "To enable the implicit grant flow, select the tokens you would like to be issued by the authorization endpoint:". Click on the check box that reads "ID tokens".

    image3

    1. Repeat steps 1 through 4 to register the bot application. However, there are a few differences that are to be noted here:
      1. The application should be registered to "Accounts in any organizational directory", which means that the bot application supports multiple tenants.
      2. No authorization is required for the bot application (i.e. no need for using the id_tokens)

At this point you have 4 unique values:

  • Application (client) ID for the bot
  • Client secret for the bot
  • Application (client) ID for the configuration
  • Tenant ID, which is the same for both apps

Step 2: Deploy to your Azure subscription

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

Deploy to Azure

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

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

  3. 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; Azure Search; and QnA Maker. For an up-to-date list, click here, and select a region where the following services are available:
      • Application Insights
      • QnA Maker
      • Azure Search

  4. Enter a "Base Resource Name", which the template uses to generate names for the other resources.

    • The app service names [Base Resource Name] and [Base Resource Name]-config must be available. For example, if you select contosofaqplusplus as the base name, the names contosofaqplusplus and contosofaqplusplus-config must be free; otherwise, the deployment will fail with a Conflict error.
    • Remember the base resource name that you selected. We will need it later.

  5. Fill in the various IDs in the template:

    1. Bot Client ID: The application (client) ID of the Microsoft Teams Bot app
    2. Bot Client Secret: The client secret of the Microsoft Teams Bot app
    3. Config App Client Id: The application (client) ID of the configuration app
    4. Tenant Id: The tenant ID above

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

  6. Fill in the "Config Admin UPN List", which is a semicolon-delimited list of users who will be allowed to access the configuration app.

  1. Agree to the Azure terms and conditions by clicking on the check box "I agree to the terms and conditions stated above" located at the bottom of the page.
  2. Click on "Purchase" to start the deployment.
  3. 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.

Step 3: Finish setting up the configuration app

  1. Note the location of the configuration app that you deployed, which is https://[BaseResourceName]-config.azurewebsites.net. For example, if you chose "contosofaqplusplus" as the base name, the configuration app will be at https://contosofaqplusplus-config.azurewebsites.net

Step 4: Create the Teams app packages

For the FAQ++ App Template, we recommend creating two Teams app packages because the FAQ++ Bot is being used in both a personal scope and team scope. Therefore, there should be one Teams app package that contains the bot only. Another Teams app package would contain the messaging extension and bot - and that Teams app package would be sideloaded into the SME team.

Clone this wiki locally