Skip to content

Commit 57eaef7

Browse files
ramanan-raviramanan-ravi
authored
Update docs (#2415)
1 parent deb842c commit 57eaef7

4 files changed

Lines changed: 79 additions & 0 deletions

File tree

‎docs/docs/console/air-gapped.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: Air-Gapped Environments
3+
---
4+
5+
# Deploying Console into Air-Gapped Environments
6+
7+
When deploying management console into an air-gapped environment, you need to ensure that the console has access to the required images.
8+
9+
### Docker Images
10+
11+
You can download the images and upload them into internal docker registry.
12+
13+
```shell
14+
docker pull quay.io/deepfenceio/deepfence_worker_ce:THREATMAPPER_VERSION
15+
docker pull quay.io/deepfenceio/deepfence_server_ce:THREATMAPPER_VERSION
16+
docker pull quay.io/deepfenceio/deepfence_ui_ce:THREATMAPPER_VERSION
17+
docker pull quay.io/deepfenceio/deepfence_file_server_ce:THREATMAPPER_VERSION
18+
docker pull quay.io/deepfenceio/deepfence_agent_ce:THREATMAPPER_VERSION
19+
docker pull quay.io/deepfenceio/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
20+
docker pull quay.io/deepfenceio/deepfence_router_ce:THREATMAPPER_VERSION
21+
docker pull quay.io/deepfenceio/deepfence_redis_ce:THREATMAPPER_VERSION
22+
docker pull quay.io/deepfenceio/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
23+
docker pull quay.io/deepfenceio/deepfence_postgres_ce:THREATMAPPER_VERSION
24+
docker pull quay.io/deepfenceio/deepfence_neo4j_ce:THREATMAPPER_VERSION
25+
docker pull quay.io/deepfenceio/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
26+
docker pull quay.io/deepfenceio/deepfence_telemetry_ce:THREATMAPPER_VERSION
27+
```
28+
29+
```shell
30+
export IMAGE_REPOSITORY=127.0.0.1:5000
31+
32+
docker tag quay.io/deepfenceio/deepfence_worker_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_worker_ce:THREATMAPPER_VERSION
33+
docker tag quay.io/deepfenceio/deepfence_server_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_server_ce:THREATMAPPER_VERSION
34+
docker tag quay.io/deepfenceio/deepfence_ui_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_ui_ce:THREATMAPPER_VERSION
35+
docker tag quay.io/deepfenceio/deepfence_file_server_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_file_server_ce:THREATMAPPER_VERSION
36+
docker tag quay.io/deepfenceio/deepfence_agent_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
37+
docker tag quay.io/deepfenceio/deepfence_cluster_agent_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
38+
docker tag quay.io/deepfenceio/deepfence_router_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_router_ce:THREATMAPPER_VERSION
39+
docker tag quay.io/deepfenceio/deepfence_redis_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_redis_ce:THREATMAPPER_VERSION
40+
docker tag quay.io/deepfenceio/deepfence_kafka_broker_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
41+
docker tag quay.io/deepfenceio/deepfence_postgres_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_postgres_ce:THREATMAPPER_VERSION
42+
docker tag quay.io/deepfenceio/deepfence_neo4j_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_neo4j_ce:THREATMAPPER_VERSION
43+
docker tag quay.io/deepfenceio/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
44+
docker tag quay.io/deepfenceio/deepfence_telemetry_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_telemetry_ce:THREATMAPPER_VERSION
45+
docker tag quay.io/deepfenceio/deepfence_agent_ce:fargate-THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
46+
```
47+
48+
```shell
49+
export IMAGE_REPOSITORY=127.0.0.1:5000
50+
51+
docker push ${IMAGE_REPOSITORY}/deepfence_worker_ce:THREATMAPPER_VERSION
52+
docker push ${IMAGE_REPOSITORY}/deepfence_server_ce:THREATMAPPER_VERSION
53+
docker push ${IMAGE_REPOSITORY}/deepfence_ui_ce:THREATMAPPER_VERSION
54+
docker push ${IMAGE_REPOSITORY}/deepfence_file_server_ce:THREATMAPPER_VERSION
55+
docker push ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
56+
docker push ${IMAGE_REPOSITORY}/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
57+
docker push ${IMAGE_REPOSITORY}/deepfence_router_ce:THREATMAPPER_VERSION
58+
docker push ${IMAGE_REPOSITORY}/deepfence_redis_ce:THREATMAPPER_VERSION
59+
docker push ${IMAGE_REPOSITORY}/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
60+
docker push ${IMAGE_REPOSITORY}/deepfence_postgres_ce:THREATMAPPER_VERSION
61+
docker push ${IMAGE_REPOSITORY}/deepfence_neo4j_ce:THREATMAPPER_VERSION
62+
docker push ${IMAGE_REPOSITORY}/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
63+
docker push ${IMAGE_REPOSITORY}/deepfence_telemetry_ce:THREATMAPPER_VERSION
64+
```
65+
66+
Now follow the documentation [here](docker) to deploy the console using the internal registry.
67+
```shell
68+
env IMAGE_REPOSITORY=127.0.0.1:5000 docker compose up -d
69+
```
70+
71+
### ThreatIntel database
72+
73+
You can download the latest ThreatIntel database and upload it in `Settings` page.
74+
75+
| ![Scan history & Threat Intel](../img/settings-threat-intel.png) |
76+
|:----------------------------------------------------------------:|
77+
| Scan history & Threat Intel |

‎docs/docs/console/requirements.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The Management Console may be installed on a single Docker host or in a dedicate
1313
|-------------------------------------------|---------------------------------------------|-------------------------------------|
1414
| CPU: No of cores | 8 cores | 3 nodes, 4 cores each |
1515
| RAM | 16 GB | 3 nodes, 8 GB each |
16+
| Disk space | 200 GB or higher | 100 GB or higher in each node |
1617
| Telemetry and data from Deepfence Sensors | Port 443 (configurable), firewalled | Port 443 (configurable), firewalled |
1718
| Administrative and API access | Port 443 (configurable), firewalled | Port 443 (configurable), firewalled |
1819
| Docker | *Version 20.10.18 (minimum version 18.06.0) | |

‎docs/docs/img/settings-threat-intel.png‎

135 KB
Loading

‎docs/sidebars.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ const sidebars = {
6363
'console/manage-users',
6464
'console/database-export-import',
6565
'console/troubleshooting',
66+
'console/air-gapped',
6667
],
6768
},
6869

0 commit comments

Comments
 (0)