Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure Account -> Azure Resources and GitLab support removal, GitHub addition #6867

Merged
merged 4 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/containers/images/registries/github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/containers/images/registries/gitlab.png

This file was deleted.

4 changes: 2 additions & 2 deletions docs/containers/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The extension can scaffold Docker files for most popular development languages (

## Docker Explorer

The Docker extension contributes a Docker Explorer view to VS Code. The Docker Explorer lets you examine and manage Docker assets: containers, images, volumes, networks, and container registries. If the Azure Account extension is installed, you can browse your Azure Container Registries as well.
The Docker extension contributes a Docker Explorer view to VS Code. The Docker Explorer lets you examine and manage Docker assets: containers, images, volumes, networks, and container registries. If you are signed in to your Microsoft account and it has access to Azure subscriptions, you can browse your Azure Container Registries as well.

The right-click menu provides access to commonly used commands for each type of asset.

Expand Down Expand Up @@ -77,7 +77,7 @@ Once your `Compose Up` command completes, navigate to the Docker Explorer to vie

## Using image registries

You can display the content and push, pull, or delete images from [Azure Container Registry](https://learn.microsoft.com/azure/container-registry), [Docker Hub](https://hub.docker.com/), [GitLab](https://gitlab.com/), and more:
You can display the content and push, pull, or delete images from [Azure Container Registry](https://learn.microsoft.com/azure/container-registry), [Docker Hub](https://hub.docker.com/), [GitHub](https://github.com/), and more:

![Azure Container Registry content](images/overview/container-registry.png)

Expand Down
23 changes: 16 additions & 7 deletions docs/containers/quickstart-container-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Users can connect to Docker registries from the following sources:

- [Azure Container Registry](https://learn.microsoft.com/azure/container-registry)
- [Docker Hub](https://hub.docker.com/)
- [GitLab](https://gitlab.com/) container registry
- [GitHub](https://github.com) container registry
- Any generic private registry that supports the [Docker V2 api](https://docs.docker.com/registry/spec/api/)

## Push an image to a container registry

Before you can deploy a Docker image, the image must be uploaded to a container registry. The image can be uploaded to [Docker Hub](https://hub.docker.com/), [Azure Container Registry (ACR)](https://learn.microsoft.com/azure/container-registry/container-registry-get-started-portal) or another registry. You can follow the same steps to push the image regardless of whether you're pushing to Docker Hub, Azure Container Registries, or any other registry. If you don't already have an Azure Container Registry, you can create one during the **Push** step.

1. Open the Docker Explorer, select **Connect Registry...** icon under the **Registries** group, and follow the prompt. Choose the provider (for example, Azure or Docker Hub) and provide the credential to connect to the registry. If prompted, install the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension.
1. Open the Docker Explorer, select **Connect Registry...** icon under the **Registries** group, and follow the prompt. Choose the provider (for example, Azure or Docker Hub) and provide the credential to connect to the registry. If prompted, install the [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups) extension.

![Connect to Registry](images/registries/connect-registry-2.png)

Expand Down Expand Up @@ -61,11 +61,14 @@ For each repository in the Docker Hub registry, here are the actions that can be
For each tagged image in a repository, here are the actions that can be performed:

- **Pull image**: copies the latest version of the image locally
- **Copy Full Tag**: copies the full tag to the clipboard
- **Deploy Image to Azure App Service**: deploys the image to Azure App Service, see [Deploy images to Azure](/docs/containers/app-service.md) page
- **Deploy Image to Azure Container Apps**: deploys the image to Azure Container Apps, see [Deploy images to Azure](/docs/containers/app-service.md) page
- **Open in browser**: opens the browser and navigates to the given image on Docker Hub

## Azure Container Registry

This option requires the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension to be able to connect to your Azure account and display all of the different subscriptions and registries.
This option requires the [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups) extension to be able to connect to your Azure account and display all of the different subscriptions and registries.
Once authenticated, the node **Azure** will display the subscriptions along with registries each have:

![Azure Container Registry](images/registries/azure-registries.png)
Expand Down Expand Up @@ -94,25 +97,31 @@ For each tagged image in a repository, here are the actions that can be performe
- **Pull Image**: copies the latest version of the image locally
- **Copy Full Tag**: copies the full tag to the clipboard
- **Copy Image Digest**: copies the image digest, which is a SHA256 hash identifier that Docker uses, to the clipboard. See [Docker Docs](https://docs.docker.com/engine/reference/commandline/images/#list-image-digests) for more info on image digests
- **Inspect Image Manifest**: inspects the image's registry manifest. This is not the same as inspecting the image when it is pulled locally.
- **Deploy Image to Azure App Service**: deploys the image to Azure App Service, see [Deploy images to Azure](/docs/containers/app-service.md) page
- **Deploy Image to Azure Container Apps**: deploys the image to Azure Container Apps, see [Deploy images to Azure](/docs/containers/app-service.md) page
- **Untag Image**: untags the image
- **Delete Image**: deletes the image permanently

## GitLab
## GitHub

This connects to Docker registries in your [GitLab](https://gitlab.com/) account. Once you select this option, you are asked to type in your GitLab account credentials.
This connects to Docker registries in your [GitHub](https://github.com/) account. Once you select this option, you are asked to type in your GitHub account credentials.

![GitLab](images/registries/gitlab.png)
![GitHub](images/registries/github.png)

For each repository in the GitLab registry, here are the actions that can be performed:
For each repository in the GitHub registry, here are the actions that can be performed:

- **Pull Repository**: copies all of the images in a given repository locally
- **Refresh**: refreshes the repository to reflect changes

For each tagged image in a repository, here are the actions that can be performed:

- **Pull Image**: copies the latest version of the image locally
- **Copy Full Tag**: copies the full tag to the clipboard
- **Copy Image Digest**: copies the image digest, which is a SHA256 hash identifier that Docker uses, to the clipboard. See [Docker Docs](https://docs.docker.com/engine/reference/commandline/images/#list-image-digests) for more info on image digests
- **Inspect Image Manifest**: inspects the image's registry manifest. This is not the same as inspecting the image when it is pulled locally.
- **Deploy Image to Azure App Service**: deploys the image to Azure App Service, see [Deploy images to Azure](/docs/containers/app-service.md) page
- **Deploy Image to Azure Container Apps**: deploys the image to Azure Container Apps, see [Deploy images to Azure](/docs/containers/app-service.md) page

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/containers/quickstart-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The Docker Explorer provides an interactive experience to examine and manage Doc

You can use the command **Azure Container Registry: Build Image in Azure** to build an image that you can then deploy to Azure App Service or Azure Container Apps.

1. Install the [Azure account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account). Open the **Command Palette** (`kb(workbench.action.showCommands)`) and search for the command **Azure: Sign In**. If you don't have an Azure account, you can sign up for a [free trial](https://azure.microsoft.com/free/?utm_source=campaign&utm_campaign=vscode-azure-account&mktingSource=vscode-azure-account).
1. Install the [Azure Resources extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups). Open the **Command Palette** (`kb(workbench.action.showCommands)`) and search for the command **Azure: Sign In**. If you don't have an Azure account, you can sign up for a [free trial](https://azure.microsoft.com/free/?utm_source=campaign&utm_campaign=vscode-azure-account&mktingSource=vscode-azure-account).

1. There are two ways to invoke the build in Azure command. You can right-click on the Dockerfile, and choose **Build Image in Azure**. You can also use the **Command Palette** (`kb(workbench.action.showCommands)`) and search for the command **Azure Container Registry: Build Image in Azure**.

Expand Down
2 changes: 1 addition & 1 deletion docs/java/java-webapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Once the extension is installed, you can take the following steps to create a ne

### Build and deploy to a Web App

The deploy process leverages the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension (installed along with the Azure App Service extension as a dependency) and you need to sign in with your Azure subscription. If you do not have an Azure subscription, [sign up today](https://azure.microsoft.com//free/?b=16.48) for a free 30 day account and get $200 in Azure Credits to try out any combination of Azure services.
The deploy process leverages the [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups) extension (installed along with the Azure App Service extension as a dependency) and you need to sign in with your Azure subscription. If you do not have an Azure subscription, [sign up today](https://azure.microsoft.com//free/?b=16.48) for a free 30 day account and get $200 in Azure Credits to try out any combination of Azure services.

Once you have signed in, you can open the command prompt or terminal window and build the project using Maven commands. This will generate a new `war` or `jar` artifact in the `target` directory.

Expand Down