You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/_index.md
+8-21Lines changed: 8 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,30 +12,17 @@ description: >
12
12
13
13
Privateer is a validation framework that simplifies infrastructure testing and compliance validation. Built with infrastructure engineers in mind, Privateer helps you validate resources against regulations, taxonomies, and standards.
14
14
15
-
## Key Concepts
16
-
17
-
Privateer is built on several key concepts that work together to provide comprehensive validation:
18
-
19
-
| Concept | Description | Icon |
20
-
|---------|-------------|------|
21
-
|**Privateer Core**| An executable test harness that calls plugins based on the user's configuration | <imgsrc="/images/patches-small.png"alt="Privateer Core"width="80"> |
22
-
|**Privateer SDK**| A set of logic and tools used to establish efficient, secure, and cohesive collaboration between Privateer and its Plugins | <imgsrc="/images/sdk.svg"alt="SDK"width="80"> |
23
-
|**Plugin**| Responsible for executing validation tests and returning results to Privateer | <imgsrc="/images/plugin.svg"alt="Plugin"width="80"> |
24
-
|**EvaluationSuite**| Maps to control catalogs, following the "Simplified Compliance Infrastructure" model | <imgsrc="/images/testSuite.svg"alt="Test Suite"width="80"> |
25
-
|**Test Set**| A collection of related tests within an EvaluationSuite | <imgsrc="/images/testSet.svg"alt="Test Set"width="80"> |
26
-
|**Test**| Individual validation test within a Test Set | <imgsrc="/images/test.svg"alt="Test"width="80"> |
27
-
28
-
## Key Features
29
-
30
15
-**Community-Driven Plugins**: Plugins are crafted and maintained collaboratively by the community
31
16
-**Comprehensive Resource Validation**: Validate diverse resources in a single execution
32
17
-**Consistent Machine-Readable Output**: Standardized output simplifies automation and integration
33
18
-**Empowering Service Providers**: Certify resources for use in regulated industries
34
19
35
-
## Documentation Sections
36
-
37
-
### [For Users](/docs/users/)
38
-
Learn how to install and use Privateer to validate your infrastructure resources.
20
+
Privateer is built on several key concepts that work together to provide comprehensive validation:
39
21
40
-
### [For Developers](/docs/developers/)
41
-
Learn how to develop plugins and use the Privateer SDK.
22
+
||||
23
+
|---|---|---|
24
+
| <imgsrc="/images/anvil.svg"alt="anvil"width="100"> | Privateer SDK | provides common logic for Privateer and Plugins |
25
+
| <imgsrc="/images/ship.svg"alt="ship"width="100"height="100"> | Privateer Core | the main executable that runs plugins based on user configuration |
26
+
| <imgsrc="/images/map.svg"alt="map"width="100"> | Plugin | execute validation tests and return results to Privateer |
27
+
| <imgsrc="/images/cannon.svg"alt="cannon"width="100"> | EvaluationSuite | a set of related data allowing control IDs and their requirements to be mapped to one or more assessment steps |
28
+
| <imgsrc="/images/match.svg"alt="match"width="100"> | AssessmentStep | a specialized function which will analyze a data payload provided at runtime |
Privateer includes a command to generate a plugin from a YAML controls catalog document that complies with the [Gemara](https://gemara.openssf.org) Layer 2 schema.
14
14
@@ -70,19 +70,19 @@ A typical Privateer plugin includes the following components, organized hierarch
0 commit comments