feat: enable ipv6 on docker (#1086)

ajasnosz · web-flow · commit af6ed8d28727 · 2024-10-02T09:24:45.000+02:00
* feat: add ipv6 for docker

* docs: update documentation
diff --git a/docker_compose/.env b/docker_compose/.env
@@ -7,7 +7,7 @@ INVENTORY_FILE_ABSOLUTE_PATH=
 COREFILE_ABS_PATH=
 COREDNS_ADDRESS=172.28.0.255
 SC4SNMP_VERSION="1.12.0-beta.1"
-
+IPv6_ENABLED=false
 
 # Dependencies images
 COREDNS_IMAGE=coredns/coredns
@@ -82,6 +82,7 @@ CHAIN_OF_TASKS_EXPIRY_TIME=500
 # Traps configuration
 SNMP_V3_SECURITY_ENGINE_ID=80003a8c04
 TRAPS_PORT=162
+IPv6_TRAPS_PORT=2163
 TRAP_LOG_LEVEL=INFO
 
 # Scheduler configuration
diff --git a/docker_compose/docker-compose-coredns.yaml b/docker_compose/docker-compose-coredns.yaml
@@ -11,5 +11,5 @@ services:
     volumes:
         - '${COREFILE_ABS_PATH}:/Corefile'
     networks:
-        my_network:
+        sc4snmp_network:
             ipv4_address: ${COREDNS_ADDRESS}
diff --git a/docker_compose/docker-compose-dependencies.yaml b/docker_compose/docker-compose-dependencies.yaml
@@ -10,7 +10,7 @@ services:
     depends_on:
       - coredns
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
 
@@ -23,7 +23,7 @@ services:
     depends_on:
       - coredns
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
   mongo:
@@ -33,7 +33,7 @@ services:
     depends_on:
       - coredns
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
 volumes:
diff --git a/docker_compose/docker-compose-inventory.yaml b/docker_compose/docker-compose-inventory.yaml
@@ -28,7 +28,7 @@ services:
       - inventory-tmp:/tmp/:rw
     restart: on-failure
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
 volumes:
diff --git a/docker_compose/docker-compose-network.yaml b/docker_compose/docker-compose-network.yaml
@@ -1,7 +1,11 @@
 version: '3.8'
 networks:
-  my_network:
+  sc4snmp_network:
+    name: sc4snmp_network
+    enable_ipv6: ${IPv6_ENABLED:-false}
     ipam:
-      driver: default
       config:
-        - subnet: 172.28.0.0/16
+        - subnet: 172.28.0.0/16
+          gateway: 172.28.0.1
+        - subnet: fd02::/64
+          gateway: fd02::1
diff --git a/docker_compose/docker-compose-scheduler.yaml b/docker_compose/docker-compose-scheduler.yaml
@@ -25,7 +25,7 @@ services:
       - scheduler-tmp:/tmp/:rw
     restart: on-failure
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
 volumes:
diff --git a/docker_compose/docker-compose-traps.yaml b/docker_compose/docker-compose-traps.yaml
@@ -26,14 +26,19 @@ services:
     - SPLUNK_HEC_PATH=${SPLUNK_HEC_PATH:-/services/collector}
     - SNMP_V3_SECURITY_ENGINE_ID=${SNMP_V3_SECURITY_ENGINE_ID:-80003a8c04}
     - PYSNMP_DEBUG=${PYSNMP_DEBUG}
+    - IPv6_ENABLED=${IPv6_ENABLED:-false}
     image: ${SC4SNMP_IMAGE}:${SC4SNMP_TAG:-latest}
     networks:
-      - my_network
+      - sc4snmp_network
     ports:
     - mode: host
       protocol: udp
       published: ${TRAPS_PORT}
       target: 2162
+    - mode: host
+      protocol: udp
+      published: ${IPv6_TRAPS_PORT}
+      target: 2163
     restart: on-failure
     secrets: []
     volumes:
diff --git a/docker_compose/docker-compose-worker-poller.yaml b/docker_compose/docker-compose-worker-poller.yaml
@@ -43,9 +43,10 @@ services:
     - WORKER_CONCURRENCY=${WORKER_POLLER_CONCURRENCY:-2}
     - PREFETCH_COUNT=${PREFETCH_POLLER_COUNT:-1}
     - PYSNMP_DEBUG=${PYSNMP_DEBUG}
+    - IPv6_ENABLED=${IPv6_ENABLED:-false}
     image: ${SC4SNMP_IMAGE}:${SC4SNMP_TAG:-latest}
     networks:
-      - my_network
+      - sc4snmp_network
     restart: on-failure
     secrets: []
     volumes:
diff --git a/docker_compose/docker-compose-worker-sender.yaml b/docker_compose/docker-compose-worker-sender.yaml
@@ -52,7 +52,7 @@ services:
       - worker-sender-tmp:/tmp/:rw
     restart: on-failure
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
     deploy:
diff --git a/docker_compose/docker-compose-worker-trap.yaml b/docker_compose/docker-compose-worker-trap.yaml
@@ -45,6 +45,7 @@ services:
       - MAX_DNS_CACHE_SIZE_TRAPS=${MAX_DNS_CACHE_SIZE_TRAPS:-500}
       - TTL_DNS_CACHE_TRAPS=${TTL_DNS_CACHE_TRAPS:-1800}
       - PYSNMP_DEBUG=${PYSNMP_DEBUG}
+      - IPv6_ENABLED=${IPv6_ENABLED:-false}
     depends_on:
       - redis
       - mongo
@@ -55,7 +56,7 @@ services:
       - worker-trap-tmp:/tmp/:rw
     restart: on-failure
     networks:
-      - my_network
+      - sc4snmp_network
     dns:
       - ${COREDNS_ADDRESS}
     deploy:
diff --git a/docs/dockercompose/10-enable-ipv6.md b/docs/dockercompose/10-enable-ipv6.md
@@ -0,0 +1,17 @@
+# Enabling IPv6 for SC4SNMP
+
+Default installation of SC4SNMP does not support polling or receiving trap notifications from IPv6 addresses. 
+To enable IPv6, follow instruction below.
+
+## Docker
+
+Older versions of Docker do not support IPv6 or have know issues with IPv6 configuration. 
+To avoid any problem with configuring the network, it is recommended to use the latest version of Docker. 
+
+To enable IPv6 for SC4SNMP, set `IPv6_ENABLED` variable to `true` in `.env` file.
+The default subnet used for SC4SNMP network in docker is `fd02::/64`, this and other network configuration can be 
+changed in the `docker-compose-network.yml` file.
+
+Default trap port for notifications for IPv6 is `2163`. You can change it to any other port if needed with `IPv6_TRAPS_PORT` parameter in `.env` file.
+
+For more information about IPv6 networking in docker, you can check the [official Docker documentation](https://docs.docker.com/engine/daemon/ipv6/).
diff --git a/docs/dockercompose/6-env-file-configuration.md b/docs/dockercompose/6-env-file-configuration.md
@@ -14,6 +14,8 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 | `COREFILE_ABS_PATH`                   | Absolute path to Corefile used by coreDNS. Default Corefile can be found inside the `docker_compose` |
 | `COREDNS_ADDRESS`                     | IP address of the coredns inside docker network. Shouldn’t be changed                                |
 | `SC4SNMP_VERSION`                     | Version of SC4SNMP                                                                                   |
+| `IPv6_ENABLED`                        | Enable receiving traps and polling from IPv6 devices                                                 |
+
 
 ## Images of dependencies 
 
@@ -110,6 +112,7 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 |------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 
 | `SNMP_V3_SECURITY_ENGINE_ID` | SNMPv3 TRAPs require the configuration SNMP Engine ID of the TRAP sending application for the USM users table of the TRAP receiving application for each USM user, for example: SNMP_V3_SECURITY_ENGINE_ID=80003a8c04,aab123456 |
 | `TRAPS_PORT`                 | External port exposed for traps server                                                                                                                                                                                          |
+| `IPv6_TRAPS_PORT`                             | External port exposed for traps server for IPv6                                                                                                                                                                                 |
 
 ## Scheduler
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -79,6 +79,7 @@ nav:
       - SNMPv3 secrets configuration: "dockercompose/7-snmpv3-secrets.md"
       - Offline installation: "dockercompose/8-offline-installation.md"
       - Sending logs to Splunk: "dockercompose/9-splunk-logging.md"
+      - Enable IPv6: "dockercompose/10-enable-ipv6.md"
   - Lightweight installation: "small-environment.md"
   - Architecture:
       - High-level design: "architecture/design.md"
@@ -92,6 +93,6 @@ nav:
       - Traps issues: "troubleshooting/traps-issues.md"
       - Kubernetes commands: "troubleshooting/k8s-commands.md"
   - Releases: "releases.md"
-  - High Availability: ha.md
+  - High Availability: "ha.md"
   - Improved polling performance: "improved-polling.md"
   - Monitoring dashboard: "dashboard.md"
