From 494d9f1a95cb04dfba4dd5a3349995b99c9bf3b2 Mon Sep 17 00:00:00 2001
From: ssube <seansube@gmail.com>
Date: Sat, 15 Jun 2019 22:51:03 -0500
Subject: [PATCH] lint(rules): comment up the k8s rules

---
 rules/kubernetes.yml | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/rules/kubernetes.yml b/rules/kubernetes.yml
index 7068167..5b6f25a 100644
--- a/rules/kubernetes.yml
+++ b/rules/kubernetes.yml
@@ -7,8 +7,6 @@ rules:
       - important
 
     select: '$.spec.template.spec.containers[*]'
-    filter:
-      type: object
 
     check:
       type: object
@@ -47,6 +45,8 @@ rules:
       - optional
 
     select: '$.spec.template.spec.containers[*].resources'
+
+    # filter low-cpu resource limits
     filter:
       type: object
       properties:
@@ -57,6 +57,7 @@ rules:
               type: string
               pattern: "[0-9]{1,3}m"
 
+    # ensure the limits aren't *too* low
     check:
       type: object
       properties:
@@ -68,12 +69,15 @@ rules:
               pattern: "[0-9]{3}m"
 
   - name: kubernetes-deployment-replicas
-    desc: deployments must specify a replica count
+    desc: deployments must specify a positive replica count
     level: info
     tags:
       - important
 
+    # select the root of the document
     select: '$'
+
+    # filter deployments
     filter:
       type: object
       properties:
@@ -81,6 +85,7 @@ rules:
           type: string
           const: Deployment
 
+    # ensure replicas are greater than 0
     check:
       type: object
       properties: