Skip to content

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

License

Notifications You must be signed in to change notification settings

komodorio/validkube

Repository files navigation

validkube

TypeScript GitHub go.mod Go version of a Go module Docker

About this project

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

Open - Source Contribution

  • If you want to contribute, this repository is in build, so feel at home :)

If you like ValidKube, share with your friends and be sure to ⭐ it!

Please read contributing guidelines before submitting new Resources.

Capabilities:

Policies - A combination of security and best practices.

  • Validate - Verify your Kubernetes configuration files @kubeconform
  • Clean - Remove clutter from your Kubernetes manifests @kubectl-neat
  • Secure (Trivy) - Scan your YAML code for security vulnerabilities @trivy
  • Secure (Kubescape) - Scan your YAML file for Devops best practices and security vulnerabilities @kubescape
  • Audit (Polaris) - Enforce best practices in your Kubernetes clusters @polaris

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

Prerequisites


OS tools:

K8s CLI tools:

Deploy


Full deploy:

make deploy

Deploy backend:

make deploy-backend

In order to update web domain:

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

Deploy frontend:

make deploy-frontend

Local Environment


To run locally, set 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