From 1acea2cc1c5643b89ffc38e3277b80f7f036447b Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Mon, 16 Oct 2023 14:58:13 +0200 Subject: [PATCH 1/3] Fix baseurl in the production env Because reviewers get confused when the breadcrumb links point to the main site --- config/production/config.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/production/config.toml b/config/production/config.toml index 1b0e529..2ddd693 100644 --- a/config/production/config.toml +++ b/config/production/config.toml @@ -1,4 +1,4 @@ -baseurl = "https://openclarity.io/" +baseurl = "https://docs.openclarity.io/" buildDrafts = false #googleAnalytics = "G-FIXME" @@ -9,4 +9,4 @@ buildDrafts = false [params] -url_latest_version = "https://openclarity.io/" \ No newline at end of file +url_latest_version = "https://docs.openclarity.io/" \ No newline at end of file From abedafa8cf1d94a133e72297a4592a994ae9b846 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Mon, 16 Oct 2023 15:20:49 +0200 Subject: [PATCH 2/3] Don't use runtime scans in plural in titles Nor at other places where its not needed --- content/docs/kubeclarity/concepts/runtime-scans/_index.md | 8 ++++---- content/docs/kubeclarity/private-registry/cli/_index.md | 2 +- content/docs/kubeclarity/runtime-scans/_index.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/kubeclarity/concepts/runtime-scans/_index.md b/content/docs/kubeclarity/concepts/runtime-scans/_index.md index 737e240..992f15a 100644 --- a/content/docs/kubeclarity/concepts/runtime-scans/_index.md +++ b/content/docs/kubeclarity/concepts/runtime-scans/_index.md @@ -1,7 +1,7 @@ --- -title: Kubernetes clusters runtime scans +title: Kubernetes cluster runtime scan weight: 200 -linktitle: Runtime scans +linktitle: Runtime scan --- {{< include-headless "kubeclarity/intro-runtime-scans.md" >}} @@ -10,7 +10,7 @@ linktitle: Runtime scans KubeClarity enhance the runtime scanning experience: -### Faster runtime scans +### Faster runtime scan KubeClarity optimizes the scanning process, reducing the time required to detect vulnerabilities. This allows for quicker identification and remediation of potential security risks. @@ -28,6 +28,6 @@ The following figure illustrates the structure of a runtime scanning architectur ![KubeClarity Runtime Scan Architecture](runtime-scan-architecture.png) -## Perform runtime scans +## Perform runtime scan For details on performing runtime scans with KubeClarity, see the {{% xref "/docs/kubeclarity/getting-started/_index.md" %}} and {{% xref "/docs/kubeclarity/runtime-scans/_index.md" %}}. diff --git a/content/docs/kubeclarity/private-registry/cli/_index.md b/content/docs/kubeclarity/private-registry/cli/_index.md index 0cfc058..2d77e0f 100644 --- a/content/docs/kubeclarity/private-registry/cli/_index.md +++ b/content/docs/kubeclarity/private-registry/cli/_index.md @@ -4,7 +4,7 @@ linktitle: CLI weight: 100 --- -The KubeClarity CLI can read a configuration file that stores credentials for private registries. +The KubeClarity CLI can read a configuration file that stores credentials for private registries. (For details, on using an external configuration file, see {{% xref "/docs/kubeclarity/external-config-file-cli/_index.md" %}}). Example registry section of the configuration file: diff --git a/content/docs/kubeclarity/runtime-scans/_index.md b/content/docs/kubeclarity/runtime-scans/_index.md index d0a98e8..83c7d34 100644 --- a/content/docs/kubeclarity/runtime-scans/_index.md +++ b/content/docs/kubeclarity/runtime-scans/_index.md @@ -5,4 +5,4 @@ weight: 800 {{< include-headless "kubeclarity/intro-runtime-scans.md" >}} -For details on the concepts of KubeClarity runtime scans, see {{% xref "/docs/kubeclarity/concepts/runtime-scans/_index.md" %}}. +For details on the concepts of KubeClarity runtime scan, see {{% xref "/docs/kubeclarity/concepts/runtime-scans/_index.md" %}}. From 6c50a316ecb6f1dfe954a1cbd50ba77b5807c03e Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Mon, 16 Oct 2023 15:25:07 +0200 Subject: [PATCH 3/3] Mention why AWS prerequisites are needed --- .../getting-started/install-kubeclarity-backend/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/kubeclarity/getting-started/install-kubeclarity-backend/_index.md b/content/docs/kubeclarity/getting-started/install-kubeclarity-backend/_index.md index 922d55e..aa365ff 100644 --- a/content/docs/kubeclarity/getting-started/install-kubeclarity-backend/_index.md +++ b/content/docs/kubeclarity/getting-started/install-kubeclarity-backend/_index.md @@ -20,7 +20,7 @@ KubeClarity requires these Kubernetes permissions: ### Prerequisites for AWS -If you are installing KubeClarity on AWS, complete the following steps: +If you are installing KubeClarity on AWS, complete the following steps. These are needed because KubeClarity uses a persistent PostgreSQL database, and that requires a volume. 1. Make sure that your EKS cluster is 1.23 or higher. 1. Install the **EBS CSI Driver** EKS add-on. For details, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html).