search

Azure / aks-devx-tools

Create deployment files and configure GitHub Actions workflows to deploy applications to Azure Kubernetes Service (AKS).
MIT License
17 stars 17 forks source link

readme

Azure Kubernetes Service (AKS) DevX Extension for Visual Studio Code (Preview)

Notice: The AKS DevX Extension for Visual Studio Code will be discontinued and archived on January 3, 2025. For more information, please refer to the openGitHub issue.

The AKS DevX extension for Visual Studio Code (Preview) is an extension focused on enhancing your day-to-day life as a developer on Azure Kubernetes Service. This extension is focused on non-cluster developer experiences. If you are more interested in cluster operations, download the aks-extension.

The current list of experiences in this extension are:

Installation

  1. Download and install the Azure Kubernetes Service DevX Extension for Visual Studio Code.

  2. Wait for the extension to finish installing then reload Visual Studio Code when prompted.

  3. Verify that the extension is installed by browsing your installed extensions and finding Azure Kubernetes Service DevX Extension

Features

Draft

Draft makes it easier for developers to get started building apps that run on Kubernetes by taking a non-containerized application and generating the Dockerfiles, Kubernetes manifests, Helm charts, Kustomize configuration, and other artifacts associated with a containerized application.

To get started with Draft, right click your directory in your Visual Studio Code window. The window “Run AKS DevX Tool” holds the menu for Draft. Here, you can see all the Draft commands available to you. Another viable option is to press ctrl + shift + p and open up the command palette and type "AKS Developer".

Draft commands

To properly use Draft to containerize your application, create manifest files, and deploy your application, you must use the commands in the following order:

Note: Draft currently has a dependency on Azure CLI and GitHub CLI.

Commands

Draft a Dockerfile adds the minimum required Dockerfile to the project directory.

Draft a Kubernetes Deployment and Service adds the appropriate deployment and service files to your application. Allowing you to deploy to an AKS cluster.

Build an image on Azure Container Registry build an image on an ACR to later use in your deployment files.

Prerequisites shows you all the steps that you need to get up and running on AKS. By the end of this checklist you will have an application up and running on AKS!

Draft a GitHub Action Deployment Workflow for use with AKS, leveraging GitHub OIDC

Telemetry

This extension collects telemetry data to help us build a better experience for building applications with Azure Kubernetes Service and VS Code. To read more about what we collect, click here.

We do not collect any information about image names, paths, etc. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

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.opensource.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., status check, 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.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.