Skip to content

Commit

Permalink
doc: add note about beta version of improved polling and delete note …
Browse files Browse the repository at this point in the history
…about beta docker-compose (#1031)
  • Loading branch information
wojtekzyla authored Jun 17, 2024
1 parent 907c8b7 commit f5f9255
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- create and/or change ownership of /tmp and /.pysnmp to 10001:10001 in Dockerfile
- while mounting volumes in docker compose explicitly mount them as read only or read write
- added `values.yaml` schema validation using `values.schema.json`
- released beta version of improved polling performance

### Fixed
- fixed a bug with configuration from values.yaml not being transferred to the UI while migrating to SC4SNMP-UI
Expand Down
8 changes: 0 additions & 8 deletions docs/docker-compose.md

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/improved-polling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Improved polling performance

SC4SNMP now offers beta support for improved polling performance.

While this is in beta, we encourage users to explore it. Although we've conducted extensive testing, occasional issues may arise.
Your feedback during this phase is crucial in refining and optimizing and can be shared using [issues](https://github.com/splunk/splunk-connect-for-snmp/issues).
To get started, the zip file with helm chart must be downloaded. It can be found on [feat/improve-polling-time](https://github.com/splunk/splunk-connect-for-snmp/pull/976/checks) branch.

On the left-hand side click `create-charts-zip`:
![Workflows](../images/improved-polling-tmp/actions-view.png)

<hr style="border:2px solid">

At the bottom of the page in the `Artifacts` section there will be
`charts` package. Download it and unzip it in your environment.

![Workflows](../images/improved-polling-tmp/charts-zip-view.png)

In `values.yaml` set the following image settings:

```yaml
image:
repository: ghcr.io/splunk/splunk-connect-for-snmp/improved-polling-time
tag: "latest"
```
Change the directory to `charts/splunk-connect-for-snmp` and run `microk8s helm3 dep update`. You can exit `charts/splunk-connect-for-snmp` directory.
While running `microk8s helm3 install` or `microk8s helm3 upgrade` commands, path to the helm chart must be modified.
In the [sc4snmp installation](./gettingstarted/sc4snmp-installation.md#install-sc4snmp) documentation, the following commands are presented:
``` bash
microk8s helm3 install snmp -f values.yaml splunk-connect-for-snmp/splunk-connect-for-snmp --namespace=sc4snmp --create-namespace
```
``` bash
microk8s helm3 upgrade --install snmp -f values.yaml splunk-connect-for-snmp/splunk-connect-for-snmp --namespace=sc4snmp --create-namespace
```

In order to use this beta release, `splunk-connect-for-snmp/splunk-connect-for-snmp` needs to be changed to the path of the `charts/splunk-connect-for-snmp` directory.

To learn how the new improved polling works, refer to the documentation [Poller Configuration - Define maxRepetitions](https://github.com/splunk/splunk-connect-for-snmp/blob/feat/improve-polling-time/docs/configuration/poller-configuration.md#define-maxrepetitions)
for instructions.

Your involvement in testing new polling support is pivotal, and we look forward to hearing about your experiences.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ nav:
- Troubleshooting: "bestpractices.md"
- Releases: "releases.md"
- High Availability: ha.md
- Docker compose deployment: "docker-compose.md"
- Improved polling performance: "improved-polling.md"

0 comments on commit f5f9255

Please sign in to comment.