Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update version #2305

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/)
[![Demo](https://img.shields.io/badge/threatmapper-demo-green)](https://community.deepfence.io/threatmapper/docs/v3.0/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/slack-@deepfence-blue.svg?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)
Expand All @@ -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/v3.0/) 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/v3.0/demo) in the live demo sandbox.

## When to use ThreatMapper

Expand All @@ -45,34 +45,34 @@ 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/v3.0/console/), on a suitable docker host or Kubernetes cluster. For example, on Docker:

```shell script
# Docker installation process for ThreatMapper Management Console

wget https://github.com/deepfence/ThreatMapper/raw/release-2.3/deployment-scripts/docker-compose.yml
wget https://github.com/deepfence/ThreatMapper/raw/release-3.0/deployment-scripts/docker-compose.yml
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/v3.0/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/v3.0/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/v3.0/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/v3.0/sensors/kubernetes/): ThreatMapper sensors are deployed as a daemonset in the Kubernetes cluster, using a helm chart.
* [Docker](https://community.deepfence.io/threatmapper/docs/v3.0/sensors/docker/): ThreatMapper sensors are deployed as a lightweight container.
* [Amazon ECS](https://community.deepfence.io/threatmapper/docs/v3.0/sensors/aws-ecs): ThreatMapper sensors are deployed as a daemon service using a task definition.
* [AWS Fargate](https://community.deepfence.io/threatmapper/docs/v3.0/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/v3.0/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:

Expand All @@ -94,16 +94,16 @@ docker run -dit \
-e MGMT_CONSOLE_URL="---CONSOLE-IP---" \
-e MGMT_CONSOLE_PORT="443" \
-e DEEPFENCE_KEY="---DEEPFENCE-API-KEY---" \
quay.io/deepfenceio/deepfence_agent_ce:2.3.0
quay.io/deepfenceio/deepfence_agent_ce:3.0.0
```

Note: Image tag `quay.io/deepfenceio/deepfence_agent_ce:2.3.0-multiarch` is supported in amd64 and arm64/v8 architectures.
Note: Image tag `quay.io/deepfenceio/deepfence_agent_ce:3.0.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/v3.0/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/v3.0/), to learn how to get started and how to use ThreatMapper.


# Get in touch
Expand All @@ -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/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
* [![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/v3.0/) Read the documentation in the [Deepfence ThreatMapper Documentation](https://community.deepfence.io/threatmapper/docs/v3.0/)
* [productsecurity at deepfence dot io](SECURITY.md): Found a security issue? Share it in confidence
* Find out more at [deepfence.io](https://deepfence.io/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/cloudscanner/aws#cloudformation"
className="text-text-link"
target="_blank"
rel="noreferrer"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/cloudscanner/aws#terraform`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/cloudscanner/azure`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/cloudscanner/gcp`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/sensors/aws-ecs`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/sensors/docker`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/sensors/kubernetes`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/sensors/linux-host`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand All @@ -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/v3.0/sensors/linux-host#threatmapper-sensor-agents`}
target="_blank"
rel="noreferrer"
className="mt-2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/registries/aws-ecr`}
target="_blank"
rel="noreferrer"
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/registries/`}
target="_blank"
rel="noreferrer"
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/registries/`}
target="_blank"
rel="noreferrer"
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/v3.0/registries/`}
target="_blank"
rel="noreferrer"
>
Expand Down
Loading
Loading