From f31e05a9b87448b0e9dc69103414cd191618b857 Mon Sep 17 00:00:00 2001 From: Prateek Nandle Date: Sat, 16 Mar 2024 00:27:08 +0530 Subject: [PATCH] fix the broken documentation Signed-off-by: Prateek Nandle --- .web-docs/README.md | 4 +++- .web-docs/components/provisioner/kubearmor/README.md | 2 +- docs/README.md | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.web-docs/README.md b/.web-docs/README.md index 1699412..e3464e8 100644 --- a/.web-docs/README.md +++ b/.web-docs/README.md @@ -1,4 +1,6 @@ -The KubeArmor plugin for Packer which provides [KubeArmor Hardening Host Security policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide) for the build workloads. +# KubeArmor + +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. diff --git a/.web-docs/components/provisioner/kubearmor/README.md b/.web-docs/components/provisioner/kubearmor/README.md index 8c68bf8..289262a 100644 --- a/.web-docs/components/provisioner/kubearmor/README.md +++ b/.web-docs/components/provisioner/kubearmor/README.md @@ -1,6 +1,6 @@ Type: `kubearmor` - The `kubearmor` Packer 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. + 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. diff --git a/docs/README.md b/docs/README.md index ee78879..e3464e8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# KubeArmor Plugins +# KubeArmor A plugin for Packer which provides [KubeArmor Hardening Host Security policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide) for the build workloads. @@ -51,5 +51,5 @@ on [installing a plugin](https://developer.hashicorp.com/packer/docs/plugins/ins ### Provisioners -- [kubearmor](/packer/integrations/kubearmor/latest/components/provisioner/kubearmor) - The kubearmor provisioner is used to provisioner +- [kubearmor](/packer/integrations/kubearmor/kubearmor/latest/components/provisioner/kubearmor) - The kubearmor provisioner is used to provisioner Packer builds and provide the packer builds KubeArmor Host Security Policies.