-
Notifications
You must be signed in to change notification settings - Fork 524
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support deployment to Azure Container Apps with ACA extension (#3794)
- Loading branch information
1 parent
64a084f
commit eff6906
Showing
5 changed files
with
130 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See LICENSE.md in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import * as semver from 'semver'; | ||
| import * as vscode from 'vscode'; | ||
| import { DialogResponses, IActionContext, nonNullProp, UserCancelledError } from '@microsoft/vscode-azext-utils'; | ||
| import { RemoteTagTreeItem } from '../../../tree/registries/RemoteTagTreeItem'; | ||
| import { localize } from '../../../localize'; | ||
| import { ext } from '../../../extensionVariables'; | ||
| import { registryExpectedContextValues } from '../../../tree/registries/registryContextValues'; | ||
| import { RegistryTreeItemBase } from '../../../tree/registries/RegistryTreeItemBase'; | ||
| import { AzureRegistryTreeItem } from '../../../tree/registries/azure/AzureRegistryTreeItem'; | ||
| import { DockerHubNamespaceTreeItem } from '../../../tree/registries/dockerHub/DockerHubNamespaceTreeItem'; | ||
| import { addImageTaggingTelemetry } from '../../images/tagImage'; | ||
| import { parseDockerLikeImageName } from '../../../runtimes/docker/clients/DockerClientBase/parseDockerLikeImageName'; | ||
|
|
||
| const acaExtensionId = 'ms-azuretools.vscode-azurecontainerapps'; | ||
| const minimumAcaExtensionVersion = '0.4.0'; | ||
|
|
||
| // The interface of the command options passed to the Azure Container Apps extension's deployImageToAca command | ||
| interface DeployImageToAcaOptionsContract { | ||
| image: string; | ||
| registryName: string; | ||
| username?: string; | ||
| secret?: string; | ||
| } | ||
|
|
||
| export async function deployImageToAca(context: IActionContext, node?: RemoteTagTreeItem): Promise<void> { | ||
| // Assert installation of the ACA extension | ||
| if (!isAcaExtensionInstalled()) { | ||
| // This will always throw a `UserCancelledError` but with the appropriate step name | ||
| // based on user choice about installation | ||
| await openAcaInstallPage(context); | ||
| } | ||
|
|
||
| if (!node) { | ||
| node = await ext.registriesTree.showTreeItemPicker<RemoteTagTreeItem>([registryExpectedContextValues.dockerHub.tag, registryExpectedContextValues.dockerV2.tag], context); | ||
| } | ||
|
|
||
| const commandOptions: Partial<DeployImageToAcaOptionsContract> = { | ||
| image: node.fullTag, | ||
| }; | ||
|
|
||
| addImageTaggingTelemetry(context, commandOptions.image, ''); | ||
|
|
||
| const registry: RegistryTreeItemBase = node.parent.parent; | ||
| if (registry instanceof AzureRegistryTreeItem) { | ||
| // No additional work to do; ACA can handle this on its own | ||
| } else { | ||
| const { auth } = await registry.getDockerCliCredentials() as { auth?: { username?: string, password?: string } }; | ||
|
|
||
| if (!auth?.username || !auth?.password) { | ||
| throw new Error(localize('vscode-docker.commands.registries.azure.deployImageToAca.noCredentials', 'No credentials found for registry "{0}".', registry.label)); | ||
| } | ||
|
|
||
| if (registry instanceof DockerHubNamespaceTreeItem) { | ||
| // Ensure Docker Hub images are prefixed with 'docker.io/...' | ||
| if (!/^docker\.io\//i.test(commandOptions.image)) { | ||
| commandOptions.image = 'docker.io/' + commandOptions.image; | ||
| } | ||
| } | ||
|
|
||
| commandOptions.username = auth.username; | ||
| commandOptions.secret = auth.password; | ||
| } | ||
|
|
||
| commandOptions.registryName = nonNullProp(parseDockerLikeImageName(commandOptions.image), 'registry'); | ||
|
|
||
| // Don't wait | ||
| void vscode.commands.executeCommand('containerApps.deployImageApi', commandOptions); | ||
| } | ||
|
|
||
| function isAcaExtensionInstalled(): boolean { | ||
| const acaExtension = vscode.extensions.getExtension(acaExtensionId); | ||
|
|
||
| if (!acaExtension?.packageJSON?.version) { | ||
| // If the ACA extension is not present, or the package JSON didn't come through, or the version is not present, then it's not installed | ||
| return false; | ||
| } | ||
|
|
||
| const acaVersion = semver.coerce(acaExtension.packageJSON.version); | ||
| const minVersion = semver.coerce(minimumAcaExtensionVersion); | ||
|
|
||
| return semver.gte(acaVersion, minVersion); | ||
| } | ||
|
|
||
| async function openAcaInstallPage(context: IActionContext): Promise<void> { | ||
| const message = localize( | ||
| 'vscode-docker.commands.registries.azure.deployImageToAca.installAcaExtension', | ||
| 'Version {0} or higher of the Azure Container Apps extension is required to deploy to Azure Container Apps. Would you like to install it now?', | ||
| minimumAcaExtensionVersion | ||
| ); | ||
|
|
||
| const installButton: vscode.MessageItem = { | ||
| title: localize('vscode-docker.commands.registries.azure.deployImageToAca.install', 'Install'), | ||
| }; | ||
|
|
||
| const response = await context.ui.showWarningMessage(message, { modal: true }, installButton, DialogResponses.cancel); | ||
|
|
||
| if (response !== installButton) { | ||
| throw new UserCancelledError('installAcaExtensionDeclined'); | ||
| } | ||
|
|
||
| await vscode.commands.executeCommand('extension.open', acaExtensionId); | ||
|
|
||
| throw new UserCancelledError('installAcaExtensionOpened'); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters