Merge pull request #41 from inspec/im/update_k8s_resource_docs

Reorganize Kubernetes resource docs

Author: Vasu1105

docs-chef-io/config.toml

@@ -0,0 +1,59 @@
++++
+title = "About the Chef InSpec Kubernetes resource pack"
+draft = false
+linkTitle = "Kubernetes resource pack"
+summary = "Chef InSpec resources for auditing Kubernetes."
+
+[cascade]
+  [cascade.params]
+    platform = "k8s"
+
+[menu.k8s]
+  title = "About Kubernetes resources"
+  identifier = "inspec/resources/k8s/about"
+  parent = "inspec/resources/k8s"
+  weight = 10
++++
+
+Chef InSpec Kubernetes resources allow you to audit and validate the configuration, security, and compliance of your Kubernetes clusters.
+
+## Requirements
+
+- Inspec 3.7 or greater
+- InSpec K8s train/backend plugin [train-kubernetes](https://github.com/inspec/train-kubernetes)
+
+## Usage
+
+To create and run a profile against a Kubernetes cluster, follow these steps:
+
+1. Ensure your `KUBECONFIG` environment variable or `~/.kube/config` file has a valid configuration and credentials for the target cluster.
+
+1. Define the platform and this resource pack as a dependency in your profile's `inspec.yml` file:
+
+    ```yml
+    supports:
+      platform: k8s
+    depends:
+      - name: inspec-k8s
+        url: https://github.com/inspec/inspec-k8s/archive/main.tar.gz
+    ```
+
+1. Define controls using the resources listed below.
+
+1. Execute the profile against your cluster:
+
+    ```sh
+    inspec exec profile -t k8s://
+    ```
+
+## Example
+
+For an example profile, see the [inspec-k8s-sample example repository](https://github.com/inspec/inspec-k8s-sample).
+
+## Kubernetes resources
+
+{{< inspec_resources_filter >}}
+
+The following Chef InSpec Kubernetes resources are available in this resource pack.
+
+{{< inspec_resources section="k8s" platform="k8s" >}}

docs-chef-io/content/_index.md

@@ -1,20 +1,15 @@
 +++
 title = "k8s_api_resources resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_api_resources"
 identifier = "inspec/resources/k8s/K8s API Resources"
 parent = "inspec/resources/k8s"
 +++
 
 Use the `k8s_api_resources` Chef InSpec audit resource to test the configurations of all resources under the specified API.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -64,7 +59,7 @@ end
 
 ## Examples
 
-### Resources under default API must exist
+Resources under default API must exist:
 
 ```ruby
 describe k8s_api_resources do
@@ -73,7 +68,7 @@ describe k8s_api_resources do
 end
 ```
 
-### Resources under specified API must exist and test its properties
+Resources under specified API must exist and test its properties:
 
 ```ruby
 describe k8s_api_resources(api: 'apps/v1') do
@@ -91,4 +86,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

…nt/inspec/resources/k8s_api_resources.md docs-chef-io/content/k8s_api_resources.mddocs-chef-io/content/inspec/resources/k8s_api_resources.md renamed to docs-chef-io/content/k8s_api_resources.md docs-chef-io/content/inspec/resources/k8s_api_resources.md renamed to docs-chef-io/content/k8s_api_resources.md

@@ -1,20 +1,15 @@
 +++
 title = "k8s_config_map resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_config_map"
 identifier = "inspec/resources/k8s/K8s Config Map"
 parent = "inspec/resources/k8s"
 +++
 
 Use the `k8s_config_map` Chef InSpec audit resource to test the configuration of a specific Configuration Maps in a namespace.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -50,15 +45,15 @@ end
 
 ## Examples
 
-### Configuration map for default namespace must exist
+Configuration map for default namespace must exist:
 
 ```ruby
  describe k8s_config_map(name: 'NAME') do
   it { should exist }
 end
 ```
 
-### Configuration map for specified namespace must exist
+Configuration map for specified namespace must exist:
 
 ```ruby
 describe k8s_config_map(namespace: 'NAMESPACE', name: 'NAME') do
@@ -68,4 +63,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

…ntent/inspec/resources/k8s_config_map.md docs-chef-io/content/k8s_config_map.mddocs-chef-io/content/inspec/resources/k8s_config_map.md renamed to docs-chef-io/content/k8s_config_map.md docs-chef-io/content/inspec/resources/k8s_config_map.md renamed to docs-chef-io/content/k8s_config_map.md

@@ -1,21 +1,15 @@
 +++
 title = "k8s_config_maps resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_config_maps"
 identifier = "inspec/resources/k8s/K8s Config Maps"
 parent = "inspec/resources/k8s"
 +++
 
-
 Use the `k8s_config_maps` Chef InSpec audit resource to test all the Configuration Maps in a namespace.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -51,15 +45,15 @@ end
 
 ## Examples
 
-### Configuration maps for default namespace must exist
+Configuration maps for default namespace must exist:
 
 ```ruby
  describe k8s_config_maps do
   it { should exist }
 end
 ```
 
-### Configuration maps must exists for specified namespace
+Configuration maps must exists for specified namespace:
 
 ```ruby
 describe k8s_config_maps(namespace: 'kube-system') do
@@ -69,4 +63,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

…tent/inspec/resources/k8s_config_maps.md docs-chef-io/content/k8s_config_maps.mddocs-chef-io/content/inspec/resources/k8s_config_maps.md renamed to docs-chef-io/content/k8s_config_maps.md docs-chef-io/content/inspec/resources/k8s_config_maps.md renamed to docs-chef-io/content/k8s_config_maps.md

@@ -1,21 +1,15 @@
 +++
 title = "k8s_container resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_container"
 identifier = "inspec/resources/k8s/K8s Container"
 parent = "inspec/resources/k8s"
 +++
 
-
 Use the `k8s_container` Chef InSpec audit resource to test the configuration of a specific Container in the specified namespace.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -69,23 +63,23 @@ end
 
 ## Examples
 
-### Container for default namespace must exist
+Container for default namespace must exist:
 
 ```ruby
  describe k8s_container(pod_name: 'POD_NAME', name: 'NAME') do
   it { should exist }
 end
 ```
 
-### Container for a specified namespace must exist
+Container for a specified namespace must exist:
 
 ```ruby
 describe k8s_container(namespace: 'NAMESPACE', name: 'NAME', pod_name: 'POD_NAME') do
   it { should exist }
 end
 ```
 
-### Check for presence of specific commands in Entrypoint array
+Check for presence of specific commands in Entrypoint array:
 
 ```ruby
  describe k8s_container(pod_name: 'POD_NAME', name: 'NAME') do
@@ -95,4 +89,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

…ontent/inspec/resources/k8s_container.md docs-chef-io/content/k8s_container.mddocs-chef-io/content/inspec/resources/k8s_container.md renamed to docs-chef-io/content/k8s_container.md docs-chef-io/content/inspec/resources/k8s_container.md renamed to docs-chef-io/content/k8s_container.md

@@ -1,20 +1,15 @@
 +++
 title = "k8s_containers resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_containers"
 identifier = "inspec/resources/k8s/K8s Containers"
 parent = "inspec/resources/k8s"
 +++
 
 Use the `k8s_containers` Chef InSpec audit resource to test the configurations of all Containers in a namespace.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -62,23 +57,23 @@ end
 
 ## Examples
 
-### Containers for default namespace must exist
+Containers for default namespace must exist:
 
 ```ruby
  describe k8s_containers do
   it { should exist }
 end
 ```
 
-### Containers for specified namespace must exist
+Containers for specified namespace must exist:
 
 ```ruby
 describe k8s_containers(namespace: 'kube-system') do
   it { should exist }
 end
 ```
 
-### Containers with readOnlyRootFilesystem exists
+Containers with readOnlyRootFilesystem exists:
 
 ```ruby
 describe k8s_containers(namespace: 'kube-system').where{ securityContext && securityContext[:readOnlyRootFilesystem] == true } do 
@@ -89,4 +84,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}

…ntent/inspec/resources/k8s_containers.md docs-chef-io/content/k8s_containers.mddocs-chef-io/content/inspec/resources/k8s_containers.md renamed to docs-chef-io/content/k8s_containers.md docs-chef-io/content/inspec/resources/k8s_containers.md renamed to docs-chef-io/content/k8s_containers.md

@@ -1,21 +1,15 @@
 +++
 title = "k8s_cronjob resource"
 draft = false
-gh_repo = "inspec"
-platform = "k8s"
 
-[menu]
-[menu.inspec]
+[menu.k8s]
 title = "k8s_cronjob"
 identifier = "inspec/resources/k8s/K8s Cronjob"
 parent = "inspec/resources/k8s"
 +++
 
-
 Use the `k8s_cronjob` Chef InSpec audit resource to test the configuration of a specific CronJob in the specified namespace.
 
-## Installation
-
 ## Syntax
 
 ```ruby
@@ -63,7 +57,7 @@ end
 
 ## Examples
 
-### Cronjob for default namespace must exist and test its properties
+Cronjob for default namespace must exist and test its properties:
 
 ```ruby
 describe k8s_cronjob(name: 'HELLO') do
@@ -80,7 +74,7 @@ describe k8s_cronjob(name: 'HELLO') do
 end
 ```
 
-### Cronjob for a specified namespace must exist
+Cronjob for a specified namespace must exist:
 
 ```ruby
 describe k8s_cronjob(name: 'HELLO-WORLD', namespace: 'Namespace') do
@@ -90,4 +84,4 @@ end
 
 ## Matchers
 
-{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}
+{{< readfile file="content/reusable/md/inspec_matchers_link.md" >}}