Onboard Azure DevOps to DevOps Change Velocity — Service Catalog
Create, connect, discover, and configure your Azure DevOps instance using the ServiceNow Service Catalog.
Before you begin
Role required: sn_devops.admin or sn_devops.tool_owner
Procedure
-
Navigate to All > Service Catalog > Catalog Definitions > Maintain Items and search for DevOps.
Note:You can also access the service catalog from Employee Center or Service portal.
- From the DevOps catalog items, select and activate DevOps App Onboarding and DevOps Tool Onboarding.
- After activating, select DevOps Tool Onboarding and select Try it.
-
In the DevOps Tool Onboarding form, enter the tool details:
Field Description Tool name Name for your Azure DevOps integration. Tool integration Select Azure DevOps. Connect to an organization or project Select from the list. - Connect an organization: Connect directly at your Azure DevOps organization level. All the projects within the organization will be discovered, and you can choose to configure multiple projects within the organization.
- Connect a project: Connect directly at the project level.
Tool URL Azure DevOps organization URL (for example, https://dev.azure.com/<your organization>) or the Azure DevOps project URL (for example, https://dev.azure.com/<your organization>/<your project>).
Credential type Type of credential, Basic Auth or OAuth 2.0. Basic Auth
- Enter your ADO instance username.
- Enter the Personal access token (PAT) or password for your Azure DevOps instance.Note:
When you generate a Personal access token (PAT) for Azure DevOps, you must select the scopes to authorize if you aren’t granting complete access. See Azure DevOps PAT scopes for DevOps.
OAuth 2.0
Pre-requisites:In the Tool credential field, select an OAuth 2.0 tool credential record.Note:Only records that are not in use and configured for ADO can be selected as an existing credential record.Do you wish to configure webhook for this tool? Option to enable configuring webhooks automatically for Azure DevOps. Select to enable. Note:This option isn’t available if you're connecting at the organization level. You can configure webhooks from the tool records page.Integration username This field is available only when the option to configure webhook is selected. Enter the username for the DevOps Integration User account.
Note:- The step to enter the integration user name and password is required to configure only when DevOps Config is installed or the This property decides whether to create a Generic Connection on configure operation for Azure DevOps property is enabled. If this step is not required, webhooks are configured using token-based authentication.
- When DevOps Config is installed or the Generic Connection on configure operation for Azure DevOps property is enabled, you can regenerate token (auto-configure with new token) from the workspace UI only, which will update integration user password. When DevOps Config is not installed, token can be regenerated from both the workspace and classic UI for token based authentication. Re-generate your token periodically for better security.
Integration user password This field is available only when the option to configure webhook is selected. Enter the password for the DevOps Integration User account.
Note:- The step to enter the integration user name and password is required to configure only when DevOps Config is installed or the This property decides whether to create a Generic Connection on configure operation for Azure DevOps property is enabled. If this step is not required, webhooks are configured using token-based authentication.
- When DevOps Config is installed or the Generic Connection on configure operation for Azure DevOps property is enabled, you can regenerate token (auto-configure with new token) from the workspace UI only, which will update integration user password. When DevOps Config is not installed, token can be regenerated from both the workspace and classic UI for token based authentication. Re-generate your token periodically for better security.
Use MID Server Optional. Select MID Server for an on-premises tool that is attached to a MID Server. Application is automatically set to DevOps and capability is set to REST. For a list of all the permissions required on the credentials for connecting to Azure DevOps, see Azure DevOps permissions in Permissions required for DevOps tools.
-
Select Order Now.
A request is created. When the request is approved:
- If connecting to an organization, the tool is created.
- If connecting to a project, the tool is created, connected, and project objects like plans, repositories, and pipelines are discovered.
- From the DevOps catalog items, select DevOps App Onboarding.
- Select Try It.
-
In the DevOps App Onboarding form, enter the details:
Are you creating a new app or adding to an existing one? Select from the options whether to create a new app or use an existing app. App Enter the name for the app that you're creating or using. Onboarding pipelines Enter the connected Azure DevOps tool name. Pipelines Select the pipelines for which you want to import historical data. Artifact repositories Select the artifacts for which you want to import historical data. Onboarding repositories Enter the connected Azure DevOps tool name. Import from and Import to Select the dates for which you want to import the pipeline and artifact data. By default, the last 30 days are selected. You can choose to import data for a maximum of 90 days. Repositories Select the repositories for which you want to import historical data. Import from and Import to Select the dates for which you want to import the Repositories data. By default, the last 30 days are selected. You can choose to import data for a maximum of 90 days. Onboarding plans Enter the connected Azure DevOps tool name. Plans Select the plans for which you want to import historical data. Import from and Import to Select the dates for which you want to import the Plans data. By default, the last 30 days are selected. You can choose to import data for a maximum of 90 days. -
Select Order Now.
A request is created. When the request is approved, the plans, repositories, artifacts, and pipeline objects are associated to the app record and webhooks are configured for real-time tracking. Historical data is imported for the selected items. The Track field is automatically enabled for imported plans, repositories, and pipelines.