[Docs] No clear documentation for deploying Bot Framework VA template using Azure DevOps

[pravinambekar]

Hello There,
I am looking for a way to configure Virtual Assistant template enabled QnAMaker bot resources to be created using Azure DevOps.
My Primary understanding is that we need to use ARM deployment stage in pipeline to trigger resource creation.

But i am not sure how we are going to execute deploy.ps1 (PowerShell script) that enables KB creation once resources gets created.

Another way i was thinking of using Azure PowerShell to execute Deploy.ps1 but that seems not working.

Is there any document/sample that can direct me about how can I deploy QnAMaker based Bot in Azure using DevOps.

In current implementation from local PowerShell we are successfully deploying all the resources and are able to create and configure QnA knowledgebase through script execution

PS: we are using Linux platform for hosting all the resources

Any help greatly appreciated :)

@lauren-mills

[lauren-mills]

Hi, internally we execute the deploy.ps1 script from a PowerShell task in ADO.

We use the following task (yaml) to run the deploy.ps1 script:

steps:
- powershell: |
   Invoke-WebRequest -Uri https://aka.ms/installazurecliwindows -OutFile .\AzureCLI.msi; Start-Process msiexec.exe -Wait -ArgumentList '/I AzureCLI.msi /quiet'
   
   az login --service-principal --username "<your-service-principal>" --password "<your-service-principal-pw>" --tenant "<your-azure-tenant>"
   
   ./Deployment/Scripts/deploy.ps1 -name $(VirtualAssistantBotName) -location $(Location) -languages "en-us" -appId $(VirtualAssistantBotAppId) -appPassword $(VirtualAssistantBotAppPassword) -createLuisAuthoring -luisAuthoringRegion $(LuisAuthoringRegion) -logFolder "Deployment"
  errorActionPreference: continue
  pwsh: true
  workingDirectory: 'samples/csharp/assistants/virtual-assistant/VirtualAssistantSample/'
  displayName: 'Deploy: VA'
  continueOnError: true

You also need to install the BF CLI tools in a prior step, just as you do locally.

[pravinambekar]

Thank you @lauren-mills for your response,
I am investigating the part where i need to install BF CLI tools, has that to be configured in Pipeline stages ?
Is this the repo to refer -> https://github.com/microsoft/botframework-cli ?
It would be great t know if there is any document/sample i can refer to understand how complete pipeline works for this case.

Just a small update here: I have separate codebase & separate pipeline for Deploying Bot App, for above case i need just Infrastructure deployment and KB creation through this pipeline.

[lauren-mills]

We have steps here to set up a basic pipeline: https://microsoft.github.io/botframework-solutions/solution-accelerators/tutorials/enable-continuous-deployment/1-intro/

I've noticed that some of the installation steps are out of date, but the prerequisites are the same as steps 6 and 7 here: https://microsoft.github.io/botframework-solutions/virtual-assistant/tutorials/create-assistant/csharp/2-download-and-install/

@Batta32 - Can you help update this documentation with the correct CLI installation steps?

[Batta32]

Sure @lauren-mills! We will update the mentioned document and check that everything is consistent.

We will let you know the updates here!

[Batta32]

Hi @lauren-mills, we can confirm that the document enable-continuous-deployment/3-configure-pipeline/ was updated in the PR #3729 replacing the outdated installation steps to the new ones just like the rest of documents of the solution-accelerators section (see document).

We already added a new step to install botskills during the set up of a basic pipeline just as you mentioned.

Let us know if we can help you with anything else 😊.

[pravinambekar]

Hello @Batta32, @lauren-mills Thank you for updating the document.
Though i have few concerns about steps mentioned there:

1. In Release, i see Display env vars step on Stage agent, why this step is included for ? just to check if release pipeline is working ?
   if so, shall we keep it as it is or we should remove it in actual run and what this script contains ?

2. In Configure pipeline to update bot service step we have to configure variables required for updating cognitive model,
   Few of the fields like AzureTenant, AzureUserName, AzurePassword can be configured in advance (before executing script) but how to set values for
   i) KBID ii) HostName iii) Endpoint Key, as subsequent tasks are about login and installing bot framework and updating congnitivemodel
   Isn't these fields should be result of one of PowerShell script which create Kb's and update variable information ?

Thank you in advance for understanding the concern.

[Batta32]

Hi @pravinambekar, we will be collecting the information to reply your questions. We will back to you soon 😊.