Merge pull request #6 from Prateeknandle/main

updating docs

.goreleaser.yml

@@ -9,7 +9,7 @@ before:
     - go test ./...
     # As part of the release doc files are included as a separate deliverable for
     # consumption by Packer.io. To include a separate docs.zip uncomment the following command.
-    #- make ci-release-docs
+    - make ci-release-docs
     # Check plugin compatibility with required version of the Packer SDK
     - make plugin-check
 builds:

README.md

@@ -32,6 +32,10 @@ packer {
       source  = "github.com/hashicorp/ansible"
       version = "~> 1"
     }
+    kubearmor = {
+      version = ">= 0.0.1"
+      source = "github.com/hashicorp/kubearmor"
+    }
   }
 }
 

docs/README.md

@@ -1,5 +1,11 @@
 # KubeArmor Plugins
 
+A plugin for Packer which provides [KubeArmor Hardening Host Security policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide) for the build workloads.
+
+> [KubeArmor](https://docs.kubearmor.io/kubearmor/) is a security solution for the Kubernetes and cloud native platforms that helps protect your workloads from attacks and threats. It does this by providing a set of hardening policies that are based on industry-leading compliance and attack frameworks such as CIS, MITRE, NIST-800-53, and STIGs. These policies are designed to help you secure your workloads in a way that is compliant with these frameworks and recommended best practices.
+
+The KubeArmor provisioner will configure the build and provide the [KubeArmor Hardening Host Security Policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide). These hardening policies will be in the context of your workload, so you can see how they will be applied and what impact they will have on your system. This allows you to make informed decisions about which policies to apply, and helps you understand the trade-offs between security and functionality.
+
 <!--
   Include a short overview about the plugin.
 
@@ -25,9 +31,9 @@ Then, run [`packer init`](https://www.packer.io/docs/commands/init).
 ```hcl
 packer {
   required_plugins {
-    name = {
+    kubearmor = {
       version = ">= 0.0.1"
-      source  = "github.com/hashicorp/name"
+      source  = "github.com/hashicorp/kubearmor"
     }
   }
 }

docs/provisioners/kubearmor.mdx

@@ -20,6 +20,7 @@ Type: `kubearmor`
 
 ### Example Usage
 
+With docker uase case :
 
 ```hcl
 packer {
@@ -28,6 +29,10 @@ packer {
       version = ">= 0.0.7"
       source = "github.com/hashicorp/docker"
     }
+    kubearmor = {
+      version = ">= 0.0.1"
+      source = "github.com/hashicorp/kubearmor"
+    }
   }
 }
 
@@ -47,4 +52,46 @@ build {
   }
 }
 
+```
+
+With virtualbox use case :
+
+```
+packer {
+  required_plugins {
+    virtualbox-ovf = {
+      source  = "github.com/hashicorp/virtualbox"
+      version = "~> 1"
+    }
+    ansible = {
+      source  = "github.com/hashicorp/ansible"
+      version = "~> 1"
+    }
+    kubearmor = {
+      version = ">= 0.0.1"
+      source = "github.com/hashicorp/kubearmor"
+    }
+  }
+}
+
+source "virtualbox-ovf" "basic-example" {
+  source_path = "ubuntu20.ova"
+  ssh_username = ""
+  ssh_password = ""
+  shutdown_command = "echo 'packer' | sudo -S shutdown -P now"
+}
+
+build {
+  name = "learn-packer"
+  sources = ["sources.virtualbox-ovf.basic-example"]
+
+
+  provisioner "ansible" {
+    playbook_file = "./ansible/conf.yml"
+  }
+
+  provisioner "kubearmor" {
+    policyPath = "/home/prateek/policies"
+  }
+}
 ```

example/build.pkr.hcl

@@ -7,6 +7,10 @@ packer {
       version = ">= 0.0.7"
       source = "github.com/hashicorp/docker"
     }
+    kubearmor = {
+      version = ">= 0.0.1"
+      source = "github.com/hashicorp/kubearmor"
+    }
   }
 }