Skip to content

Commit ae8bebc

Browse files
JimBugwadiaJimBugwadia
committed
update website and docs
Signed-off-by: Jim Bugwadia <jim@nirmata.com>
1 parent ac4885e commit ae8bebc

File tree

6 files changed

+72
-5
lines changed

6 files changed

+72
-5
lines changed

‎config/_default/menus/menu.en.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@
1010
weight = 300
1111
url = "#community"
1212

13+
[[main]]
14+
name = "Docs"
15+
weight = 300
16+
url = "/docs"

‎content/en/_index.md‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "OpenReports"
33
linkTitle: "OpenReports"
44
---
55

6-
{{< blocks/cover title="" image_anchor="top" height="full" color="dark" >}}
6+
{{< blocks/cover title="" image_anchor="top" height="full" color="black" >}}
77

88
<img src="/images/OpenReports-Horizontal.png" alt="OpenReports" style="max-width: 800px; width: 100%; height: auto;">
99

@@ -12,11 +12,14 @@ linkTitle: "OpenReports"
1212
<H1>Standardized Reporting For Kubernetes</H1>
1313

1414
<div class="mt-5 mx-auto">
15-
<a class="btn btn-lg btn-primary mr-3 mb-4" href="#about">
16-
Learn More <i class="fa fa-chalkboard-teacher ml-2"></i>
15+
<a class="btn btn-lg btn-primary mr-3 mb-4" href="#about">
16+
Learn More <i class="fa fa-chalkboard-teacher ml-2"></i>
17+
</a>
18+
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="docs/api/">
19+
Get Started <i class="fa fa-arrow-alt-circle-right ml-2 "></i>
1720
</a>
1821

19-
<a class="btn btn-link text-info" href="#about" aria-label="Read more"><i class="fa fa-chevron-circle-down" style="font-size: 400%"></i></a>
22+
<a class="btn btn-link text-info" href="#about" aria-label="Read more"><i class="fa fa-chevron-circle-down" style="font-size: 400%"></i></a>
2023
</div>
2124

2225
{{< /blocks/cover >}}
@@ -34,7 +37,7 @@ OpenReports provides an API and tools for managing reports in Kubernetes.
3437
<br/>
3538

3639
<p style="line-height:1.5">
37-
OpenReports allows any Kubernetes controller, policy engine, or scanner to produce reports as a Kubernetes custom resource. Reports can then be consumed via kubectl, the OpenReports dashboard, or any other Kubernetes client. For high performance in large clusters, reports can be offloaded from etcd to a reporting database.
40+
OpenReports allows any Kubernetes controller, policy engine, or scanner to produce reports as a Kubernetes custom resource. Reports can then be consumed via kubectl, the OpenReports dashboard, or any other Kubernetes client. For high performance in large clusters, reports can be offloaded from etcd to a reporting database using an API aggregation service.
3841
</p>
3942

4043
<br/>
@@ -46,6 +49,19 @@ OpenReports provides an API and tools for managing reports in Kubernetes.
4649
<a href="https://github.com/openreports/reports-api/blob/main/docs/api-docs.md" target="_blank">Reference Documentation</a>
4750
{{% /blocks/feature %}}
4851

52+
{{% blocks/feature icon="fas fa-desktop" title="Web Console" %}}
53+
<a href="https://github.com/openreports/reports-api/blob/main/README.md#report-producers" target="_blank">Read More</a>
54+
{{% /blocks/feature %}}
55+
56+
{{% blocks/feature icon="fas fa-database" title="API Aggregation" %}}
57+
<a href="https://github.com/openreports/reports-api/blob/main/README.md#report-consumers" target="_blank">View Consumers</a>
58+
{{% /blocks/feature %}}
59+
60+
61+
{{% /blocks/section %}}
62+
63+
{{% blocks/section color="gray" type="row" %}}
64+
4965
{{% blocks/feature icon="fas fa-arrow-right" title="Report Producers" %}}
5066
<a href="https://github.com/openreports/reports-api/blob/main/README.md#report-producers" target="_blank">View Producers</a>
5167
{{% /blocks/feature %}}
@@ -54,6 +70,10 @@ OpenReports provides an API and tools for managing reports in Kubernetes.
5470
<a href="https://github.com/openreports/reports-api/blob/main/README.md#report-consumers" target="_blank">View Consumers</a>
5571
{{% /blocks/feature %}}
5672

73+
{{% blocks/feature icon="fas fa-map" title="Project Roadmap" %}}
74+
<a href="https://github.com/orgs/openreports/projects/1" target="_blank">View Roadmap</a>
75+
{{% /blocks/feature %}}
76+
5777
{{% /blocks/section %}}
5878

5979
{{% blocks/section color="light" type="row" %}}

‎content/en/docs/api-aggregation/_index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "API Aggregation Service"
3+
linkTitle: "API Aggregation Service"
4+
weight: 40
5+
description: Offload reports from etcd using API aggregation
6+
---
7+
8+
Due to etcd size and performance limitations, it is recommended that reports are stored in a separate database. The [Kyverno reports service](https://github.com/kyverno/reports-server) implements an API aggregation layer that allows offloading the cluster's etcd.
9+
10+
The [plan](https://github.com/orgs/openreports/projects/1) is to migrate this service to the OpenReports project.

‎content/en/docs/api/_index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "API Definition"
3+
linkTitle: "API Definition"
4+
weight: 10
5+
description: API definition for Kubernetes reports
6+
---
7+
8+
The OpenReports API is implemented as a Kuberneted Custom Resource Definition (CRD). It is maintained in the [reports-api](https://github.com/openreports/reports-api) repository.
9+
10+
For information on the API types view the [API Reference Documentation](https://github.com/openreports/reports-api/blob/main/docs/api-docs.md)
11+
12+
13+

‎content/en/docs/router/_index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Reports Routing Service"
3+
linkTitle: "Reports Routing Service"
4+
weight: 30
5+
description: Route reports to external targets
6+
---
7+
8+
The [Kyverno Policy Reporter](https://kyverno.github.io/policy-reporter-docs/policy-reporter/integrations.html) allows flexible routing of reports to various notification services.
9+
10+
The [plan](https://github.com/orgs/openreports/projects/1) is to migrate this service to the OpenReports project.

‎content/en/docs/web-console/_index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Web Console"
3+
linkTitle: "Web Console"
4+
weight: 20
5+
description: Web UI for reports
6+
---
7+
8+
The [Kyverno Policy Reporter](https://kyverno.github.io/policy-reporter-docs/policy-reporter-ui/introduction.html) offers a web UI for viewing reports.
9+
10+
The [plan](https://github.com/orgs/openreports/projects/1) is to migrate this UI to the OpenReports project.

0 commit comments

Comments
 (0)