feat: partial walk

.github/pull_request_template.md

@@ -8,6 +8,7 @@ Fixes # (issue)
 
 Please delete options that are not relevant.
 
+- [ ] Dependency update
 - [ ] Bug fix
 - [ ] New feature
 - [ ] Refactor/improvement

.github/workflows/agreements.yaml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-workflow-agreements:
-    uses: splunk/addonfactory-github-workflows/.github/workflows/[email protected].1
+    uses: splunk/addonfactory-github-workflows/.github/workflows/[email protected].2
     permissions:
       actions: read
       contents: read

.github/workflows/cd-docs-pdf.yaml

@@ -41,6 +41,6 @@ jobs:
           sudo apt-get install -y pandoc texlive librsvg2-bin texlive-latex-extra
           pandoc -s --pdf-engine=pdflatex -o /tmp/SC4S4SNMP_docs.pdf $(find . -type f -name "*.md") -H deeplists.tex
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: /tmp/SC4SNMP_docs.pdf

.github/workflows/cd-pages.yaml

@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: oleksiyrudenko/[email protected].1
+      - uses: oleksiyrudenko/[email protected].2
         with:
           token: "${{ secrets.PAT_CLATOOL }}"
 
@@ -29,7 +29,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to GitHub Packages Docker Registry
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.1.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -104,7 +104,7 @@ jobs:
           helm repo index /tmp/package --url https://github.com/splunk/splunk-connect-for-snmp/releases/download/$VERSION --merge /tmp/origin/index.yaml
           cp /tmp/package/index.yaml /tmp/index/
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: /tmp/index

.github/workflows/ci-docker-deployment.yaml

@@ -0,0 +1,34 @@
+name: create-compose-files
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+    strategy:
+      matrix:
+        python-version:
+          - 3.9
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Zip docker_compose directory and upload it
+        run: |
+          zip -r docker_compose.zip docker_compose 
+          VERSION=$(echo $GITHUB_REF | cut -d / -f 3)
+          gh release upload $VERSION docker_compose.zip
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.ARTIFACT_NAME }}
+          path: docker_compose.zip
+        env:
+          ARTIFACT_NAME: docker_compose

.github/workflows/ci-main.yaml

@@ -71,7 +71,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
-      - uses: pre-commit/[email protected].0
+      - uses: pre-commit/[email protected].1
   test-unit:
     name: Test Unit Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
@@ -92,16 +92,16 @@ jobs:
       - name: Run Pytest with coverage
         run: |
           poetry run pytest --cov=./splunk_connect_for_snmp --cov-report=xml --junitxml=test-results/junit.xml
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./coverage.xml
-          directory: ./coverage/reports/
-          env_vars: OS,PYTHON
-          fail_ci_if_error: true
-          path_to_write_report: ./coverage/codecov_report.txt
-          verbose: true
+#      - name: Upload coverage to Codecov
+#        uses: codecov/codecov-action@v3
+#        with:
+#          token: ${{ secrets.CODECOV_TOKEN }}
+#          files: ./coverage.xml
+#          directory: ./coverage/reports/
+#          env_vars: OS,PYTHON
+#          fail_ci_if_error: true
+#          path_to_write_report: ./coverage/codecov_report.txt
+#          verbose: true
       - uses: actions/upload-artifact@v4 # upload test results
         if: success() || failure() # run this step even if previous step failed
         with:
@@ -140,7 +140,7 @@ jobs:
         uses: actions/checkout@v4
       - name: run install_microk8s.sh
         run: |
-          sudo snap install microk8s --classic --channel=1.25/stable
+          sudo snap install microk8s --classic --channel=1.30/stable
           sudo apt-get install snmp -y
           sudo apt-get install python3-dev -y
       - name: run automatic_setup.sh

.github/workflows/ci-release-pr.yaml

@@ -42,7 +42,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to GitHub Packages Docker Registry
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.1.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}

.github/workflows/ci-release.yaml

@@ -43,7 +43,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to GitHub Packages Docker Registry
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.1.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -77,14 +77,14 @@ jobs:
           node-version: "14"
       - name: Semantic Release
         id: version
-        uses: splunk/[email protected].3
+        uses: splunk/[email protected].4
         with:
           git_committer_name: ${{ secrets.SA_GH_USER_NAME }}
           git_committer_email: ${{ secrets.SA_GH_USER_EMAIL }}
           gpg_private_key: ${{ secrets.SA_GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.SA_GPG_PASSPHRASE }}
           extra_plugins: |
-            @google/semantic-release-replace-plugin
+            @google/semantic-release-replace-plugin@1.2.7
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
 

.github/workflows/ci-ui-tests.yaml

@@ -71,7 +71,7 @@ jobs:
 
       - name: install microk8s
         run: |
-          sudo snap install microk8s --classic --channel=1.25/stable
+          sudo snap install microk8s --classic --channel=1.30/stable
           sudo apt-get install snmp -y
           sudo apt-get install python3-dev -y
 

.github/workflows/mike.yaml

@@ -35,7 +35,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: oleksiyrudenko/[email protected].1
+      - uses: oleksiyrudenko/[email protected].2
         with:
           token: "${{ secrets.PAT_CLATOOL }}"
 

.github/workflows/release-notes.yaml

@@ -10,6 +10,6 @@ jobs:
     permissions:
       contents: write
       packages: write
-    uses: splunk/addonfactory-github-workflows/.github/workflows/[email protected].1
+    uses: splunk/addonfactory-github-workflows/.github/workflows/[email protected].2
     secrets:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -103,6 +103,7 @@ celerybeat.pid
 
 # Environments
 .env
+!docker_compose/.env
 .venv
 env/
 venv/

.releaserc

@@ -55,6 +55,34 @@
               }
             ],
             "countMatches": true
+          },
+          {
+            "files": ["docker_compose/.env"],
+            "from": "^SC4SNMP_TAG=.*",
+            "to": "SC4SNMP_TAG=\"${nextRelease.version}\"",
+            "results": [
+              {
+                "file": "docker_compose/.env",
+                "hasChanged": true,
+                "numMatches": 1,
+                "numReplacements": 1
+              }
+            ],
+            "countMatches": true
+          },
+          {
+            "files": ["docker_compose/.env"],
+            "from": "^SC4SNMP_VERSION=.*",
+            "to": "SC4SNMP_VERSION=\"${nextRelease.version}\"",
+            "results": [
+              {
+                "file": "docker_compose/.env",
+                "hasChanged": true,
+                "numMatches": 1,
+                "numReplacements": 1
+              }
+            ],
+            "countMatches": true
           }
         ]
       }
@@ -66,7 +94,7 @@
     [
       "@semantic-release/git",
       {
-        "assets": ["NOTICE", "charts/splunk-connect-for-snmp/Chart.yaml", "pyproject.toml", "splunk_connect_for_snmp/__init__.py"],
+        "assets": ["NOTICE", "charts/splunk-connect-for-snmp/Chart.yaml", "pyproject.toml", "splunk_connect_for_snmp/__init__.py", "docker_compose/.env"],
         "message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}",
       },
     ],

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+### Changed
+- add docker compose deployment
+- update default microk8s to 1.30
+
+### Fixed
+- fixed a bug with configuration from values.yaml not being transferred to the UI while migrating to SC4SNMP-UI
+
 ## [1.10.0]
 
 ### Changed

charts/splunk-connect-for-snmp/Chart.lock

@@ -4,9 +4,9 @@ dependencies:
   version: 13.18.5
 - name: redis
   repository: https://charts.bitnami.com/bitnami
-  version: 18.5.0
+  version: 19.1.0
 - name: mibserver
   repository: https://pysnmp.github.io/mibs/charts/
-  version: 1.15.7
-digest: sha256:692c53672741f1c2f75c021c3f75ae45290195e5efaeffc9a06b5cb5b0d6ac12
-generated: "2023-12-11T13:21:44.273403415Z"
+  version: 1.15.8
+digest: sha256:25bb231b140ccc7aed166d3a142ccfa81e5026560d5009f8b0dedde9ecb0657a
+generated: "2024-04-17T09:12:38.843604607Z"

charts/splunk-connect-for-snmp/Chart.yaml

@@ -14,19 +14,19 @@ type: application
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
 
-version: 1.10.0
+version: 1.11.0-beta.6
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "1.10.0"
+appVersion: "1.11.0-beta.6"
 #
 dependencies:
   - name: mongodb
     version: ~13.18.0
     repository: https://charts.bitnami.com/bitnami
   - name: redis
-    version: ~18.5.0
+    version: ~19.1.0
     repository: https://charts.bitnami.com/bitnami
   - name: mibserver
     version: ~1.15

charts/splunk-connect-for-snmp/templates/NOTES.txt

@@ -1,2 +1,2 @@
-Walk profiles no longer include IF-MIB family by default.
-If you've used this functionality before, please update the walk profile with ['IF-MIB'] varBind.
+Default walk no longer calls full oid tree, instead it is collecting only 'SNMPv2-MIB'.
+If you want to call full oid for the devices, you have to set enableFullWalk flag to true.

charts/splunk-connect-for-snmp/templates/inventory/job.yaml

@@ -50,6 +50,8 @@ spec:
             value: {{ .Values.scheduler.tasksExpiryTime | quote }}
           - name: CONFIG_FROM_MONGO
             value: {{ quote .Values.UI.enable | default "false" }}
+          - name: ENABLE_FULL_WALK
+            value: {{ .Values.poller.enableFullWalk | default "false" | quote }}
           volumeMounts:
             - name: config
               mountPath: "/app/config"

charts/splunk-connect-for-snmp/templates/ui/_helpers.tpl

@@ -51,6 +51,8 @@ spec:
             value: {{ .Values.scheduler.logLevel | default "INFO" }}
           - name: CONFIG_FROM_MONGO
             value: {{ quote .Values.UI.enable | default "false" }}
+          - name: ENABLE_FULL_WALK
+            value: {{ .Values.poller.enableFullWalk | default "false" | quote }}
           volumeMounts:
             - name: config
               mountPath: "/app/config"

charts/splunk-connect-for-snmp/values.yaml

@@ -226,6 +226,9 @@ poller:
   # https://splunk.github.io/splunk-connect-for-snmp/main/configuration/poller-configuration/#define-usernamesecrets
   usernameSecrets: []
 
+  # flag to enable polling full walk tree for devices
+  enableFullWalk: false
+
   # Here is where polling happens. Learn more on how to configure it here:
   # https://splunk.github.io/splunk-connect-for-snmp/main/configuration/poller-configuration/
 

create_packages.sh

@@ -209,7 +209,7 @@ do
 done
 
 pull_ui_images "/tmp/package/$SPLUNK_DIR"
-docker save $images_to_pack > /tmp/package/packages/dependencies-images.tar
+docker save "$images_to_pack" > /tmp/package/packages/dependencies-images.tar
 cd ../..
 tar -czvf packages/splunk-connect-for-snmp-chart.tar splunk-connect-for-snmp
 
@@ -258,15 +258,15 @@ else
 fi
 
 docker pull "$docker_image_pull"
-docker save $docker_image_pull > /tmp/package/packages/sim_image.tar
+docker save "$docker_image_pull" > /tmp/package/packages/sim_image.tar
 
 # Download and package otel charts
 cd /tmp/package/packages/ || exit
 LOCATION=$(curl -s https://api.github.com/repos/signalfx/splunk-otel-collector-chart/releases/latest | grep "zipball_url" | awk '{ print $2 }' | sed 's/,$//' | sed 's/"//g' )
-curl -L -o otel-repo.zip $LOCATION
+curl -L -o otel-repo.zip "$LOCATION"
 unzip otel-repo.zip
 rm otel-repo.zip
-OTEL_DIR=$(pwd)"/"$(ls | grep -E "signalfx-splunk.+")
+OTEL_DIR=$(find "$(pwd)" -type d -name "signalfx-splunk*")
 CHART_DIR="$OTEL_DIR/helm-charts/splunk-otel-collector"
 OTEL_IMAGE_TAG=$(python3 "$python_script" "$CHART_DIR/Chart.yaml" "appVersion")
 otel_image=quay.io/signalfx/splunk-otel-collector:"$OTEL_IMAGE_TAG"