From 770161714921659e240391c1ab6680b05ce720fe Mon Sep 17 00:00:00 2001 From: Daniel Pacak Date: Fri, 19 Nov 2021 14:33:53 +0100 Subject: [PATCH] docs: add high-level diagram (#816) Signed-off-by: Daniel Pacak --- README.md | 2 +- docs/index.md | 22 +++++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9cf74a727..f1528746a 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/index.md b/docs/index.md index 83eb22d62..588b8df3c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. +
+ +
The high-level design diagram of Starboard toolkit.
+
+ Starboard can be used: - As a [Kubernetes operator] to automatically update security reports in response to workload and other changes on a @@ -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 @@ -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 \ No newline at end of file