Skip to main content

azure_aks_cluster resource

Use the azure_aks_cluster InSpec audit resource to test the properties of an Azure AKS Cluster.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_aks_cluster resource block identifies an AKS Cluster by name and resource_group, or the resource_id.

describe azure_aks_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  it { should exist }
end

describe azure_aks_cluster(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerService/managedClusters/{ClusterName}') do
  it { should exist }
end

Parameters

resource_group
Azure resource group where the targeted resource resides.
name
Name of the AKS cluster to test.
resource_id
The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

  • resource_id
  • resource_group and name

Properties

identity
The identity of the managed cluster, if configured. It is a managed cluster identity object.
sku
The SKU (pricing tier) of the resource.
diagnostic_settings
The diagnostic settings for the resource group that the AKS cluster is within.
enabled_logging_types
The logging types that are enabled for the AKS cluster.
disabled_logging_types
The logging types that are disabled for the AKS cluster.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.).

Examples

Test that an AKS Cluster has the desired network plug-in:

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  its('properties.networkProfile.networkPlugin') { should cmp 'kubenet' }
end

Loop through all clusters within the subscription:

azure_aks_clusters.ids.each do |resource_id|
  describe azure_aks_cluster(resource_id: resource_id) do
    its('properties.networkProfile.networkPlugin') { should cmp 'kubenet' }
  end
end

Test that a specified AKS Cluster has the correct number of nodes in pool:

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  its('properties.agentPoolProfiles.first.count') { should cmp 5 }
end

Test that a specified AKS Cluster has kube-audit logging enabled:

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  its('enabled_logging_types') { should include "kube-audit" }
end

Test that a specified AKS Cluster has logging enabled on it and no forms of logging are disabled:

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  its('disabled_logging_types.count') { should eq 0 }
end

See integration tests for more examples.

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit Universal Matchers page.

exists

# If we expect 'CLUSTERNAME' to always exist.

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  it { should exist }
end

not_exists

# If we expect 'CLUSTERNAME' to never exist.

describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.

Thank you for your feedback!

×