Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 6.17 KB

README.md

File metadata and controls

116 lines (79 loc) · 6.17 KB
Raw

Deploy Resources for Accessibility Insights Service

The deployment script will create Azure resource group and deploy Azure services under it.

Before you start, make sure you have the Owner permission, or Contributor with User Access Administrator permission for the subscription. To learn more about how to give role based access, check Manage access to Azure resources using RBAC and the Azure portal.

Prerequisites

  • Docker Desktop
  • Azure CLI
  • Postman

Follow instructions from https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest to install Azure CLI.

When installing Azure CLI for Windows Subsystem for Linux (WSL) select a Linux corresponding distribution used with WSL.

Deployment

1. Clone the repository and build the solution

  • Follow this README to clone the repository and build the solution

  • Select the deployment directory

    cd accessibility-insights-service/packages/resource-deployment

2. Prepare deployment

3. Login to Azure

  • Login to Azure account and set the current active subscription:

    az login
az account set --subscription <Name or ID of subscription>

4. Create Azure Active Directory application registration

  • Sign in to the Azure portal and create new application registration in Azure Active Directory with provided default settings
  • Add a client secret
  • Use Application (client) ID and secret value in a service deployment

5. Allow Azure Batch API to access the subscription

  • Follow this documentation to allow Batch to access the subscription
  • Sign in to the Azure portal and assign Contributor role to Microsoft Azure Batch enterprise application on subscription. Follow this documentation to assign Azure role.

6. Deploy service

  • Run below script with required parameters as specified in a script's help to deploy Azure resources and binaries

    ./dist/scripts/install-parallel.sh -r "<resource group>" -s "<subscription name or ID>" -l "<Azure region>" -e "<environment (dev|ppe|prod)>" -o "<organization name>" -p "<publisher email>" -c "<client ID>" -t "<client secret>" -v "<release version>" -b "<Azure Batch object ID>"

Submit scan request

1. Create Azure Active Directory client registration

  • Create Azure Active Directory client registration to use with Postman client
  • Sign in to the Azure portal and create new application registration in Azure Active Directory with provided default settings
  • Add a client secret
  • Use Application (client) ID and secret value in Postman client

2. Postman setup

  • Open Postman
  • Import all files from Postman directory
  • Open "Accessibility Insights Service" environment
  • Set Current Values as follows:
    • client_id - Azure AD client registration ID
    • client_secret - Azure AD client registration secret
    • base_url and call_back_url - API Management service Gateway URL (Copy from Azure portal service overview page)
    • target_client_id - Azure AD application registration ID
    • token_url - https://login.microsoftonline.com/<Azure AD (tenant) ID>/oauth2/v2.0/token
    • auth_url - https://login.microsoftonline.com/<Azure AD (tenant) ID>/oauth2/v2.0/authorize
  • Save environment

3. Submit scan request

  • Select "Accessibility Insights Service" environment as active from the top right drop down menu
  • Open "Accessibility Insights Service" collection
  • Select "Get access token" and send request. Token is valid for 24 hours
  • Select "Submit accessibility scan" and send request
  • Select "Get scan status" and send request
  • Monitor scan status by re-submitting request

Service health

The service health can be monitored via deployed Azure Shared dashboard.

Documentation for the Azure dashboard can be found here

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.