Skip to content

Commit

Permalink
docs: add high-level diagram (aquasecurity#816)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
  • Loading branch information
danielpacak authored Nov 19, 2021
1 parent 966d31a commit 7701617
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ and some APIs and [Custom Resource Definitions] may change.
The official [Documentation] provides detailed installation, configuration, troubleshooting, and quick start guides.

Learn how to install the Starboard command [From the Binary Releases] and follow the [Getting Started][getting-started-cli]
guide to generate your first vulnerability and configuration audit reports!
guide to generate your first vulnerability and configuration audit reports.

You can install the Starboard Operator with [Static YAML Manifests] and follow the [Getting Started][getting-started-operator]
guide to see how vulnerability and configuration audit reports are generated automatically.
Expand Down
22 changes: 17 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ Starboard provides:
- [Custom Resource Definitions] and a [Go module] to work with and integrate a range of security scanners.
- The [Octant Plugin] and the [Lens Extension] that make security reports available through familiar Kubernetes interfaces.

<figure>
<img src="./images/starboard-overview.png" />
<figcaption>The high-level design diagram of Starboard toolkit.</figcaption>
</figure>

Starboard can be used:

- As a [Kubernetes operator] to automatically update security reports in response to workload and other changes on a
Expand All @@ -28,10 +33,16 @@ Starboard can be used:

## What's Next?

- Follow the getting started guides for [Starboard CLI](./cli/getting-started.md) and [Starboard Operator](./operator/getting-started.md).
- Read more about the motivations and use cases on the [Starboard: The Kubernetes-Native Toolkit for Unifying Security][use-cases] blog.
- Learn how to install the Starboard command [From the Binary Releases](./cli/installation/binary-releases.md) and
follow the [Getting Started](./cli/getting-started.md) guide to generate your first vulnerability and configuration
audit reports.
- Install the Starboard Operator with [Static YAML Manifests](./operator/installation/kubectl.md) and follow the
[Getting Started](./operator/getting-started.md) guide to see how vulnerability and configuration audit reports are
generated automatically.
- Read more about the motivations for the project in the [Starboard: The Kubernetes-Native Toolkit for Unifying Security]
blog.
- See a detailed introduction to Starboard with demos at [KubeCon + CloudNativeCon NA 2020][kubecon-video].
- Join our [discussions] on GitHub.
- Join the community, and talk to us about any matter in [GitHub Discussions] or [Slack].

[Custom Resource Definitions]: ./crds/index.md
[cli]: cli/index.md
Expand All @@ -40,7 +51,8 @@ Starboard can be used:
[Octant Plugin]: ./integrations/octant.md
[Lens Extension]: integrations/lens.md
[kubectl]: https://kubernetes.io/docs/reference/kubectl/
[use-cases]: https://blog.aquasec.com/starboard-kubernetes-tools
[discussions]: https://github.com/aquasecurity/starboard/discussions
[Starboard: The Kubernetes-Native Toolkit for Unifying Security]: https://blog.aquasec.com/starboard-kubernetes-tools
[GitHub Discussions]: https://github.com/aquasecurity/starboard/discussions/
[Slack]: https://slack.aquasec.com/
[kubecon-video]: https://www.youtube.com/watch?v=cgcwIY1HVI0
[kube-hunter]: https://github.com/aquasecurity/kube-hunter

0 comments on commit 7701617

Please sign in to comment.