Skip to content

Commit ea41777

Browse files
committed
Update docs
1 parent f6f1f75 commit ea41777

177 files changed

Lines changed: 4939 additions & 42 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
[![GitHub stars](https://img.shields.io/github/stars/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/stargazers)
55
[![Hacktoberfest](https://img.shields.io/github/hacktoberfest/2022/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/issues)
66
[![GitHub issues](https://img.shields.io/github/issues/deepfence/ThreatMapper)](https://github.com/deepfence/ThreatMapper/issues)
7-
[![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.3/)
8-
[![Demo](https://img.shields.io/badge/threatmapper-demo-green)](https://community.deepfence.io/threatmapper/docs/v2.3/demo)
7+
[![Documentation](https://img.shields.io/badge/documentation-read-green)](https://community.deepfence.io/threatmapper/docs/v2.4/)
8+
[![Demo](https://img.shields.io/badge/threatmapper-demo-green)](https://community.deepfence.io/threatmapper/docs/v2.4/demo)
99
[![Docker pulls](https://img.shields.io/docker/pulls/deepfenceio/deepfence_agent_ce)](https://hub.docker.com/r/deepfenceio/deepfence_agent_ce)
1010
[![Slack](https://img.shields.io/badge/slack-@deepfence-blue.svg?logo=slack)](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ)
1111
[![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
2020

2121
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.
2222

23-
* [Learn more about ThreatMapper](https://community.deepfence.io/threatmapper/docs/v2.3/) in the product documentation.
23+
* [Learn more about ThreatMapper](https://community.deepfence.io/threatmapper/docs/v2.4/) in the product documentation.
2424

25-
* [See ThreatMapper running](https://community.deepfence.io/threatmapper/docs/v2.3/demo) in the live demo sandbox.
25+
* [See ThreatMapper running](https://community.deepfence.io/threatmapper/docs/v2.4/demo) in the live demo sandbox.
2626

2727
## When to use ThreatMapper
2828

@@ -45,7 +45,7 @@ ThreatMapper consists of two components:
4545

4646
### The Management Console
4747

48-
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:
48+
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:
4949

5050
```shell script
5151
# Docker installation process for ThreatMapper Management Console
@@ -54,25 +54,25 @@ wget https://github.com/deepfence/ThreatMapper/raw/release-2.4/deployment-script
5454
docker-compose -f docker-compose.yml up --detach
5555
```
5656

57-
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).
57+
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).
5858

5959
### Cloud Scanner tasks
6060

61-
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.
61+
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.
6262

6363
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)).
6464

6565
### Sensor Agents
6666

67-
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.
67+
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.
6868

6969
The following production platforms are supported by ThreatMapper sensor agents:
7070

71-
* [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.
72-
* [Docker](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/docker/): ThreatMapper sensors are deployed as a lightweight container.
73-
* [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.
74-
* [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.
75-
* [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.
71+
* [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.
72+
* [Docker](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/docker/): ThreatMapper sensors are deployed as a lightweight container.
73+
* [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.
74+
* [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.
75+
* [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.
7676

7777
For example, run the following command to start the ThreatMapper sensor on a Docker host:
7878

@@ -99,11 +99,11 @@ docker run -dit \
9999

100100
Note: Image tag `quay.io/deepfenceio/deepfence_agent_ce:2.4.0-multiarch` is supported in amd64 and arm64/v8 architectures.
101101

102-
On a Kubernetes platform, the sensors are installed using [helm chart](https://community.deepfence.io/threatmapper/docs/v2.3/sensors/kubernetes/)
102+
On a Kubernetes platform, the sensors are installed using [helm chart](https://community.deepfence.io/threatmapper/docs/v2.4/sensors/kubernetes/)
103103

104104
### Next Steps
105105

106-
Visit the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.3/), to learn how to get started and how to use ThreatMapper.
106+
Visit the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v2.4/), to learn how to get started and how to use ThreatMapper.
107107

108108

109109
# Get in touch
@@ -113,7 +113,7 @@ Thank you for using ThreatMapper. Please feel welcome to participate in the [Th
113113
* [Deepfence Community Website](https://community.deepfence.io)
114114
* [<img src="https://img.shields.io/badge/slack-@deepfence-brightgreen.svg?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
115115
* [![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
116-
* [![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/)
116+
* [![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/)
117117
* [productsecurity at deepfence dot io](SECURITY.md): Found a security issue? Share it in confidence
118118
* Find out more at [deepfence.io](https://deepfence.io/)
119119

deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSCloudFormation.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export const AWSCloudFormation = () => {
119119
Connect to your AWS Cloud Account via Cloud Formation. Find out more
120120
information by{' '}
121121
<Link
122-
to="https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/aws#cloudformation"
122+
to="https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/aws#cloudformation"
123123
className="text-text-link"
124124
target="_blank"
125125
rel="noreferrer"

deepfence_frontend/apps/dashboard/src/components/clouds-connector/AWSTerraform.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const AWSTerraform = memo(() => {
2323
<div className="text-p7a text-text-text-and-icon">
2424
Connect to your AWS Cloud Account via Terraform. Find out more information by{' '}
2525
<DFLink
26-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/aws#terraform`}
26+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/aws#terraform`}
2727
target="_blank"
2828
rel="noreferrer"
2929
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/clouds-connector/AzureConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export const AzureConnectorForm = () => {
2222
<div className="text-p7a text-text-text-and-icon">
2323
Connect to your Microsoft Azure via terraform. Find out more information by{' '}
2424
<DFLink
25-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/azure`}
25+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/azure`}
2626
target="_blank"
2727
rel="noreferrer"
2828
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/clouds-connector/GCPConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const GCPConnectorForm = () => {
2323
Connect to your Google Cloud Account via Terraform. Find out more information
2424
by{' '}
2525
<DFLink
26-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/cloudscanner/gcp`}
26+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/cloudscanner/gcp`}
2727
target="_blank"
2828
rel="noreferrer"
2929
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/hosts-connector/AWSECSEC2ConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const AWSECSEC2ConnectorForm = () => {
2323
In AWS ECS (EC2), the ThreatMapper sensors are deployed as a daemon service
2424
task definition.{' '}
2525
<DFLink
26-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/aws-ecs`}
26+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/aws-ecs`}
2727
target="_blank"
2828
rel="noreferrer"
2929
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/hosts-connector/DockerConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export const DockerConnectorForm = () => {
120120
Deploy Deepfence agent sensor as a docker container. Find out more information
121121
by{' '}
122122
<DFLink
123-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/docker`}
123+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/docker`}
124124
target="_blank"
125125
rel="noreferrer"
126126
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/hosts-connector/K8ConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ helm install deepfence-agent deepfence/deepfence-agent \\
347347
<div className="text-p7a text-text-text-and-icon">
348348
Deploy Deepfence agent Kubernetes Scanner. Find out more information by{' '}
349349
<DFLink
350-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/kubernetes`}
350+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/kubernetes`}
351351
target="_blank"
352352
rel="noreferrer"
353353
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/hosts-connector/LinuxConnectorForm.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export const LinuxConnectorForm = () => {
9898
<div className="text-p7a text-text-text-and-icon">
9999
Connect to Linux VM. Find out more information by{' '}
100100
<DFLink
101-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/linux-host`}
101+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/linux-host`}
102102
target="_blank"
103103
rel="noreferrer"
104104
className="mt-2"
@@ -121,7 +121,7 @@ export const LinuxConnectorForm = () => {
121121
<p className="mb-2.5 text-p7a text-text-text-and-icon">
122122
Copy the install script from{' '}
123123
<DFLink
124-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/sensors/linux-host#threatmapper-sensor-agents`}
124+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/sensors/linux-host#threatmapper-sensor-agents`}
125125
target="_blank"
126126
rel="noreferrer"
127127
className="mt-2"

deepfence_frontend/apps/dashboard/src/components/registries-connector/AmazonECRConnectorForm.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export const AmazonECRConnectorForm = ({
3232
<div className="text-p4a text-text-input-value mt-1.5 mb-4">
3333
Connect to your Amazon ECR Registry. Find out more information by{' '}
3434
<DFLink
35-
href={`https://community.deepfence.io/threatmapper/docs/v2.3/registries/aws-ecr`}
35+
href={`https://community.deepfence.io/threatmapper/docs/v2.4/registries/aws-ecr`}
3636
target="_blank"
3737
rel="noreferrer"
3838
>

0 commit comments

Comments
 (0)