updated the readme to include the security metrics integration part #1784
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ezzeddinemtar
requested review from
anatheka,
lebogg and
oxisto
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1784 +/- ##
=======================================
Coverage 78.49% 78.49%
=======================================
Files 147 147
Lines 12255 12255
=======================================
Hits 9619 9619
Misses 2260 2260
Partials 376 376
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
immqu
reviewed
Aug 26, 2025
| go build -o ./engine cmd/engine/engine.go | ||
| ``` | ||
|
|
||
| ## Security metrics integration |
Contributor
There was a problem hiding this comment.
This section contains valuable info! Still, I think it is too detailed for the general Readme; let's move this part to the policies folder and instead just add a short paragraph about the metrics repo here.
anatheka
reviewed
Sep 15, 2025
| > Note: We are currently preparing a `v2` release of Clouditor, which will be somewhat incompatible with regards to storage to `v1`. The APIs will remain largely the same, but will be improved and cleaned. We will regularly release pre-release `v2` versions, but do not have a concrete time-frame for a stable `v2` yet. | ||
| > | ||
| > If you are looking for a stable version, please use the [v1.10.1](https://github.com/clouditor/clouditor/releases/tag/v10.10.1) release. | ||
| > If you are looking for a stable version, please use the [v1.10.1](https://github.com/clouditor/clouditor/releases/tag/v1.10.1) release. |
Member
There was a problem hiding this comment.
The last stable version is v1.10.1, the release version, see in the Clouditor repo:
| - granular report of detected non-compliant configurations | ||
| - quick and adaptive integration with existing service through automated service discovery | ||
| - descriptive development of custom rules using [Cloud Compliance Language (CCL)](clouditor-engine-azure/src/main/resources/rules/azure/compute/vm-data-encryption.md) to support individual evaluation scenarios | ||
| - curated security metrics integrated from the external Security Metrics repository |
Member
There was a problem hiding this comment.
Please add a link to the security metrics repo
| ## Quick start with UI | ||
|
|
||
| In order to just build and run the Clouditor, without generating the protobuf file, one can use the `run-engine-with-ui.sh` script. This still requires Go and Node.js to be installed. For example, to run the engine in-memory with the Azure provider the following command can be used: | ||
| To quickly build and run Clouditor without generating protobuf files, you can use the `run-engine-with-ui.sh` script. This still requires Go and Node.js to be installed. For example, to run the engine in memory with the Azure provider, use: |
Member
There was a problem hiding this comment.
Here, 'in-memory' must be used.
| git add policies/security-metrics && git commit -m "chore: bump security-metrics" | ||
| ``` | ||
|
|
||
| Notes: |
Member
There was a problem hiding this comment.
I think the first bullet point is important, the other two we do not need here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related to issue : #1763