google · mikouaj · Aug 3, 2023 · Aug 2, 2023 · Aug 3, 2023 · Aug 3, 2023
diff --git a/gke-policies-v2/README.md b/gke-policies-v2/README.md
diff --git a/gke-policies-v2/policy/cluster_gce_csi_driver.rego b/gke-policies-v2/policy/cluster_gce_csi_driver.rego
@@ -14,7 +14,7 @@
 
 # METADATA
 # title: Use Compute Engine persistent disk CSI driver
-# description: Automatic deployment and management of the Compute Engine persisten disk CSI driver. The driver provides support for features like customer managed encryption keys or volume snapshots.
+# description: Automatic deployment and management of the Compute Engine persistent disk CSI driver. The driver provides support for features like customer managed encryption keys or volume snapshots.
 # custom:
 #   group: Management
 #   severity: Medium

diff --git a/gke-policies-v2/policy/node_pool_integrity_monitoring.rego b/gke-policies-v2/policy/node_pool_integrity_monitoring.rego
@@ -14,7 +14,7 @@
 
 # METADATA
 # title: Integrity monitoring on the nodes
-# description: GKE node pools should have integrity monitoring feature enabled to detect changes in a VM boot measurments
+# description: GKE node pools should have integrity monitoring feature enabled to detect changes in a VM boot measurements
 # custom:
 #   group: Security
 #   severity: Critical

diff --git a/gke-policies-v2/scalability/limits_hpas.rego b/gke-policies-v2/scalability/limits_hpas.rego
@@ -14,7 +14,7 @@
 
 # METADATA
 # title: Number of HPAs in a cluster
-# description: The optimal number of Horizonal Pod Autoscalers in a cluster
+# description: The optimal number of Horizontal Pod Autoscalers in a cluster
 # custom:
 #   group: Scalability
 #   severity: Medium

diff --git a/gke-policies/README.md b/gke-policies/README.md
diff --git a/gke-policies/policy/cluster_gce_csi_driver.rego b/gke-policies/policy/cluster_gce_csi_driver.rego
@@ -14,7 +14,7 @@
 
 # METADATA
 # title: Use Compute Engine persistent disk CSI driver
-# description: Automatic deployment and management of the Compute Engine persisten disk CSI driver. The driver provides support for features like customer managed encryption keys or volume snapshots.
+# description: Automatic deployment and management of the Compute Engine persistent disk CSI driver. The driver provides support for features like customer managed encryption keys or volume snapshots.
 # custom:
 #   group: Management
 #   severity: Medium

diff --git a/gke-policies/policy/node_pool_integrity_monitoring.rego b/gke-policies/policy/node_pool_integrity_monitoring.rego
@@ -14,7 +14,7 @@
 
 # METADATA
 # title: Integrity monitoring on the nodes
-# description: GKE node pools should have integrity monitoring feature enabled to detect changes in a VM boot measurments
+# description: GKE node pools should have integrity monitoring feature enabled to detect changes in a VM boot measurements
 # custom:
 #   group: Security
 #   severity: Critical

diff --git a/internal/outputs/documentation.go b/internal/outputs/documentation.go
@@ -22,7 +22,10 @@ import (
 	"github.com/google/gke-policy-automation/internal/policy"
 )
 
-const defaultPolicyDocFileURLPrefix = "../"
+const (
+	defaultPolicyDocFileURLPrefix = "../"
+	cisGKEURL                     = "https://cloud.google.com/kubernetes-engine/docs/concepts/cis-benchmarks#accessing-gke-benchmark"
+)
 
 type PolicyDocumentation interface {
 	GenerateDocumentation() string
@@ -50,12 +53,15 @@ func (m *MarkdownPolicyDocumentation) GenerateDocumentation() string {
 		return m.policies[i].Group < m.policies[j].Group
 	})
 	var sb strings.Builder
-
-	sb.WriteString("|Group|Title|Description|File|\n|-|-|-|-|\n")
+	sb.WriteString("|Name|Group|Description|CIS Benchmark|\n|-|-|-|-|\n")
 
 	for _, p := range m.policies {
 		policyFileURL := fmt.Sprintf("%s%s", m.policyDocFileURLPrefix, p.File)
-		sb.WriteString(fmt.Sprintf("|%s|%s|%s|[%s](%s)|\n", p.Group, p.Title, p.Description, p.File, policyFileURL))
+		cis := ""
+		if p.CisVersion != "" && p.CisID != "" {
+			cis = fmt.Sprintf("[CIS GKE](%s) %s: %s", cisGKEURL, p.CisVersion, p.CisID)
+		}
+		sb.WriteString(fmt.Sprintf("|[%s](%s)|%s|%s|%s|\n", p.Title, policyFileURL, p.Group, p.Description, cis))
 	}
 
 	return sb.String()

diff --git a/internal/outputs/documentation_test.go b/internal/outputs/documentation_test.go
@@ -36,6 +36,8 @@ func buildPoliciesMetadata() []*policy.Policy {
 			Description: "Third description",
 			Group:       "Group 1",
 			File:        "gke-policies/file3.rego",
+			CisVersion:  "1.2",
+			CisID:       "5.3.1",
 		},
 		{
 			Title:       "First policy",
@@ -48,9 +50,9 @@ func buildPoliciesMetadata() []*policy.Policy {
 
 func TestMarkdownDocumention(t *testing.T) {
 	var sb strings.Builder
-	fmt.Fprintf(&sb, "|Group 1|First policy|First description|[gke-policies/file1.rego](%sgke-policies/file1.rego)|\n", defaultPolicyDocFileURLPrefix)
-	fmt.Fprintf(&sb, "|Group 1|Third policy|Third description|[gke-policies/file3.rego](%sgke-policies/file3.rego)|\n", defaultPolicyDocFileURLPrefix)
-	fmt.Fprintf(&sb, "|Group 2|Second policy|Second description|[gke-policies/file2.rego](%sgke-policies/file2.rego)|\n", defaultPolicyDocFileURLPrefix)
+	fmt.Fprintf(&sb, "|[First policy](%sgke-policies/file1.rego)|Group 1|First description||\n", defaultPolicyDocFileURLPrefix)
+	fmt.Fprintf(&sb, "|[Third policy](%sgke-policies/file3.rego)|Group 1|Third description|[CIS GKE](%s) 1.2: 5.3.1|\n", defaultPolicyDocFileURLPrefix, cisGKEURL)
+	fmt.Fprintf(&sb, "|[Second policy](%sgke-policies/file2.rego)|Group 2|Second description||\n", defaultPolicyDocFileURLPrefix)
 	expected := sb.String()
 
 	generator := NewMarkdownPolicyDocumentation(buildPoliciesMetadata())