In this article, we will explore the Terraform AKS module. Then, we will show how to create an AKS cluster on Azure using Terraform with just four lines of code!
Azure Kubernetes Service (AKS) is a managed container orchestration service provided by Microsoft Azure. AKS simplifies the deployment, management, and scaling of Kubernetes clusters in the cloud, enabling developers to focus on building and deploying applications without needing to handle the complexities of Kubernetes infrastructure.
AKS integrates with a range of Azure services, including Azure Monitor for centralized monitoring, Azure Security Center for security management, and Azure Application Gateway for load balancing. These integrations support efficient monitoring, security, and traffic management for applications running on AKS.
AKS also works with Azure Container Registry (ACR) to simplify the storage, retrieval, and management of Docker images, enhancing workflow efficiency for containerized applications.
Why should you use Terraform with AKS?
As for every other infrastructure resource, using Terraform to manage AKS makes the most sense. It allows for version-controlled definitions of AKS clusters and their resources, facilitating team collaboration and change tracking.
Terraform’s declarative configuration simplifies cloud environment management, and its ecosystem integration streamlines workflows across Azure services. By automating AKS deployments with Terraform, teams can efficiently manage cluster configurations, scale resources on-demand, and apply updates or rollbacks with minimal downtime, enhancing operational efficiency and reliability.
The simplest way to provision an AKS cluster using Terraform is to call the official azurerm registry module. This way, you can create a group with just four lines of code (assuming you accept all the defaults)!
A module is simply a collection of .tf configuration files that define multiple related resources, coded in such a way that the code can be reused. These files are held in a folder.
The Terraform registry has a huge collection of ready-to-use modules, saving you time and effort when it comes to coding for common tasks, e.g., instead of defining code for creating a VM in Azure, you could call the Azure VM module from the public registry.
There are downsides to using registry modules, rather than creating and maintaining your own module or alternatively creating the individual resources in your Terraform code. It can be considered less flexible to use public modules as you don’t have direct control over the module code. In an enterprise scenario, using modules created by the enterprise is generally the preferred approach because of this. However, they are a good option for testing, and well-maintained public modules can still be a great option for production scenarios.
To deploy an AKS cluster with Terraform, we will use the ‘named_cluster’ submodule example provided on the registry page of the public AKS module.
Make sure you have installed:
- Azure CLI
- Terraform
- kubectl
1. Create the main.tf file
Create a directory for your Terraform configuration files. In this directory, create a file called main.tf that will include our azurerm provider and the module.
Paste the code below:
terraform {
required_providers {
azurerm = {
source = "hashicorp/azurerm"
version = "3.40.0"
}
}
}
provider "azurerm" {
features {}
}
module "aks_example_named_cluster" {
source = "Azure/aks/azurerm//examples/named_cluster"
version = "6.2.0"
}2. Set up Azure
To connect to Azure, first, create an Azure Account and log in to it the command line:
az login
Then, select your subscription:
az account set -subscriptionid <id>
3. Run Terraform
Run through the usual Terraform workflow commands from the same directory as your main.tf file is in.
Initialize the Terraform configuration with terraform init:
Review the configuration with terraform plan.
And apply the configuration to create the AKS cluster:
When prompted, confirm the changes. Now, Terraform will provision the AKS cluster in Azure, which may take a few minutes.
4. Configure kubectl to connect to the AKS cluster
Once the AKS cluster is created, use the Azure CLI to configure kubectl:
az aks get-credentials --resource-group <your-resource-group-name> --name <your-aks-cluster-name>Now you should be able to interact with your AKS cluster using kubectl. You can, for example, run:
kubectl get nodes5. Explore the Azure portal
Jump into the Azure portal, and you should see a resource group with a randomly created name containing seven resources, as shown below:
The module created not only the AKS cluster but also the supporting services required by it for secure operation, including a disk encryption set, key vault, log analytics workspace, container insights solution, and managed identity. It also created the virtual network to which the AKS cluster is attached.
This is clearly awesome for quickly spinning up an AKS cluster for test purposes. However, in the real world, you’ll want to tailor the deployment a little to work in your environment.
- Most Azure environments will probably want to hook into and reuse an existing key vault, log analytics workspace, and virtual network, for example.
- You will also likely have a defined naming format you should adhere to rather than the randomly created names for the key vault, managed identity, and virtual network shown above.
- You might also want to amend the outputs so you can use the values in other parts of your Terraform configuration.
- You might want to tailor the deployment to adhere to specific policies to harden and secure your AKS deployment.
Note that much more configuration is required, but once created, you have more flexibility and control over the code—and more code to maintain!
6. Clean up
When you’re finished, you can remove all resources with:
terraform destroyThis will remove the AKS cluster and all other resources defined in your Terraform configuration.
Let’s dive into the registry module source code to look at the defaults and explore the available options. The source code on GitHub for the module is linked from the Terraform registry page.
On the README page, the available inputs and outputs are listed, which, when set, allow you to customize your deployment. These are also listed on the Terraform registry page, as with all modules.
The providers used by the module are listed on the dependencies tab. They are downloaded and installed automatically upon terraform init.
To adhere to recommended security settings when deploying an AKS cluster, the module sets some recommended defaults from the Azure policies section at Bridgecrew by Prisma Cloud, such as ensuring AKS uses a disk encryption set. You can check out their recommendations for your cluster here.
To show how to use the Registry module with some custom values, we will run through an example configuration.
On the Terraform registry page, you will notice there are two required inputs, prefix and resource_group_name. These will need to be defined.
We’ll add a prefix of “test” and import a resource group I previously created called “aks-test-rg”.
terraform {
required_providers {
azurerm = {
source = "hashicorp/azurerm"
version = "3.40.0"
}
}
}
provider "azurerm" {
features {}
}
module "aks_example_named_cluster" {
source = "Azure/aks/azurerm/"
version = "6.2.0"
prefix = "test"
resource_group_name = "aks-test-rg"
}From the available optional values, we will set the admin_usernameto “testaksadmin”.
Turn on the Azure Policy Addon:
Then, link your AKS cluster to the previously created log analytics workspace by setting cluster_log_analytics_workspace_name to “test-aks-law”.
Set the cluster name to adhere to our naming convention by setting cluster_name to “jr-test-aks”.
Define the location of your cluster as “uksouth”.
Set the log_retention_in_days to “365” days:
Our code now looks like this:
terraform {
required_providers {
azurerm = {
source = "hashicorp/azurerm"
version = "3.40.0"
}
}
}
provider "azurerm" {
features {}
}
module "aks_example_named_cluster" {
source = "Azure/aks/azurerm"
version = "6.2.0"
prefix = "test"
resource_group_name = "aks-test-rg"
admin_username = "testaksadmin"
azure_policy_enabled = true
cluster_log_analytics_workspace_name = "test-aks-law"
cluster_name = "jr-test-aks"
location = "uksouth"
log_retention_in_days = "365"
}Run terraform init (make sure you have the latest Terraform version! by typing terraform version to avoid unexpected errors!)
terraform plan
Take a look at the resources the module will create. For example, it includes an SSH private key to support your deployment!
terraform apply
Of course, there are many more options and outputs to explore, enabling you to tailor your AKS deployment to your requirements.
Don’t forget to clean up!
terraform destroy
Don’t forget to take a look at how Spacelift helps you manage the complexities and compliance challenges of using Terraform. It brings with it a GitOps flow, so your infrastructure repository is synced with your Terraform Stacks, and pull requests show you a preview of what they’re planning to change. It also has an extensive selection of policies, which lets you automate compliance checks and build complex multi-stack workflows.
If you want to learn more about what you can do with Spacelift, check out this article, create a free trial account, or book a demo with one of our engineers.
Using the official azurerm AKS Terraform public registry module is the fastest and arguably easiest way to create a Kubernetes cluster on Azure. You can customize your deployment as required by adding inputs and outputs to your configuration, as shown in the example above.
However, for full control and flexibility, creating and maintaining your own AKS module or configuration may be preferable as you have full control over the code.
Note: New versions of Terraform are placed under the BUSL license, but everything created before version 1.5.x stays open-source. OpenTofu is an open-source version of Terraform that expands on Terraform’s existing concepts and offerings. It is a viable alternative to HashiCorp’s Terraform, being forked from Terraform version 1.5.6.
Manage Terraform better and faster
If you are struggling with Terraform automation and management, check out Spacelift. It helps you manage Terraform state, build more complex workflows, and adds several must-have capabilities for end-to-end infrastructure management.
