README.md

validkube

About this project

Validkube combines the best open-source tools to help ensure Kubernetes YAML best practices, hygiene & security.

Capabilities:

• Validate - Verify your Kubernetes configuration files @kubeval
• Clean - Remove clutter from your Kubernetes manifests @kubectl-neat
• Secure - Scan your YAML code for security vulnerabilities @trivy

Validkube is an open-source site, so please feel free to add more tools or capabilities. :)

Prerequisites

---

• AWS CLI with access to your AWS
• Yarn
• NPM
• Serverless CLI
• Golang v1.17

Deploy

---

Deploy backend:

    make deploy

In order to update web domain:

    aws ssm put-parameter --name /validkube/config/allowed_origin --type String --value {frontend-domain} --overwrite

Deploy frontend:

    cd frontend
    make deploy

Local environment

---

In order to run this locally, specify 'ALLOWED_ORIGIN' environment variable to 'http://localhost:3000'

Example in Linux:

    export ALLOWED_ORIGIN=http://localhost:3000

In order to start backend:

    go mod download
    go run backend/development/localdev.go

In order to start frontend:

    cd frontend
    yarn install
    yarn start