Skip to main content

k8s_api_resources resource

Use the k8s_api_resources Chef InSpec audit resource to test the configurations of all resources under the specified API.

Installation

Syntax

describe k8s_api_resources(api: 'apps/v1') do
  it { should exist }
  its('name') { should include 'daemonsets' }
  its('singularName') { should include '' }
  its('namespaced') { should include true }
  its('group') { should include 'autoscaling' }
  its('version') { should include 'v1' }
  its('kind') { should include 'DaemonSet' }
  its('shortNames') { should include 'ds' }
  its('categories') { should include 'all' }
end

Parameter

api
API available for Kubernetes (default is v1).

Properties

name
Name of the resource available under the specified API.
singularName
Singular name of the resource available under the specified API.
namespaced
returns a boolean value if the resources under the api is namespaced.
group
group of the resources under the specified API.
version
version of the specified API.
shortNames
Short names for resources under the specified API.
categories
Categories for resources under the specified API.
kind
Type of resources under the specified API.

Examples

Resources under default API must exist

describe k8s_api_resources do
  it { should exist }
  its('kind') { should include 'ConfigMap' }
end

Resources under specified API must exist and test its properties

describe k8s_api_resources(api: 'apps/v1') do
  it { should exist }
  its('name') { should include 'daemonsets' }
  its('singularName') { should include '' }
  its('namespaced') { should include true }
  its('group') { should include 'autoscaling' }
  its('version') { should include 'v1' }
  its('kind') { should include 'DaemonSet' }
  its('shortNames') { should include 'ds' }
  its('categories') { should include 'all' }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.
Edit this page on GitHub

Thank you for your feedback!

×










Search Results