Fix: add subnet to env (#1126)

* fix: add subnet as env variable * chore: update changelog
splunk · Nov 12, 2024 · 567726a · 567726a
1 parent 3ec29a5
commit 567726a
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Changed
 - add IF-MIB.ifOperStatus to baseIF profile
+- allow to set subnets for docker network configuration from .env file
 
 ### Fixed
 

diff --git a/docker_compose/.env b/docker_compose/.env
@@ -5,10 +5,16 @@ SCHEDULER_CONFIG_FILE_ABSOLUTE_PATH=
 TRAPS_CONFIG_FILE_ABSOLUTE_PATH=
 INVENTORY_FILE_ABSOLUTE_PATH=
 COREFILE_ABS_PATH=
+SC4SNMP_VERSION="1.12.1-beta.4"
+
+# Network configuration
 COREDNS_ADDRESS=172.28.0.255
 COREDNS_ADDRESS_IPv6=fd02:0:0:0:7fff:ffff:ffff:ffff
-SC4SNMP_VERSION="1.12.1-beta.4"
 IPv6_ENABLED=false
+IPAM_SUBNET=172.28.0.0/16
+IPAM_GATEWAY=172.28.0.1
+IPAM_SUBNET_IPv6=fd02::/64
+IPAM_GATEWAY_IPv6=fd02::1
 
 # Dependencies images
 COREDNS_IMAGE=coredns/coredns

diff --git a/docker_compose/docker-compose.yaml b/docker_compose/docker-compose.yaml
@@ -68,10 +68,10 @@ networks:
     enable_ipv6: ${IPv6_ENABLED:-false}
     ipam:
       config:
-      - subnet: 172.28.0.0/16
-        gateway: 172.28.0.1
-      - subnet: fd02::/64
-        gateway: fd02::1
+      - subnet: ${IPAM_SUBNET:-172.28.0.0/16}
+        gateway: ${IPAM_GATEWAY:-172.28.0.1}
+      - subnet: ${IPAM_SUBNET_IPv6:-fd02::/64}
+        gateway: ${IPAM_GATEWAY_IPv6:-fd02::1}
 
 services:
   coredns:

diff --git a/docs/dockercompose/10-enable-ipv6.md b/docs/dockercompose/10-enable-ipv6.md
@@ -9,8 +9,8 @@ Older versions of Docker do not support IPv6 or have know issues with IPv6 confi
 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.yaml` file in `networks` section.
+The default subnet used for SC4SNMP network in docker is `fd02::/64`, this configuration can be changed in `.env` file under `Network configuration` section.
+In case of configuring more than one IPv4 and IPv6 subnet in IPAM, `networks` section of `docker-compose.yaml` should be edited.
 
 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.
 The IPv6 port and IPv4 port cannot be the same.

diff --git a/docs/dockercompose/6-env-file-configuration.md b/docs/dockercompose/6-env-file-configuration.md
@@ -12,12 +12,24 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 | `TRAPS_CONFIG_FILE_ABSOLUTE_PATH`     | Absolute path to [traps-config.yaml](./5-traps-configuration.md) file                                |
 | `INVENTORY_FILE_ABSOLUTE_PATH`        | Absolute path to [inventory.csv](./3-inventory-configuration.md) file                                |
 | `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. Should not be changed                               |
-| `COREDNS_ADDRESS_IPv6`                | IPv6 address of the coredns inside docker network. Should not be changed                             |
 | `SC4SNMP_VERSION`                     | Version of SC4SNMP                                                                                   |
-| `IPv6_ENABLED`                        | Enable receiving traps and polling from IPv6 devices                                                 |
 
 
+## Network configuration
+
+| Variable               | Description                                                              |
+|------------------------|--------------------------------------------------------------------------| 
+| `COREDNS_ADDRESS`      | IP address of the coredns inside docker network. Should not be changed   |
+| `COREDNS_ADDRESS_IPv6` | IPv6 address of the coredns inside docker network. Should not be changed |
+| `IPv6_ENABLED`         | Enable receiving traps and polling from IPv6 devices                     |
+| `IPAM_SUBNET`          | Subnet in CIDR format that represents a network segment                  |
+| `IPAM_GATEWAY`         | IPv4 gateway for the master subnet                                       |
+| `IPAM_SUBNET_IPv6`     | Subnet in CIDR format that represents a network segment for IPv6         |
+| `IPAM_GATEWAY_IPv6`    | IPv6 gateway for the master subnet                                       |
+
+!!! info
+    In case of configuring more than one IPv4 and IPv6 subnet in IPAM, docker compose file should be edited.
+
 ## Images of dependencies 
 
 | Variable          | Description                          |