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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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
andname
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, 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', 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.