Update docs (#2415)

deepfence · Jan 22, 2025 · 57eaef7 · 57eaef7
1 parent deb842c
commit 57eaef7
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 0 deletions.
diff --git a/docs/docs/console/air-gapped.md b/docs/docs/console/air-gapped.md
@@ -0,0 +1,77 @@
+---
+title: Air-Gapped Environments
+---
+
+# Deploying Console into Air-Gapped Environments
+
+When deploying management console into an air-gapped environment, you need to ensure that the console has access to the required images.
+
+### Docker Images
+
+You can download the images and upload them into internal docker registry.
+
+```shell
+docker pull quay.io/deepfenceio/deepfence_worker_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_server_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_ui_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_file_server_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_agent_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_router_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_redis_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_postgres_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_neo4j_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
+docker pull quay.io/deepfenceio/deepfence_telemetry_ce:THREATMAPPER_VERSION
+```
+
+```shell
+export IMAGE_REPOSITORY=127.0.0.1:5000
+
+docker tag quay.io/deepfenceio/deepfence_worker_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_worker_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_server_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_server_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_ui_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_ui_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_file_server_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_file_server_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_agent_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_cluster_agent_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_router_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_router_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_redis_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_redis_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_kafka_broker_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_postgres_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_postgres_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_neo4j_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_neo4j_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_telemetry_ce:THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_telemetry_ce:THREATMAPPER_VERSION
+docker tag quay.io/deepfenceio/deepfence_agent_ce:fargate-THREATMAPPER_VERSION ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
+```
+
+```shell
+export IMAGE_REPOSITORY=127.0.0.1:5000
+
+docker push ${IMAGE_REPOSITORY}/deepfence_worker_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_server_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_ui_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_file_server_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_agent_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_cluster_agent_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_router_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_redis_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_kafka_broker_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_postgres_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_neo4j_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_compliance_scanner_ce:THREATMAPPER_VERSION
+docker push ${IMAGE_REPOSITORY}/deepfence_telemetry_ce:THREATMAPPER_VERSION
+```
+
+Now follow the documentation [here](docker) to deploy the console using the internal registry.
+```shell
+env IMAGE_REPOSITORY=127.0.0.1:5000 docker compose up -d
+```
+
+### ThreatIntel database
+
+You can download the latest ThreatIntel database and upload it in `Settings` page.
+
+| ![Scan history & Threat Intel](../img/settings-threat-intel.png) |
+|:----------------------------------------------------------------:|
+|                   Scan history & Threat Intel                    |
diff --git a/docs/docs/console/requirements.md b/docs/docs/console/requirements.md
@@ -13,6 +13,7 @@ The Management Console may be installed on a single Docker host or in a dedicate
 |-------------------------------------------|---------------------------------------------|-------------------------------------|
 | CPU: No of cores                          | 8 cores                                     | 3 nodes, 4 cores each               |
 | RAM                                       | 16 GB                                       | 3 nodes, 8 GB each                  |
+| Disk space                                | 200 GB or higher                            | 100 GB or higher in each node       |
 | Telemetry and data from Deepfence Sensors | Port 443 (configurable), firewalled         | Port 443 (configurable), firewalled |
 | Administrative and API access             | Port 443 (configurable), firewalled         | Port 443 (configurable), firewalled |
 | Docker                                    | *Version 20.10.18 (minimum version 18.06.0) |                                     |

diff --git a/docs/docs/img/settings-threat-intel.png b/docs/docs/img/settings-threat-intel.png
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -63,6 +63,7 @@ const sidebars = {
             'console/manage-users',
             'console/database-export-import',
             'console/troubleshooting',
+            'console/air-gapped',
           ],
         },