fix: support for local mibs in docker compose installation

Author: cwadhwani-splunk

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 ### Changed
+- add support for local MIB files in docker compose deployment
 - add support for Redis HA with Sentinel integration
 - **Redis Migration**: Replaced Bitnami Redis chart with custom Kubernetes manifests
   - Updated to official Redis image version 8.2.2 (addresses security vulnerabilities)

docker_compose/.env

@@ -5,6 +5,7 @@ SCHEDULER_CONFIG_FILE_ABSOLUTE_PATH=
 TRAPS_CONFIG_FILE_ABSOLUTE_PATH=
 INVENTORY_FILE_ABSOLUTE_PATH=
 COREFILE_ABS_PATH=
+LOCAL_MIBS_PATH="./local_mibs"
 SC4SNMP_VERSION="1.14.2-beta.7"
 
 # Network configuration

docker_compose/docker-compose.yaml

@@ -99,6 +99,7 @@ services:
       NGINX_ENTRYPOINT_QUIET_LOGS: ${NGINX_ENTRYPOINT_QUIET_LOGS:-1}
     volumes:
     - snmp-mibserver-tmp:/tmp/
+    - ${LOCAL_MIBS_PATH:-./local_mibs}:/app/new_mibs/src/vendor
   redis:
     <<: [*dns_and_networks, *dependend_on_core_dns]
     image: ${REDIS_IMAGE}:${REDIS_TAG:-latest}

docs/dockercompose/6-env-file-configuration.md

@@ -4,15 +4,16 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 
 ## Deployment
 
-| Variable                              | Description                                                                                          |
-|---------------------------------------|------------------------------------------------------------------------------------------------------| 
-| `SC4SNMP_IMAGE`                       | The registry and name of the SC4SNMP image to pull                                                   |
-| `SC4SNMP_TAG`                         | SC4SNMP image tag to pull                                                                            |
-| `SCHEDULER_CONFIG_FILE_ABSOLUTE_PATH` | Absolute path to [scheduler-config.yaml](./4-scheduler-configuration.md) file                        |
-| `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` |
-| `SC4SNMP_VERSION`                     | Version of SC4SNMP                                                                                   |
+| Variable                              | Description                                                                                                                                                                                                                               |
+|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 
+| `SC4SNMP_IMAGE`                       | The registry and name of the SC4SNMP image to pull                                                                                                                                                                                        |
+| `SC4SNMP_TAG`                         | SC4SNMP image tag to pull                                                                                                                                                                                                                 |
+| `SCHEDULER_CONFIG_FILE_ABSOLUTE_PATH` | Absolute path to [scheduler-config.yaml](./4-scheduler-configuration.md) file                                                                                                                                                             |
+| `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`                                                                                                                                      |
+| `LOCAL_MIBS_PATH`                     | Absolute path to the directory containing [local MIB files](../mib-request.md#configuring-path-to-local-mibs-for-docker-compose-installation). By default, it points to the `local_mibs` directory hosted with the Docker Compose package. |
+| `SC4SNMP_VERSION`                     | Version of SC4SNMP                                                                                                                                                                                                                        |
 
 
 ## Network configuration
@@ -128,6 +129,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 |
 | `INCLUDE_SECURITY_CONTEXT_ID` | Controls whether to add the context_engine_id field to v3 trap events                                                                                                                                                           |
 | `TRAPS_PORT`                 | External port exposed for traps server                                                                                                                                                                                          |
+
 ## Scheduler
 
 | Variable              | Description                                                                                       |

docs/mib-request.md

@@ -53,7 +53,7 @@ microk8s kubectl rollout restart deployment snmp-splunk-connect-for-snmp-worker-
 microk8s kubectl rollout restart deployment snmp-splunk-connect-for-snmp-worker-poller -n sc4snmp
 ```
 
-## Beta: use MIB server with local MIBs
+## Use MIB server with local MIBs
 
 From the `1.15.0` version of the MIB server, there is a way to use local MIB files. This may be useful when your MIB 
 files are proprietary, or you use SC4SNMP offline. This way, you can update necessary MIBs by yourself, without having to
@@ -68,7 +68,9 @@ vendor names will not make compilation fail, this is more for the logging purpos
 troubleshooting easier.
 3. MIB files should be named the same as the contained MIB module. The MIB module name is specified at the beginning of
 the MIB file before `::= BEGIN` keyword.
-4. Add the following to the `values.yaml`:
+
+### Configuring path to local MIBs for k8s installation
+Add the following to the `values.yaml`:
 
 ```yaml
 mibserver:
@@ -96,3 +98,21 @@ using `persistence.existingClaim`. If you go with the `localMibs.pathToMibs` sol
 (with `nodeSelector` set up to schedule MIB server pods on the same node where the MIB files are),
 when the Node with the mapped hostPath fails, you will have to access the MIB files on another node.
 
+### Configuring path to local mibs for docker-compose installation
+Add the following to the `.env`:
+
+```
+LOCAL_MIBS_PATH=/home/user/local_mibs
+```
+
+Whenever you add new MIB files, restart MIB service to compile them again, using the following command:
+
+```bash
+sudo docker compose restart snmp-mibserver
+```
+
+To verify that the process of compilation was completed successfully, check the mibserver logs using the following command:
+
+```bash
+sudo docker logs snmp-mibserver
+```