isabella232 / aks-construction

Accelerate your onboarding to AKS with; Param Wizard, templating and CI/CD samples. Flexible & secure AKS baseline implementations

AKS Bicep Accelerator

Building Kubernetes clusters can be hard work! The AKS Bicep Accelerator focuses on expediting customers onboarding of Azure Kubernetes Service workloads using best practices and a flexible templating approach to suit differing requirements.

This project unifies guidance provided by the AKS Secure Baseline, Well Architected Framework, Cloud Adoption Framework and Enterprise-Scale by providing tangible artifacts to deploy Azure resources from CLI or CI/CD systems.

The AKS Bicep Accelerator is part of the official AKS Landing Zone Accelerator (Enterprise Scale) architectural approach. To read more about this project and how the AKS Bicep Accelerator fits with Enterprise Scale and the AKS Secure Baseline, look here.

The 3 Components

This projects focus is split equally over 3 areas, configuration, modular templating and CI implementation.

Wizard experience

To help guide your AKS configuration, use the Deployment Helper, which will provide a set of parameters and scripts to make deployment simple. It uses several preset configurations to guide configuration decisions. The deployment helper provides links to the official Microsoft documentation to help provide additional context for each feature.

IaC - Bicep code files

IaC (Infrastructure as Code) code files have been modularised into their component areas. Main.bicep references them and they are expected to be present in the same directory. The Deployment Helper leverages an Arm json compiled version of all the bicep files.

Releases are used to version the bicep code files, they can be leveraged directly for use in your project or you can opt to Fork the repo if you prefer.

DevOps - GitHub Actions

A number of GitHub actions are used in the repo that run on push/pr/schedules. These can be copied into your own repo and customised for your CI/CD pipeline. A robust deployment pipeline is essential when coordinating the deployment of multiple Azure services that work together, additionally there is configuration that cannot be set in the template and that needs to be automated (and tested) consistently.

CI Name	Actions Workflow	Parameter file	CI Status	Notes
Starter cluster	StandardCI.yml	ESLZ Sandbox		A simple deployment example, good for first time users of this project to start with
BYO Vnet	ByoVnetCI.yml	ESLZ Byo peered vnet		Comprehensive IaC flow deploying multiple smoke-test apps
Private cluster	ByoVnetPrivateCI.yml	ESLZ Byo private vnet		A private AKS cluster that deploys a vnet with private link services.

For a more in depth look at the GitHub Actions used in this project, which steps are performed and the different CI practices they demonstrate, please refer to this page.

Getting Started

Basic

If this is the first time you're using the project, follow these steps.

1. Use the Deployment Helper to guide your AKS configuration.
2. Run the commands in the Provision Environment tab to create your AKS Environment in your Azure subscription
3. Run the commands in the Post Configuration tab to complete your implementation
4. Connect to your AKS Cluster, and deploy your applications as you see fit.

Mature

If you're looking to use this project as part of your deployments, follow these steps.

1. Use the Deployment Helper to guide your AKS configuration.
2. Capture the parameters on the Template Parameters File tab to a file - this is your configuration
3. Check the Post Configuration tab for any commands and save them to a file
4. Grab the latest release of the bicep code
5. (optionally) Author an Application Main bicep to represent your application (see here for an example)
6. In your CI/CD system, either using one of the GitHub Action Workflow files as a base, or by coding it yourself - initiate a deployment of the bicep code, using your parameter file
7. In your CI/CD system, deploy your application(s) to the AKS cluster

Project Principals

The guiding principal we have with this project is to focus on the the downstream use of the project (see releases). As such, these are our specific practices.

1. Deploy all components through a single, modular, idempotent bicep template Converge on a single bicep template, which can easily be consumed as a module
2. Provide best-practice defaults, then use parameters for different environment deployments
3. Minimise "manual" steps for ease of automation
4. Maintain quality through validation & CI/CD pipelines that also serve as working samples/docs
5. Focus on AKS and supporting services, linking to other repos to solve; Demo apps / Developer workstations / Jumpboxes / CI Build Agents / Certificate Authorities

Contributing

If you're interested in contributing, please refer to the contribution guide

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 [email protected] 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.