From bdccf72338ba3e501d14db857db566b356e116ca Mon Sep 17 00:00:00 2001 From: Anais Urlichs <33576047+AnaisUrlichs@users.noreply.github.com> Date: Wed, 8 Mar 2023 12:23:17 +0000 Subject: [PATCH] docs: changing docs in accordance with #3460 (#3787) --- docs/getting-started/faq.md | 5 +++ docs/index.md | 7 --- docs/tutorials/kubernetes/cluster-scanning.md | 45 ++----------------- mkdocs.yml | 1 + 4 files changed, 9 insertions(+), 49 deletions(-) create mode 100644 docs/getting-started/faq.md diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md new file mode 100644 index 00000000000..b4a6340fdac --- /dev/null +++ b/docs/getting-started/faq.md @@ -0,0 +1,5 @@ +## FAQ + +### How to pronounce the name "Trivy"? + +`tri` is pronounced like **tri**gger, `vy` is pronounced like en**vy**. diff --git a/docs/index.md b/docs/index.md index ab2a23fafc5..03bd6a72dbe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -108,13 +108,6 @@ trivy k8s --report summary cluster - -## FAQ - -### How to pronounce the name "Trivy"? - -`tri` is pronounced like **tri**gger, `vy` is pronounced like en**vy**. - --- Trivy is an [Aqua Security][aquasec] open source project. diff --git a/docs/tutorials/kubernetes/cluster-scanning.md b/docs/tutorials/kubernetes/cluster-scanning.md index 5a005a103d9..d8f3e40ef95 100644 --- a/docs/tutorials/kubernetes/cluster-scanning.md +++ b/docs/tutorials/kubernetes/cluster-scanning.md @@ -70,50 +70,11 @@ This has several benefits: There are several ways that you can install the Trivy Operator in your cluster. In this guide, we’re going to use the Helm installation based on the [following documentation.](../../docs/target/kubernetes.md#trivy-operator) -Make sure that you have the [Helm CLI installed.](https://helm.sh/docs/intro/install/) -Next, run the following commands. +Please follow the Trivy Operator documentation for further information on: -First, we are going to add the Aqua Security Helm repository to our Helm repository list: -``` -helm repo add aqua https://aquasecurity.github.io/helm-charts/ -``` - -Then, we will update all of our Helm repositories. Even if you have just added a new repository to your existing charts, this is generally good practice to have access to the latest changes: -``` -helm repo update -``` - -Lastly, we can install the Trivy operator Helm Chart to our cluster: -``` -helm install trivy-operator aqua/trivy-operator \ - --namespace trivy-system \ - --create-namespace \ - --set="trivy.ignoreUnfixed=true" \ - --version v0.0.3 -``` - -You can make sure that the operator is installed correctly via the following command: -``` -kubectl get deployment -n trivy-system -``` +- [Installation of the Trivy Operator](https://aquasecurity.github.io/trivy-operator/latest/getting-started/installation/) +- [Getting started guide](https://aquasecurity.github.io/trivy-operator/latest/getting-started/quick-start/) -Trivy will automatically start scanning your Kubernetes resources. -For instance, you can view vulnerability reports with the following command: - -``` -kubectl get vulnerabilityreports --all-namespaces -o wide -``` - -And then you can access the details of a security scan: -``` -kubectl describe vulnerabilityreports -``` - -The same process can be applied to access Configauditreports: - -``` -kubectl get configauditreports --all-namespaces -o wide -``` diff --git a/mkdocs.yml b/mkdocs.yml index a43608e48fa..16790b74eb5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,6 +10,7 @@ nav: - Getting Started: - Overview: index.md - Installation: getting-started/installation.md + - FAQ: getting-started/faq.md - Tutorials: - Overview: tutorials/overview.md - CI/CD: