Lintrule Documentation

    Dashboard

    Example: Kubernetes

    Create a new ruleset in the .rules directory:

    touch .rules/kubernetes.md
    

    Then, add a rule like the following:

    ---
    include: ["infra/*.yaml", "infra/*.yml"]
    ---
    
    Make sure our Kubernetes yaml files follow these rules:
    
    1. All Kubernetes resources must have a `metadata.name` field.
    2. Ensure that all sensitive data such as passwords, API keys, and tokens are using Kubernetes Secrets, not plain text in the YAML file.
    3. Don't use `latest` tag on container images, prefer a specific version.
    4. Setup liveness and readiness probes under `/healthz` and /readiness`