azure_aks_cluster Resource

[edit on GitHub]

Use the azure_aks_cluster InSpec audit resource to test 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. The api_version can be defined as a resource parameter. If not provided, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

Unless defined, this resource uses the azure_cloud global endpoint and default values for the HTTP client. For more information, refer to the resource pack README.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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: 'example', name: 'ClusterName') 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 that the targeted resource resides in. MyResourceGroup.

name

Name of the AKS cluster to test. ClusterName.

resource_id

The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerService/managedClusters/{ClusterName}.

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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed 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: 'example', name: 'ClusterName') 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: 'example', name: 'ClusterName') 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: 'example', name: 'ClusterName') 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 disabled.

describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') 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 our Universal Matchers page.

exists

# If we expect 'ClusterName' to always exist
describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do
  it { should exist }
end

# If we expect 'ClusterName' to never exist
describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') 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.