Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NethSecurity Controller: add monitoring feature #7035

Closed
8 tasks done
gsanchietti opened this issue Sep 24, 2024 · 4 comments
Closed
8 tasks done

NethSecurity Controller: add monitoring feature #7035

gsanchietti opened this issue Sep 24, 2024 · 4 comments
Assignees
Labels
verified All test cases were verified successfully

Comments

@gsanchietti
Copy link
Member

gsanchietti commented Sep 24, 2024

Update the NethSecurity Controller application to add the monitoring feature.

Required changes:

  • update to latest controller release
  • add Timescale database to store report data:
    • the database dump must be added to the backup
    • the database is accessed in write mode only from the API server
    • the database is access in read only mode from Grafana
  • add MaxMind license for the API server: the license should be configurable using the UI
  • apply retention also to Timescale database
  • update Grafana to 11.2.0 (required to make work the render plugin on a subpath)
  • update existing module installations to include a new port for Timescale, requires: New ports allocation system ns8-core#699
  • expand documentation page

See related issues:

@gsanchietti
Copy link
Member Author

gsanchietti commented Sep 27, 2024

Test case 1

  • Make sure to install on NS8 with core 3.1.0-dev.3or greater
  • Register the NS8 with a valid subscription: the historical monitoring requires a subscription both on the NethSecurity and NethServer 8
  • Install a new instance of the controller: add-module ghcr.io/nethserver/nethsecurity-controller:1.1.0-dev.3
  • Access the module UI and configure it , including the new Max Mind license field
  • Save the configuration
  • Verify the controller is accessible and units with a subscription can be registered
  • Follow the unit test case

Test case 2

  • Make sure to install on NS8 with core 3.1.0-dev.3 or greater
  • Update an existing instance where there is at least one unit connected: api-cli run update-module --data '{"module_url":"ghcr.io/nethserver/nethsecurity-controller:1.1.0-dev.3","instances":["nethsecurity-controller1"]}'
  • Verify the units still reconnect after the upgrade
  • Check the timescale database is running: runagent -m nethsecurity-controller8 podman ps

@Tbaile
Copy link
Contributor

Tbaile commented Oct 14, 2024

Case 2 verified.

@stephdl
Copy link

stephdl commented Oct 16, 2024

test 1 verified

once the controller up and the nethsecurity unit up with registration on the both side, the data is visible in grafana without action of the sysadmin after few minutes
the page of the controller in the nethsecurity web page show us that the data is well sent to grafana

image

@stephdl stephdl added the verified All test cases were verified successfully label Oct 16, 2024
@gsanchietti gsanchietti removed the testing Packages are available from testing repositories label Oct 16, 2024
@gsanchietti
Copy link
Member Author

Released version 1.1.0

@github-project-automation github-project-automation bot moved this from In progress to Done in NethServer Oct 17, 2024
@github-project-automation github-project-automation bot moved this from In progress 🛠 to Done ✅ in NethSecurity Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified All test cases were verified successfully
Projects
Archived in project
Status: Done
Development

No branches or pull requests

3 participants