Update docs (#1634)

deepfence_worker/go.mod

@@ -79,11 +79,11 @@ require (
 	github.com/containerd/stargz-snapshotter/estargz v0.14.3 // indirect
 	github.com/containerd/ttrpc v1.2.2 // indirect
 	github.com/containerd/typeurl/v2 v2.1.1 // indirect
-	github.com/cyphar/filepath-securejoin v0.2.3 // indirect
+	github.com/cyphar/filepath-securejoin v0.2.4 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
 	github.com/deepfence/golang_deepfence_sdk/client v0.0.0-20230817093436-faaacc23dfd8 // indirect
-	github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230817093436-faaacc23dfd8 // indirect
+	github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230922050328-b19457df35dc // indirect
 	github.com/deepfence/vessel v0.11.1 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/docker/cli v24.0.2+incompatible // indirect

deepfence_worker/go.sum

@@ -178,16 +178,16 @@ github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSV
 github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/cyphar/filepath-securejoin v0.2.3 h1:YX6ebbZCZP7VkM3scTTokDgBL2TY741X51MTk3ycuNI=
-github.com/cyphar/filepath-securejoin v0.2.3/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4=
+github.com/cyphar/filepath-securejoin v0.2.4 h1:Ugdm7cg7i6ZK6x3xDF1oEu1nfkyfH53EtKeQYTC3kyg=
+github.com/cyphar/filepath-securejoin v0.2.4/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/decred/dcrd/crypto/blake256 v1.0.1/go.mod h1:2OfgNZ5wDpcsFmHmCK5gZTPcCXqlm2ArzUIkw9czNJo=
 github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 h1:8UrgZ3GkP4i/CLijOJx79Yu+etlyjdBU4sfcs2WYQMs=
 github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0/go.mod h1:v57UDF4pDQJcEfFUCRop3lJL149eHGSe9Jvczhzjo/0=
-github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230817093436-faaacc23dfd8 h1:dR65mjFib0ygj9kyn45q+64PuJfYsYBiRt08RWNklPw=
-github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230817093436-faaacc23dfd8/go.mod h1:C3CqMr7oE9RmHZWXIVDWFLuGaNDDaoSBSlILLQJxlew=
+github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230922050328-b19457df35dc h1:ssSB/g+JiOYBF4OB0m4cvGVcVaBPXf2KamJpEX9CDKI=
+github.com/deepfence/golang_deepfence_sdk/utils v0.0.0-20230922050328-b19457df35dc/go.mod h1:C3CqMr7oE9RmHZWXIVDWFLuGaNDDaoSBSlILLQJxlew=
 github.com/deepfence/vessel v0.11.1 h1:RSnPHv/HX9Vrcujxzp6l4cjzF7a/34lVvh+jr8Hq8YA=
 github.com/deepfence/vessel v0.11.1/go.mod h1:uSMZ7HZePuQzHH2kKdRJ/r8kYPz9ZgkffYhFiccmeHk=
 github.com/dgrijalva/jwt-go/v4 v4.0.0-preview1/go.mod h1:+hnT3ywWDTAFrW5aE+u2Sa/wT555ZqwoCS+pk3p6ry4=

docs/docs/architecture/cloudscanner.md

@@ -25,7 +25,7 @@ Each Cloud Scanner task runs in your cloud environment, gathering inventory and
 Cloud Scanner tasks are deployed using the appropriate Terraform module for each cloud, and are configured with the address and API key of your management console.  They 'phone home' to your management console and take instructions on demand; they do not listen for remote connections or control.
 
 :::info
-Refer to the Installation Documentation to [Learn how to install Cloud Scanner tasks](/docs/cloudscanner)
+Refer to the Installation Documentation to [Learn how to install Cloud Scanner tasks](/docs/v2.0/cloudscanner)
 :::
 
 

docs/docs/architecture/sensors.md

@@ -14,5 +14,5 @@ The sensors support the following production platforms:
 * **AWS Fargate** The sensor is deployed as a daemon service alongside each serverless instance.
 
 :::info
-Refer to the Installation Documentation to [Learn how to install Sensor Agents](/docs/sensors)
+Refer to the Installation Documentation to [Learn how to install Sensor Agents](/docs/v2.0/sensors)
 :::

docs/docs/cloudscanner/aws.md

@@ -102,7 +102,7 @@ Controls are grouped into **benchmarks**. Where multiple benchmarks are availabl
 
 When you run a compliance scan, you can select which benchmarks you wish to measure against, and ThreatMapper will then evaluate the appropriate controls and present the results, by benchmark, once the scan has completed.
 
-For full information, refer to [Operations: Compliance Scanning](/docs/operations/compliance).
+For full information, refer to [Operations: Compliance Scanning](/docs/v2.0/operations/compliance).
 
 :::tip Maximizing Coverage
 For maximum coverage, you can use both Cloud Scanner and local Sensor Agent compliance scans together. You could scan your AWS infrastructure using Cloud Scanner, and [scan selected VMs deployed within AWS](other) using the Sensor Agent.

docs/docs/cloudscanner/azure.md

@@ -45,7 +45,7 @@ Controls are grouped into **benchmarks**. Where multiple benchmarks are availabl
 
 When you run a compliance scan, you can select which benchmarks you wish to measure against, and ThreatMapper will then evaluate the appropriate controls and present the results, by benchmark, once the scan has completed.
 
-For full information, refer to [Operations: Compliance Scanning](/docs/operations/compliance).
+For full information, refer to [Operations: Compliance Scanning](/docs/v2.0/operations/compliance).
 
 :::tip Maximizing Coverage
 For maximum coverage, you can use both Cloud Scanner and local Sensor Agent compliance scans together. You could scan your Azure infrastructure using Cloud Scanner, and [scan selected VMs deployed within Azure](other) using the Sensor Agent.

docs/docs/cloudscanner/gcp.md

@@ -70,7 +70,7 @@ Controls are grouped into **benchmarks**. Where multiple benchmarks are availabl
 
 When you run a compliance scan, you can select which benchmarks you wish to measure against, and ThreatMapper will then evaluate the appropriate controls and present the results, by benchmark, once the scan has completed.
 
-For full information, refer to [Operations: Compliance Scanning](/docs/operations/compliance).
+For full information, refer to [Operations: Compliance Scanning](/docs/v2.0/operations/compliance).
 
 :::tip Maximizing Coverage
 For maximum coverage, you can use both Cloud Scanner and local Sensor Agent compliance scans together. You could scan your GCP infrastructure using Cloud Scanner, and [scan selected VMs deployed within GCP](other) using the Sensor Agent.

docs/docs/cloudscanner/index.md

@@ -10,7 +10,7 @@ The Cloud Scanner task interacts with the local cloud APIs under the instruction
 
 ## Before You Begin
 
-Review the architecture for compliance scanning, as described in [Architecture: Cloud Scanner task](/docs/architecture/cloudscanner).
+Review the architecture for compliance scanning, as described in [Architecture: Cloud Scanner task](/docs/v2.0/architecture/cloudscanner).
 
 
 ## Configuring Cloud Posture Management

docs/docs/cloudscanner/other.md

@@ -6,7 +6,7 @@ title: Other Platforms
 
 ThreatMapper can perform compliance posture scanning on linux hosts and Kubernetes master and worker nodes.
 
-Scanning is done directly, using a local [Sensor Agent](/docs/sensors) rather than by using the Cloud Scanner task employed by the cloud platform integrations.
+Scanning is done directly, using a local [Sensor Agent](/docs/v2.0/sensors) rather than by using the Cloud Scanner task employed by the cloud platform integrations.
 
 ## What Compliance Scans are Performed?
 
@@ -15,7 +15,7 @@ The sensor agent has direct visibility into the configuration of the base operat
 
 When you run a compliance scan, you can select which benchmarks you wish to measure against, and ThreatMapper will then evaluate the appropriate controls and present the results, by benchmark, once the scan has completed.
 
-For full information, refer to [Operations: Compliance Scanning](/docs/operations/compliance).
+For full information, refer to [Operations: Compliance Scanning](/docs/v2.0/operations/compliance).
 
 
 :::tip Maximizing Coverage

docs/docs/console/index.md

@@ -8,9 +8,9 @@ The ThreatMapper Management Console ("Console") is a standalone application, imp
 
 ## Before You Begin
 
-Review the architecture for the Management Console, as described in [Architecture: Management Console](/docs/architecture/console).
+Review the architecture for the Management Console, as described in [Architecture: Management Console](/docs/v2.0/architecture/console).
 
-Review the requirements for the Management Console, as described in [System Requirements](/docs/console/requirements).
+Review the requirements for the Management Console, as described in [System Requirements](/docs/v2.0/console/requirements).
 
 
 ## Installing the Management Console

docs/docs/developers/build.md

@@ -33,7 +33,7 @@ cd ThreatMapper/deployment-scripts
 docker-compose -f docker-compose.yml up --detach
 ```
 
-Once started, you can point a web browser at `https://--IP-ADDRESS---/` to register a first user on the Deepfence Management Console.  See [Initial Configuration](/docs/console/initial-configuration) for more information.
+Once started, you can point a web browser at `https://--IP-ADDRESS---/` to register a first user on the Deepfence Management Console.  See [Initial Configuration](/docs/v2.0/console/initial-configuration) for more information.
 
 To stop the Deepfence Management Console:
 

docs/docs/developers/deploy-agent.md

@@ -4,13 +4,13 @@ title: Deploy Sensors
 
 # Deploy custom ThreatMapper Sensor Agents
 
-You should first [build the management console and agents](build) and push the images to a suitable repository.  You can then adapt the standard installation instructions ([Docker](/docs/sensors/docker), [Kubernetes](/docs/sensors/kubernetes)) to refer to your custom images rather than the Deepfence-provided ones.
+You should first [build the management console and agents](build) and push the images to a suitable repository.  You can then adapt the standard installation instructions ([Docker](/docs/v2.0/sensors/docker), [Kubernetes](/docs/v2.0/sensors/kubernetes)) to refer to your custom images rather than the Deepfence-provided ones.
 
 
 ## Installing and Running the Sensor Agents on a Docker Host
 
 :::tip
-Refer to the [Docker Installation Instructions](/docs/sensors/docker) along with the modifications below.
+Refer to the [Docker Installation Instructions](/docs/v2.0/sensors/docker) along with the modifications below.
 :::
 
 Execute the following command to install and start the sensors:
@@ -42,7 +42,7 @@ docker run -dit \
 ## Installing and Running the Sensor Agents in a Kubernetes Cluster
 
 :::tip
-Refer to the [Kubernetes Installation Instructions](/docs/sensors/kubernetes) along with the modifications below.
+Refer to the [Kubernetes Installation Instructions](/docs/v2.0/sensors/kubernetes) along with the modifications below.
 :::
 
 You can use these instructions for helm-based installations in standalone and hosted Kubernetes clusters

docs/docs/developers/deploy-console.md

@@ -4,14 +4,14 @@ title: Deploy Console
 
 # Deploy a custom ThreatMapper Console
 
-You should first [build the management console](build) and push the images to a suitable repository.  You can then adapt the standard installation instructions ([Docker](/docs/console/docker), [Kubernetes](/docs/console/kubernetes)) to refer to your custom images rather than the Deepfence-provided ones.
+You should first [build the management console](build) and push the images to a suitable repository.  You can then adapt the standard installation instructions ([Docker](/docs/v2.0/console/docker), [Kubernetes](/docs/v2.0/console/kubernetes)) to refer to your custom images rather than the Deepfence-provided ones.
 
 
 
 ## Installing and Running the Management Console on a Docker Host
 
 :::tip
-Refer to the [Docker Installation Instructions](/docs/console/docker) along with the modifications below.
+Refer to the [Docker Installation Instructions](/docs/v2.0/console/docker) along with the modifications below.
 :::
 
 1. Download the file [docker-compose.yml](https://github.com/deepfence/ThreatMapper/blob/release-2.0/deployment-scripts/docker-compose.yml) to the system that will host the Console
@@ -31,12 +31,12 @@ Refer to the [Docker Installation Instructions](/docs/console/docker) along with
 ## Installing and Running the Management Console in a Kubernetes Cluster
 
 :::tip
-Refer to the [Kubernetes Installation Instructions](/docs/console/kubernetes) along with the modifications below.
+Refer to the [Kubernetes Installation Instructions](/docs/v2.0/console/kubernetes) along with the modifications below.
 :::
 
 1. Prepare the cluster, installing the storage driver and metrics service
 
-    Follow the instructions to install the OpenEBS storage and metrics server: [Installation Instructions](/docs/console/kubernetes)
+    Follow the instructions to install the OpenEBS storage and metrics server: [Installation Instructions](/docs/v2.0/console/kubernetes)
 
 
 2. Install your Management Console

docs/docs/integrations/index.md

@@ -4,7 +4,7 @@ title: Integrations
 
 # Integrations
 
-You can integrate ThreatMapper with a variety of notification services.  Any time a new vulnerability is detected (for example, during [CI](/docs/operations/scanning-ci) or an [automated scan](/docs/operations/scanning)), ThreatMapper will submit the details to the configured notification services.
+You can integrate ThreatMapper with a variety of notification services.  Any time a new vulnerability is detected (for example, during [CI](/docs/v2.0/operations/scanning-ci) or an [automated scan](/docs/v2.0/operations/scanning)), ThreatMapper will submit the details to the configured notification services.
 
 |    ![Integrations](../img/integrations.png)    |
 |:----------------------------------------------:|

docs/docs/kubernetes-scanner/index.md

@@ -10,4 +10,4 @@ NSA & CISA Cybersecurity Technical Report describes the complexities of securely
 
 ## Configuring Kubernetes Scanner
 
-Deepfence Kubernetes Scanner is installed with agent sensors. Follow the documentation [here](/docs/sensors/kubernetes) to install Deepfence agent sensors in the kubernetes cluster.
+Deepfence Kubernetes Scanner is installed with agent sensors. Follow the documentation [here](/docs/v2.0/sensors/kubernetes) to install Deepfence agent sensors in the kubernetes cluster.

docs/docs/operations/compliance.md

@@ -38,7 +38,7 @@ The benchmarks available vary by cloud provider:
 
 Begin on the **Posture** page in the ThreatMapper console.
 
-Select a cloud instance that you have [configured previously](/docs/cloudscanner/).  You may have several instances of a given cloud type:
+Select a cloud instance that you have [configured previously](/docs/v2.0/cloudscanner/).  You may have several instances of a given cloud type:
 
 | ![Cloud Compliance Scan - Select](../img/compliance-scan-1.png) |
 |:---------------------------------------------------------------:|
@@ -48,7 +48,7 @@ Select a cloud instance that you have [configured previously](/docs/cloudscanner
 |:---------------------------------------------------------------:|
 |             Select target for Cloud Compliance Scan             |
 
-If you want to scan a host (Linux host or Kubernetes master or slave node), ensure that the [threatmapper sensor](/docs/sensors) is deployed on that host.
+If you want to scan a host (Linux host or Kubernetes master or slave node), ensure that the [threatmapper sensor](/docs/v2.0/sensors) is deployed on that host.
 
 Select the compliance benchmarks you wish to run on the target cloud instance or host:
 

docs/docs/sensors/docker.md

@@ -6,7 +6,7 @@ title: Docker
 
 On a Linux-based Docker host, the ThreatMapper agents are deployed as a lightweight container.
 
-Install a docker runtime on the Linux host. Refer to the [Prerequisites for the Sensor Agents](/docs/architecture#threatmapper-sensor-containers) for minimum supported platforms.
+Install a docker runtime on the Linux host. Refer to the [Prerequisites for the Sensor Agents](/docs/v2.0/architecture#threatmapper-sensor-containers) for minimum supported platforms.
 
 For Windows Server hosts, experimental support exists, but it is not suitable for production use.
 

docs/docs/sensors/index.md

@@ -10,11 +10,11 @@ A single ThreatMapper Console can manage multiple workload types, and on-premise
 
 ## Before You Begin
 
-Before you install the Sensors, obtain the Management Console URL and API key as described in the [Initial Configuration](/docs/console/initial-configuration).
+Before you install the Sensors, obtain the Management Console URL and API key as described in the [Initial Configuration](/docs/v2.0/console/initial-configuration).
 
 You should take care to install the sensor version that matches your Management Console version, as compatibility across versions is not guaranteed.
 
-Review the architecture for the Sensor Agent, as described in [Architecture: Sensor Agent](/docs/architecture/sensors).
+Review the architecture for the Sensor Agent, as described in [Architecture: Sensor Agent](/docs/v2.0/architecture/sensors).
 
 ## System Requirements
 

docs/docs/sensors/linux-host.md

@@ -8,7 +8,7 @@ On a Linux-based bare-metal or virtual machine workload, the ThreatMapper sensor
 
 ## ThreatMapper Sensor Agents
 
-Install a docker runtime on the Linux host. Refer to the [Prerequisites for the Sensor Agents](/docs/architecture#threatmapper-sensor-containers) for minimum supported platforms.
+Install a docker runtime on the Linux host. Refer to the [Prerequisites for the Sensor Agents](/docs/v2.0/architecture#threatmapper-sensor-containers) for minimum supported platforms.
 
 Run the following command to start the Sensor Agent on the host. You can find the Deepfence API key under
  `Setting>User Management>API Key`.

docs/docs/tips/automating-scans.md

@@ -15,7 +15,7 @@ ThreatMapper can scan your production platforms periodically, using the most up-
 
 ## Automating ThreatMapper
 
-The results of automated scans are added to the **Vulnerability Scans** report, and can be raised through any configured [Notification](/docs/integrations) method.
+The results of automated scans are added to the **Vulnerability Scans** report, and can be raised through any configured [Notification](/docs/v2.0/integrations) method.
 
 ThreatMapper presents a series of APIs that you can use to enumerate nodes and run scans:
 

docs/versioned_docs/version-v1.5/architecture/cloudscanner.md

@@ -25,7 +25,7 @@ Each Cloud Scanner task runs in your cloud environment, gathering inventory and
 Cloud Scanner tasks are deployed using the appropriate Terraform module for each cloud, and are configured with the address and API key of your management console.  They 'phone home' to your management console and take instructions on demand; they do not listen for remote connections or control.
 
 :::info
-Refer to the Installation Documentation to [Learn how to install Cloud Scanner tasks](/docs/cloudscanner)
+Refer to the Installation Documentation to [Learn how to install Cloud Scanner tasks](/docs/v1.5/cloudscanner)
 :::
 
 

docs/versioned_docs/version-v1.5/architecture/sensors.md

@@ -14,5 +14,5 @@ The sensors support the following production platforms:
 * **AWS Fargate** The sensor is deployed as a daemon service alongside each serverless instance.
 
 :::info
-Refer to the Installation Documentation to [Learn how to install Sensor Agent containers](/docs/sensors)
+Refer to the Installation Documentation to [Learn how to install Sensor Agent containers](/docs/v1.5/sensors)
 :::

docs/versioned_docs/version-v1.5/cloudscanner/aws.md

@@ -102,7 +102,7 @@ Controls are grouped into **benchmarks**. Where multiple benchmarks are availabl
 
 When you run a compliance scan, you can select which benchmarks you wish to measure against, and ThreatMapper will then evaluate the appropriate controls and present the results, by benchmark, once the scan has completed.
 
-For full information, refer to [Operations: Compliance Scanning](/docs/operations/compliance).
+For full information, refer to [Operations: Compliance Scanning](/docs/v1.5/operations/compliance).
 
 :::tip Maximizing Coverage
 For maximum coverage, you can use both Cloud Scanner and local Sensor Agent compliance scans together. You could scan your AWS infrastructure using Cloud Scanner, and [scan selected VMs deployed within AWS](other) using the Sensor Agent.