Skip to content

Commit b5ee945

Browse files
Stacyrch140Stacyrch140
authored
Merge pull request #281394 from qpetraroia/aks-extension-docs
aks extension docs
2 parents 2eb1b10 + 04d0b90 commit b5ee945

5 files changed

+314
-0
lines changed

‎articles/aks/TOC.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,16 @@
248248
href: deployment-safeguards.md
249249
- name: How-to guides
250250
items:
251+
- name: AKS extension for Visual Studio Code
252+
items:
253+
- name: Attach to Azure Container Registry (ACR)
254+
href: aks-extension-attach-azure-container-registry.md
255+
- name: Create a Dockerfile
256+
href: aks-extension-draft-dockerfile.md
257+
- name: Create a Kubernetes deployment
258+
href: aks-extension-draft-deployment.md
259+
- name: Create a GitHub Workflow
260+
href: aks-extension-draft-github-workflow.md
251261
- name: Migration
252262
items:
253263
- name: Plan and execute a migration

‎articles/aks/aks-extension-attach-azure-container-registry.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Attach to Azure Container Registry (ACR) using the Azure Kubernetes Service (AKS) extension for Visual Studio Code
3+
description: Learn how to attach to Azure Container Registry (ACR) using the Azure Kubernetes Service (AKS) extension for Visual Studio Code.
4+
author: qpetraroia
5+
ms.topic: how-to
6+
ms.date: 07/15/2024
7+
ms.author: qpetraroia
8+
ms.service: azure-kubernetes-service
9+
---
10+
11+
# Attach to Azure Container Registry (ACR) using the Azure Kubernetes Service (AKS) extension for Visual Studio Code
12+
13+
In this article, you learn how to attach to Azure Container Registry (ACR) using the Azure Kubernetes Service (AKS) extension for Visual Studio Code.
14+
15+
## Prerequisites
16+
17+
Before you begin, make sure you have the following resources:
18+
19+
* An Azure container registry. If you don't have one, create one using the steps in [Quickstart: Create a private container registry][create-acr-cli].
20+
* An AKS cluster. If you don't have one, create one using the steps in [Quickstart: Deploy an AKS cluster][deploy-aks-cli].
21+
* The Azure Kubernetes Service (AKS) extension for Visual Studio Code downloaded. For more information, see [Install the Azure Kubernetes Service (AKS) extension for Visual Studio Code][install-aks-vscode].
22+
23+
## Attach your Azure container registry to your AKS cluster
24+
25+
You can access the screen for attaching your container registry to your AKS cluster using the command palette or the Kubernetes view.
26+
27+
### [Command palette](#tab/command-palette)
28+
29+
1. On your keyboard, press `Ctrl+Shift+P` to open the command palette.
30+
2. Enter the following information:
31+
32+
* **Subscription**: Select the Azure subscription that holds your resources.
33+
* **ACR Resource Group**: Select the resource group for your container registry.
34+
* **Container Registry**: Select the container registry you want to attach to your cluster.
35+
* **Cluster Resource Group**: Select the resource group for your cluster.
36+
* **Cluster**: Select the cluster you want to attach to your container registry.
37+
38+
3. Select **Attach**.
39+
40+
You should see a green checkmark, which means your container registry is attached to your AKS cluster.
41+
42+
### [Kubernetes view](#tab/kubernetes-view)
43+
44+
1. In the Kubernetes tab, under Clouds > Azure > your subscription > Automated Deployments, right click on your cluster and select **Attach ACR to Cluster**.
45+
2. Enter the following information:
46+
47+
* **Subscription**: Select the Azure subscription that holds your resources.
48+
* **ACR Resource Group**: Select the resource group for your container registry.
49+
* **Container Registry**: Select the container registry you want to attach to your cluster.
50+
* **Cluster Resource Group**: Select the resource group for your cluster.
51+
* **Cluster**: Select the cluster you want to attach to your container registry.
52+
53+
3. Select **Attach**.
54+
55+
You should see a green checkmark, which means your container registry is attached to your AKS cluster.
56+
57+
---
58+
59+
For more information, see [AKS extension for Visual Studio Code features][aks-vscode-features].
60+
61+
## Product support and feedback
62+
63+
If you have a question or want to offer product feedback, please open an issue on the [AKS extension GitHub repository][aks-vscode-github].
64+
65+
## Next steps
66+
67+
To learn more about other AKS add-ons and extensions, see [Add-ons, extensions, and other integrations for AKS][aks-addons].
68+
69+
<!---LINKS--->
70+
[create-acr-cli]: ../container-registry/container-registry-get-started-azure-cli.md
71+
[deploy-aks-cli]: ./learn/quick-kubernetes-deploy-cli.md
72+
[install-aks-vscode]: ./aks-extension-vs-code.md#installation
73+
[aks-vscode-features]: https://code.visualstudio.com/docs/azure/aksextensions#_features
74+
[aks-vscode-github]: https://github.com/Azure/vscode-aks-tools/issues/new/choose
75+
[aks-addons]: ./integrations.md
76+

‎articles/aks/aks-extension-draft-deployment.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Create a Kubernetes deployment using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
3+
description: Learn how create a Kubernetes deployment using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code.
4+
author: qpetraroia
5+
ms.topic: how-to
6+
ms.date: 07/15/2024
7+
ms.author: qpetraroia
8+
ms.service: azure-kubernetes-service
9+
---
10+
11+
# Create a Kubernetes deployment using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
12+
13+
In this article, you learn how to create a Kubernetes deployment using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code. Automated Deployments provides an easy way to automate the process of scaling, updating, and maintaining your applications.
14+
15+
## Prerequisites
16+
17+
Before you begin, make sure you have the following resources:
18+
19+
* An active folder with code open in Visual Studio Code.
20+
* The Azure Kubernetes Service (AKS) extension for Visual Studio Code downloaded. For more information, see [Install the Azure Kubernetes Service (AKS) extension for Visual Studio Code][install-aks-vscode].
21+
22+
## Create a Kubernetes deployment using the Azure Kubernetes Service (AKS) extension
23+
24+
You can access the screen to create a Kubernetes deployment using the command palette or the explorer view.
25+
26+
### [Command palette](#tab/command-palette)
27+
28+
1. On your keyboard, press `Ctrl+Shift+P` to open the command palette.
29+
2. In the search bar, search for and select **Automated Deployments: Create a Deployment**.
30+
3. Enter the following information:
31+
32+
* **Subscription**: Select your Azure subscription.
33+
* **Location**: Select a location where you want to save your Kubernetes deployment files.
34+
* **Deployment options**: Select `Kubernetes manifests`, `Helm`, or `Kustomize`.
35+
* **Target port**: Select the port in which your applications listen to in your deployment. This port usually matches what is exposed in your Dockerfile.
36+
* **Service port**: Select the port in which the service listens to for incoming traffic.
37+
* **Namespace**: Select the namespace in which your application will be deployed into.
38+
39+
4. Select **Create**.
40+
41+
42+
### [Explorer view](#tab/explorer-view)
43+
44+
1. Right click on the explorer pane where your active folder is open and select **Create a Deployment**.
45+
2. Enter the following information:
46+
47+
* **Subscription**: Select your Azure subscription.
48+
* **Location**: Select a location where you want to save your Kubernetes deployment files.
49+
* **Deployment options**: Select `Kubernetes manifests`, `Helm`, or `Kustomize`.
50+
* **Target port**: Select the port in which your applications listen to in your deployment. This port usually matches what is exposed in your Dockerfile.
51+
* **Service port**: Select the port in which the service listens to for incoming traffic.
52+
* **Namespace**: Select the namespace in which your application will be deployed into.
53+
54+
3. Select **Create**.
55+
56+
---
57+
58+
For more information, see [AKS extension for Visual Studio Code features][aks-vscode-features].
59+
60+
## Product support and feedback
61+
62+
If you have a question or want to offer product feedback, please open an issue on the [AKS extension GitHub repository][aks-vscode-github].
63+
64+
## Next steps
65+
66+
To learn more about other AKS add-ons and extensions, see [Add-ons, extensions, and other integrations for AKS][aks-addons].
67+
68+
<!---LINKS--->
69+
[install-aks-vscode]: ./aks-extension-vs-code.md#installation
70+
[aks-vscode-features]: https://code.visualstudio.com/docs/azure/aksextensions#_features
71+
[aks-vscode-github]: https://github.com/Azure/vscode-aks-tools/issues/new/choose
72+
[aks-addons]: ./integrations.md
73+
74+

‎articles/aks/aks-extension-draft-dockerfile.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Create a Dockerfile using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
3+
description: Learn how to create a Dockerfile using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code.
4+
author: qpetraroia
5+
ms.topic: how-to
6+
ms.date: 07/15/2024
7+
ms.author: qpetraroia
8+
ms.service: azure-kubernetes-service
9+
---
10+
11+
# Create a Dockerfile using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
12+
13+
In this article, you learn how to create a Dockerfile using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code. A Dockerfile is essential for Kubernetes because it defines the blueprint for creating Docker images. These images encapsulate your application along with its dependencies and environment settings, ensuring consistent deployment across various environments.
14+
15+
## Prerequisites
16+
17+
Before you begin, make sure you have the following resources:
18+
19+
* An active folder with code open in Visual Studio Code.
20+
* The Azure Kubernetes Service (AKS) extension for Visual Studio Code downloaded. For more information, see [Install the Azure Kubernetes Service (AKS) extension for Visual Studio Code][install-aks-vscode].
21+
22+
## Create a Dockerfile using the Azure Kubernetes Service (AKS) extension
23+
24+
You can access the screen to create a Dockerfile using the command palette or the explorer view.
25+
26+
### [Command palette](#tab/command-palette)
27+
28+
1. On your keyboard, press `Ctrl+Shift+P` to open the command palette.
29+
2. In the search bar, search for and select **Automated Deployments: Create a Dockerfile**.
30+
3. Enter the following information:
31+
32+
* **Location**: Select a location where you want to save your Dockerfile.
33+
* **Programming language**: Select the programming language your app is written in.
34+
* **Programming language version**: Select the programming language version.
35+
* **Application Port**: Select the port.
36+
* **Cluster**: Select the port in which your application listens to for incoming network connections.
37+
38+
4. Select **Create**.
39+
40+
### [Explorer view](#tab/explorer-view)
41+
42+
1. Right click on the explorer pane where your active folder is open and select **Create a Dockerfile**.
43+
2. Enter the following information:
44+
45+
* **Location**: Select a location where you want to save your Dockerfile.
46+
* **Programming language**: Select the programming language your app is written in.
47+
* **Programming language version**: Select the programming language version.
48+
* **Application Port**: Select the port.
49+
* **Cluster**: Select the port in which your application listens to for incoming network connections.
50+
51+
3. Select **Create**.
52+
53+
---
54+
55+
For more information, see [AKS extension for Visual Studio Code features][aks-vscode-features].
56+
57+
## Product support and feedback
58+
59+
If you have a question or want to offer product feedback, please open an issue on the [AKS extension GitHub repository][aks-vscode-github].
60+
61+
## Next steps
62+
63+
To learn more about other AKS add-ons and extensions, see [Add-ons, extensions, and other integrations for AKS][aks-addons].
64+
65+
<!---LINKS--->
66+
[install-aks-vscode]: ./aks-extension-vs-code.md#installation
67+
[aks-vscode-features]: https://code.visualstudio.com/docs/azure/aksextensions#_features
68+
[aks-vscode-github]: https://github.com/Azure/vscode-aks-tools/issues/new/choose
69+
[aks-addons]: ./integrations.md
70+

‎articles/aks/aks-extension-draft-github-workflow.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Create a GitHub Workflow using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
3+
description: Learn how to create a GitHub Workflow using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code.
4+
author: qpetraroia
5+
ms.topic: how-to
6+
ms.date: 07/15/2024
7+
ms.author: qpetraroia
8+
ms.service: azure-kubernetes-service
9+
---
10+
11+
# Create a GitHub Workflow using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code
12+
13+
In this article, you learn how to create a GitHub Workflow using Automated Deployments in the Azure Kubernetes Service (AKS) extension for Visual Studio Code. A GitHub Workflow automates various development tasks, such as building, testing, and deploying code, ensuring consistency and efficiency across the development process. It enhances collaboration by integrating seamlessly with version control, enabling continuous integration and continuous deployment (CI/CD) pipelines, and ensuring that all changes are thoroughly vetted before being merged into the main codebase.
14+
15+
## Prerequisites
16+
17+
Before you begin, make sure you have the following resources:
18+
19+
* An active folder with code open in Visual Studio Code.
20+
* Make sure the current workspace is an active `git` repository.
21+
* The Azure Kubernetes Service (AKS) extension for Visual Studio Code downloaded. For more information, see [Install the Azure Kubernetes Service (AKS) extension for Visual Studio Code][install-aks-vscode].
22+
23+
## Create a GitHub Workflow using the Azure Kubernetes Service (AKS) extension
24+
25+
You can access the screen to create a GitHub Workflow using the command palette or the Kubernetes view.
26+
27+
### [Command palette](#tab/command-palette)
28+
29+
1. On your keyboard, press `Ctrl+Shift+P` to open the command palette.
30+
2. Enter the following information:
31+
32+
* **Workflow name**: Enter a name for your GitHub Workflow.
33+
* **GitHub repository**: Select the location where want to save your Kubernetes deployment files.
34+
* **Subscription**: Select your Azure subscription.
35+
* **Dockerfile**: Select the Dockerfile that you want to build in the GitHub Action.
36+
* **Build context**: Select a build context.
37+
* **ACR Resource Group**: Select an ACR resource group.
38+
* **Container Registry**: Select a container registry.
39+
* **Azure Container Registry image**: Select or enter an Azure Container Registry image.
40+
* **Cluster Resource Group**: Select your cluster resource group.
41+
* **Cluster**: Select your AKS cluster.
42+
* **Namespace**: Select or enter a namespace in which you will deploy into.
43+
* **Type**: Select the type of deployment option.
44+
45+
3. Select **Create**.
46+
47+
### [Kubernetes view](#tab/kubernetes-view)
48+
49+
1. In the Kubernetes tab, under Clouds > Azure > your subscription > Automated Deployments, right click on your cluster and select **Create a GitHub Workflow**.
50+
2. Enter the following information:
51+
52+
* **Workflow name**: Enter a name for your GitHub Workflow.
53+
* **GitHub repository**: Select the location where want to save your Kubernetes deployment files.
54+
* **Subscription**: Select your Azure subscription.
55+
* **Dockerfile**: Select the Dockerfile that you want to build in the GitHub Action.
56+
* **Build context**: Select a build context.
57+
* **ACR Resource Group**: Select an ACR resource group.
58+
* **Container Registry**: Select a container registry.
59+
* **Azure Container Registy image**: Select or enter an Azure Container Registry image.
60+
* **Cluster Resource Group**: Select your cluster resource group.
61+
* **Cluster**: Select your AKS cluster.
62+
* **Namespace**: Select or enter a namespace in which you will deploy into.
63+
* **Type**: Select the type of deployment option.
64+
65+
3. Select **Create**.
66+
67+
---
68+
69+
For more information, see [AKS extension for Visual Studio Code features][aks-vscode-features].
70+
71+
## Product support and feedback
72+
73+
If you have a question or want to offer product feedback, please open an issue on the [AKS extension GitHub repository][aks-vscode-github].
74+
75+
## Next steps
76+
77+
To learn more about other AKS add-ons and extensions, see [Add-ons, extensions, and other integrations for AKS][aks-addons].
78+
79+
<!---LINKS--->
80+
[install-aks-vscode]: ./aks-extension-vs-code.md#installation
81+
[aks-vscode-features]: https://code.visualstudio.com/docs/azure/aksextensions#_features
82+
[aks-vscode-github]: https://github.com/Azure/vscode-aks-tools/issues/new/choose
83+
[aks-addons]: ./integrations.md
84+

0 commit comments

Comments
 (0)