Kubescape Prerequisites Checker analyzes your Kubernetes cluster and generates recommended Helm values to ensure Kubescape runs smoothly and efficiently.
- Kubeconfig configured for access to the Kubernetes cluster where you plan to deploy Armo.
There are two ways to run the check:
- Navigate to the command directory and Execute the program:
git clone https://github.com/kubescape/sizing-checker.git cd sizing-checker/ go run ./cmd/checker
- Permissions to create ServiceAccounts, ClusterRoles, ClusterRoleBindings, and Jobs.
-
Deploy the Kubernetes manifest:
Apply the Kubernetes manifest to set up the necessary resources:
kubectl apply -f k8s-manifest.yaml
-
Verify Job Completion:
Check the status and logs of the Job:
kubectl wait -n kubescape-prerequisite --for=condition=complete job/kubescape-prerequisite --timeout=60s kubectl logs -n kubescape-prerequisite job/kubescape-prerequisite
-
Export the Files:
Retrieve the
recommended-values.yaml
andprerequisites-report.html
from the ConfigMap:kubectl get -n kubescape-prerequisite configmap kubescape-prerequisites-report -n default -o go-template='{{ index .data "recommended-values.yaml" }}' > recommended-values.yaml kubectl get -n kubescape-prerequisite configmap kubescape-prerequisites-report -n default -o go-template='{{ index .data "prerequisites-report.html" }}' > prerequisites-report.html
-
Clean Up Resources After extracting the necessary files, remove the deployed resources to free up cluster space:
kubectl delete -f k8s-manifest.yaml
Use Helm to deploy Kubescape using the recommended values:
helm upgrade --install kubescape kubescape/kubescape-operator \
--namespace kubescape --create-namespace \
--values recommended-values.yaml [other parameters]
If you want to review the prerequisites report, open the HTML file:
Open in Browser:
- macOS:
open prerequisites-report.html
- Linux:
xdg-open prerequisites-report.html
- Windows (Git Bash):
start prerequisites-report.html
✅ Prerequisites report generated locally!
• /tmp/prerequisites-report.html (HTML report)
• /tmp/recommended-values.yaml (Helm values file)
📋 Open /tmp/prerequisites-report.html in your browser for details.
🚀 Use the generated recommended-values.yaml to optimize Kubescape for your cluster.
------------------------------------------------------------
kubectl logs job/kubescape-prerequisite
✅ Prerequisites report stored in Kubernetes ConfigMap!
• ConfigMap Name: prerequisites-report
• Namespace: default
------------------------------------------------------------
⬇️ To export the report and recommended values to local files, run the following commands:
kubectl get configmap kubescape-prerequisites-report -n default -o go-template='{{ index .data "prerequisites-report.html" }}' > prerequisites-report.html
kubectl get configmap kubescape-prerequisites-report -n default -o go-template='{{ index .data "recommended-values.yaml" }}' > recommended-values.yaml
📋 Open prerequisites-report.html in your browser for details.
🚀 Use the generated recommended-values.yaml to optimize Kubescape for your cluster.
------------------------------------------------------------