Update docs

deepfence · Oct 7, 2024 · ea41777 · ea41777
1 parent f6f1f75
commit ea41777
Show file tree

Hide file tree

Showing 177 changed files with 4,939 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 [![GitHub stars](https://img.shields.io/github/stars/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/stargazers)
 [![Hacktoberfest](https://img.shields.io/github/hacktoberfest/2022/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/issues)
 [![GitHub issues](https://img.shields.io/github/issues/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/issues)
-[![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.3/)
-[![Demo](https://img.shields.io/badge/threatmapper-demo-green)](https://community.deepfence.io/threatmapper/docs/v2.3/demo)
+[![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.4/)
+[![Demo](https://img.shields.io/badge/threatmapper-demo-green)](https://community.deepfence.io/threatmapper/docs/v2.4/demo)
 [![Docker pulls](https://img.shields.io/docker/pulls/deepfenceio/deepfence_agent_ce)](https://hub.docker.com/r/deepfenceio/deepfence_agent_ce)
 [![Slack](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ)
 [![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fdeepfence%2FThreatMapper)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fdeepfence%2FThreatMapper)
@@ -20,9 +20,9 @@ Deepfence ThreatMapper hunts for threats in your production platforms, and ranks
 
 With ThreatMapper's **ThreatGraph** visualization, you can then identify the issues that present the greatest risk to the security of your applications, and prioritize these for planned protection or remediation.
 
-* [Learn more about ThreatMapper](https://community.deepfence.io/threatmapper/docs/v2.3/) in the product documentation.
+* [Learn more about ThreatMapper](https://community.deepfence.io/threatmapper/docs/v2.4/) in the product documentation.
 
-* [See ThreatMapper running](https://community.deepfence.io/threatmapper/docs/v2.3/demo) in the live demo sandbox.
+* [See ThreatMapper running](https://community.deepfence.io/threatmapper/docs/v2.4/demo) in the live demo sandbox.
 
 ## When to use ThreatMapper
 
@@ -45,7 +45,7 @@ ThreatMapper consists of two components:
 
 ### The Management Console
 
-You [deploy the Management Console first](https://community.deepfence.io/threatmapper/docs/v2.3/console/), on a suitable docker host or Kubernetes cluster.  For example, on Docker:
+You [deploy the Management Console first](https://community.deepfence.io/threatmapper/docs/v2.4/console/), on a suitable docker host or Kubernetes cluster.  For example, on Docker:
 
 ```shell script
 # Docker installation process for ThreatMapper Management Console
@@ -54,25 +54,25 @@ wget https://github.com/deepfence/ThreatMapper/raw/release-2.4/deployment-script
 docker-compose -f docker-compose.yml up --detach
 ```
 
-Once the Management Console is up and running, you can [register an admin account and obtain an API key](https://community.deepfence.io/threatmapper/docs/v2.3/console/initial-configuration).
+Once the Management Console is up and running, you can [register an admin account and obtain an API key](https://community.deepfence.io/threatmapper/docs/v2.4/console/initial-configuration).
 
 ### Cloud Scanner tasks
 
-ThreatMapper [Cloud Scanner tasks](https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/) are responsible for querying the cloud provider APIs to gather configuration and identify deviations from compliance benchmarks.
+ThreatMapper [Cloud Scanner tasks](https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/) are responsible for querying the cloud provider APIs to gather configuration and identify deviations from compliance benchmarks.
 
 The task is deployed using a Terraform module. The ThreatMapper Management Console will present a basic configuration that may be deployed with Terraform, or you can refer to the expert configurations to fine-tune the deployment ([AWS](https://community.deepfence.io/threatmapper/docs/cloudscanner/aws), [Azure](https://community.deepfence.io/threatmapper/docs/cloudscanner/azure), [GCP](https://community.deepfence.io/threatmapper/docs/cloudscanner/gcp)).
 
 ### Sensor Agents
 
-Install the [sensor agents](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/) on your production or development platforms. The sensors report to the Management Console; they tell it what services they discover, provide telemetry and generate manifests of software dependencies.
+Install the [sensor agents](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/) on your production or development platforms. The sensors report to the Management Console; they tell it what services they discover, provide telemetry and generate manifests of software dependencies.
 
 The following production platforms are supported by ThreatMapper sensor agents:
 
-* [Kubernetes](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/kubernetes/): ThreatMapper sensors are deployed as a daemonset in the Kubernetes cluster, using a helm chart.
-* [Docker](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/docker/): ThreatMapper sensors are deployed as a lightweight container.
-* [Amazon ECS](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/aws-ecs): ThreatMapper sensors are deployed as a daemon service using a task definition.
-* [AWS Fargate](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/aws-fargate): ThreatMapper sensors are deployed as a sidecar container, using a task definition.
-* [Bare-Metal or Virtual Machines](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/linux-host/): ThreatMapper sensors are deployed within a lightweight Docker runtime.
+* [Kubernetes](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/kubernetes/): ThreatMapper sensors are deployed as a daemonset in the Kubernetes cluster, using a helm chart.
+* [Docker](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/docker/): ThreatMapper sensors are deployed as a lightweight container.
+* [Amazon ECS](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/aws-ecs): ThreatMapper sensors are deployed as a daemon service using a task definition.
+* [AWS Fargate](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/aws-fargate): ThreatMapper sensors are deployed as a sidecar container, using a task definition.
+* [Bare-Metal or Virtual Machines](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/linux-host/): ThreatMapper sensors are deployed within a lightweight Docker runtime.
 
 For example, run the following command to start the ThreatMapper sensor on a Docker host:
 
@@ -99,11 +99,11 @@ docker run -dit \
 
 Note: Image tag `quay.io/deepfenceio/deepfence_agent_ce:2.4.0-multiarch` is supported in amd64 and arm64/v8 architectures.
 
-On a Kubernetes platform, the sensors are installed using [helm chart](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/kubernetes/)
+On a Kubernetes platform, the sensors are installed using [helm chart](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/kubernetes/)
 
 ### Next Steps
 
-Visit the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.3/), to learn how to get started and how to use ThreatMapper.
+Visit the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.4/), to learn how to get started and how to use ThreatMapper.
 
 
 # Get in touch
@@ -113,7 +113,7 @@ Thank you for using ThreatMapper.  Please feel welcome to participate in the [Th
 * [Deepfence Community Website](https://community.deepfence.io)
 * [<img src="https://img.shields.io/badge/[email protected]?logo=slack">](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ) Got a question, need some help?  Find the Deepfence team on Slack
 * [![GitHub issues](https://img.shields.io/github/issues/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/issues) Got a feature request or found a bug?  Raise an issue
-* [![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.3/) Read the documentation in the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.3/)
+* [![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.4/) Read the documentation in the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.4/)
 * [productsecurity at deepfence dot io](SECURITY.md): Found a security issue?  Share it in confidence
 * Find out more at [deepfence.io](https://deepfence.io/)
 

diff --git a/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSCloudFormation.tsx b/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSCloudFormation.tsx
@@ -119,7 +119,7 @@ export const AWSCloudFormation = () => {
             Connect to your AWS Cloud Account via Cloud Formation. Find out more
             information by{' '}
             <Link
-              to="https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/aws#cloudformation"
+              to="https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/aws#cloudformation"
               className="text-text-link"
               target="_blank"
               rel="noreferrer"

diff --git a/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSTerraform.tsx b/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSTerraform.tsx
@@ -23,7 +23,7 @@ export const AWSTerraform = memo(() => {
           <div className="text-p7a text-text-text-and-icon">
             Connect to your AWS Cloud Account via Terraform. Find out more information by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/aws#terraform`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/aws#terraform`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AzureConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/clouds-connector/AzureConnectorForm.tsx
@@ -22,7 +22,7 @@ export const AzureConnectorForm = () => {
           <div className="text-p7a text-text-text-and-icon">
             Connect to your Microsoft Azure via terraform. Find out more information by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/azure`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/azure`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/clouds-connector/GCPConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/clouds-connector/GCPConnectorForm.tsx
@@ -23,7 +23,7 @@ export const GCPConnectorForm = () => {
             Connect to your Google Cloud Account via Terraform. Find out more information
             by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/gcp`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/gcp`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/hosts-connector/AWSECSEC2ConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/hosts-connector/AWSECSEC2ConnectorForm.tsx
@@ -23,7 +23,7 @@ export const AWSECSEC2ConnectorForm = () => {
             In AWS ECS (EC2), the ThreatMapper sensors are deployed as a daemon service
             task definition.{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/aws-ecs`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/aws-ecs`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/hosts-connector/DockerConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/hosts-connector/DockerConnectorForm.tsx
@@ -120,7 +120,7 @@ export const DockerConnectorForm = () => {
             Deploy Deepfence agent sensor as a docker container. Find out more information
             by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/docker`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/docker`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/hosts-connector/K8ConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/hosts-connector/K8ConnectorForm.tsx
@@ -347,7 +347,7 @@ helm install deepfence-agent deepfence/deepfence-agent \\
           <div className="text-p7a text-text-text-and-icon">
             Deploy Deepfence agent Kubernetes Scanner. Find out more information by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/kubernetes`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/kubernetes`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"

diff --git a/deepfence_frontend/apps/dashboard/src/components/hosts-connector/LinuxConnectorForm.tsx b/deepfence_frontend/apps/dashboard/src/components/hosts-connector/LinuxConnectorForm.tsx
@@ -98,7 +98,7 @@ export const LinuxConnectorForm = () => {
           <div className="text-p7a text-text-text-and-icon">
             Connect to Linux VM. Find out more information by{' '}
             <DFLink
-              href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/linux-host`}
+              href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/linux-host`}
               target="_blank"
               rel="noreferrer"
               className="mt-2"
@@ -121,7 +121,7 @@ export const LinuxConnectorForm = () => {
             <p className="mb-2.5 text-p7a text-text-text-and-icon">
               Copy the install script from{' '}
               <DFLink
-                href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/linux-host#threatmapper-sensor-agents`}
+                href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/linux-host#threatmapper-sensor-agents`}
                 target="_blank"
                 rel="noreferrer"
                 className="mt-2"

diff --git a/...ce_frontend/apps/dashboard/src/components/registries-connector/AmazonECRConnectorForm.tsx b/...ce_frontend/apps/dashboard/src/components/registries-connector/AmazonECRConnectorForm.tsx
@@ -32,7 +32,7 @@ export const AmazonECRConnectorForm = ({
       <div className="text-p4a text-text-input-value mt-1.5 mb-4">
         Connect to your Amazon ECR Registry. Find out more information by{' '}
         <DFLink
-          href={`https://community.deepfence.io/threatmapper/docs/v2.3/registries/aws-ecr`}
+          href={`https://community.deepfence.io/threatmapper/docs/v2.4/registries/aws-ecr`}
           target="_blank"
           rel="noreferrer"
         >

diff --git a/...ence_frontend/apps/dashboard/src/components/registries-connector/AzureCRConnectorForm.tsx b/...ence_frontend/apps/dashboard/src/components/registries-connector/AzureCRConnectorForm.tsx
@@ -27,7 +27,7 @@ export const AzureCRConnectorForm = ({
       <div className="text-p4a text-text-input-value mt-1.5 mb-4">
         Connect to your Azure Container Registry. Find out more information by{' '}
         <DFLink
-          href={`https://community.deepfence.io/threatmapper/docs/v2.3/registries/`}
+          href={`https://community.deepfence.io/threatmapper/docs/v2.4/registries/`}
           target="_blank"
           rel="noreferrer"
         >

diff --git a/...fence_frontend/apps/dashboard/src/components/registries-connector/DockerConnectorForm.tsx b/...fence_frontend/apps/dashboard/src/components/registries-connector/DockerConnectorForm.tsx
@@ -27,7 +27,7 @@ export const DockerConnectorForm = ({ errorMessage, fieldErrors }: RegistryFormP
       <div className="text-p4a text-text-input-value mt-1.5 mb-4">
         Connect to your Docker Registry. Find out more information by{' '}
         <DFLink
-          href={`https://community.deepfence.io/threatmapper/docs/v2.3/registries/`}
+          href={`https://community.deepfence.io/threatmapper/docs/v2.4/registries/`}
           target="_blank"
           rel="noreferrer"
         >

diff --git a/...nce_frontend/apps/dashboard/src/components/registries-connector/GoogleCRConnectorForm.tsx b/...nce_frontend/apps/dashboard/src/components/registries-connector/GoogleCRConnectorForm.tsx
@@ -23,7 +23,7 @@ export const GoogleCRConnectorForm = ({
       <div className="text-p4a text-text-input-value mt-1.5 mb-4">
         Connect to your Google Cloud Registry. Find out more information by{' '}
         <DFLink
-          href={`https://community.deepfence.io/threatmapper/docs/v2.3/registries/`}
+          href={`https://community.deepfence.io/threatmapper/docs/v2.4/registries/`}
           target="_blank"
           rel="noreferrer"
         >

diff --git a/docs/docs/cloudscanner/aws.md b/docs/docs/cloudscanner/aws.md
@@ -85,7 +85,7 @@ provider "aws" {
 
 module "deepfence-cloud-scanner_example_single-account" {
   source                        = "deepfence/cloud-scanner/aws//examples/single-account-ecs"
-  version                       = "0.6.0"
+  version                       = "0.8.0"
   name                          = "deepfence-cloud-scanner"
   # mgmt-console-url: deepfence.customer.com or 22.33.44.55
   mgmt-console-url              = "<Console URL>"

diff --git a/docs/docs/cloudscanner/azure.md b/docs/docs/cloudscanner/azure.md
@@ -28,7 +28,7 @@ provider "azurerm" {
 
 module "cloud-scanner_example_single-subscription" {
   source              = "deepfence/cloud-scanner/azure//examples/single-subscription"
-  version             = "0.6.0"
+  version             = "0.8.0"
   mgmt-console-url    = "<Console URL> eg. XXX.XXX.XX.XXX"
   mgmt-console-port   = "443"
   deepfence-key       = "<Deepfence-key> eg. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
@@ -59,7 +59,7 @@ provider "azurerm" {
 
 module "cloud-scanner_example_tenant-subscriptions" {
   source                  = "deepfence/cloud-scanner/azure//examples/tenant-subscriptions"
-  version                 = "0.6.0"
+  version                 = "0.8.0"
   mgmt-console-url        = "<Console URL> eg. XXX.XXX.XX.XXX"
   mgmt-console-port       = "<Console port> eg. 443"
   deepfence-key           = "<Deepfence-key> eg. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
@@ -123,7 +123,7 @@ data "azurerm_kubernetes_cluster" "default" {
 
 module "cloud-scanner" {
   source                     = "deepfence/cloud-scanner/azure//examples/aks"
-  version                    = "0.7.0"
+  version                    = "0.8.0"
   name                       = "<name of the app>"
   mgmt-console-url           = "<Console URL> eg. XXX.XXX.XX.XXX"
   deepfence-key              = "<DEEPFENCE API KEY>"
@@ -158,7 +158,7 @@ data "azurerm_kubernetes_cluster" "default" {
 
 module "test" {
   source                     = "deepfence/cloud-scanner/azure//examples/aks"
-  version                    = "0.7.0"
+  version                    = "0.8.0"
   name                       = "<name of the app>"
   mgmt-console-url           = "<Console URL> eg. XXX.XXX.XX.XXX"
   deepfence-key              = "<DEEPFENCE API KEY>"
@@ -204,7 +204,7 @@ module "test" {
 
       module "infrastructure_cloud-scanner-app" {
         source                  = "deepfence/cloud-scanner/azure//modules/infrastructure/cloud-scanner-app"
-        version                 = "0.7.0"
+        version                 = "0.8.0"
         name                    = "deepfence-cloud-scanner"
         subscription_ids_access = [data.azurerm_subscription.current.subscription_id]
       }
@@ -235,7 +235,7 @@ module "test" {
 
       module "infrastructure_cloud-scanner-app" {
         source                  = "deepfence/cloud-scanner/azure//modules/infrastructure/cloud-scanner-app"
-        version                 = "0.7.0"
+        version                 = "0.8.0"
         name                    = "deepfence-cloud-scanner"
         subscription_ids_access = [list of tenant subscriptions ids]
       }