# KuboScore

{% hint style="info" %}
**Looking to get started with KuboScore?**

Head to the [getting started](https://docs.kubolabs.io/getting-started/kuboscore) page.
{% endhint %}

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FB1bQgOTGTUpVSYDf0sfB%2Fkuboscore-cover.png?alt=media&#x26;token=4d2f9443-6e7a-448e-8dda-bd1a6952ca16" alt=""><figcaption></figcaption></figure>

KuboScore runs multiple scenarios on your clusters to check for potential **misconfigurations and bad practices** that will lead to **security incidents or performance issues**.

These scenarios are based on our extensive consulting experiences and years of practice. We crafted some **real life scenarios** that can be executed on your cluster to audit its **state, health, security level, configuration**, and much more.

It’s **free to use**, [**start analyzing your cluster configuration right away**](https://www.kuboscore.io/)**!**

## Features

### Real-life scenarios

KuboScore will run various scenarios that will check the configuration of:

* general cluster components
* core Kubernetes features for applications
* applications communications and traffic restrictions
* external traffic support
* Kubernetes restrictions mechanisms
* cloud services interconnections
* storage support
* security and compliance with security best practices
* important administrative features
* cluster configuration and availability of important add-ons
* existing workloads’ health and compliance with best practices

It will take about **20 to 30 minutes** to perform a complete analysis.

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FNTuqylZvn980e5hf3ARI%2Fkuboscore-analysis-logs.png?alt=media&#x26;token=b1e86f34-1d8c-429d-9bf2-4982853d9962" alt=""><figcaption><p>Follow an ongoing analysis (cloud mode).</p></figcaption></figure>

### Review the results

At the end of the process, you will be provided with a **global score** and some details regarding the scenarios that passed or failed.

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FE28WoMNDu5brMl9DXVYY%2Fkuboscore-report-summary.png?alt=media&#x26;token=774135f1-6fa1-4bad-8b12-e6a0848bbcac" alt=""><figcaption><p>Example of a free KuboScore page results.</p></figcaption></figure>

### Get your report

For more in-depth details about each scenario – like root causes, potential consequences or how to fix – you can purchase a **professional report** as well as an **enterprise grade report** to help you investigate and resolve reported configuration issues.

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FdlU9FP90TeQs8qMM2abP%2Fkuboscore-report-excerpt.png?alt=media&#x26;token=06a8e4ea-bd0e-40ac-884d-29bf2c5cf383" alt=""><figcaption><p>Excerpt from a professional report.</p></figcaption></figure>

## How does it work?

KuboScore is available in two different modes:

* **cloud** mode
* **local** mode

### Cloud mode

In **cloud mode**, we use the **Kubernetes API** to connect to your cluster and run our scenarios. Your cluster must be **publicly** reachable or behind a [*SSH bastion* to which we can connect](https://docs.kubolabs.io/guides/grant-access-to-a-private-network).

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FtFmZxsvT4IGbTFMqmdEN%2Fkuboscore-cluster-connection-details.png?alt=media&#x26;token=c34a105f-5881-45dd-ae6f-a42b703946d2" alt=""><figcaption><p>Connect KuboScore to your cluster.</p></figcaption></figure>

### Standalone mode

With KuboScore in **local mode**, you can perform a scoring of **any** cluster, as long as **you** can reach it.

You just need to install [KuboScore CLI](https://docs.kubolabs.io/getting-started/kuboscore/local-mode) and run it with [sufficient privileges on your cluster](https://docs.kubolabs.io/getting-started/kuboscore/cloud-mode#permissions)!

At the end of the scoring, you will get a **file** containing the **scoring results**. You can import this file in [KuboScore](https://kuboscore.io) to **review your results** and **get your report**.

<figure><img src="https://1027538846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FALaQyn9R5AiEIcVCAxPW%2Fuploads%2FTmHuRjOgYG8lqr98CLnU%2Fkuboscore-analysis-logs-standalone.png?alt=media&#x26;token=6af22f31-a4d6-4513-9890-7d21e0995da4" alt=""><figcaption><p>Follow an ongoing analysis (local mode).</p></figcaption></figure>

***

When the analysis is running, whatever mode you chose, **a bunch of resources will be created** on your cluster in order to **assess its state**. You will be able to **follow the execution** and see the **scenarios outcome**.

**Resources that we create are deleted** at the end of the scenarios, by the end of the analysis your cluster will be left **as if we were never there!**