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

Document design philosophy #737

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document design philosophy #737

wants to merge 1 commit into from

Conversation

hmpf
Copy link
Contributor

@hmpf hmpf commented Mar 18, 2024

Document Argus's fundamental design philosophy in order to head off certain features at the pass.

else:
ssl_context = ssl.create_default_context()
ssl_context.check_hostname = False
ssl_context.verify_mode = ssl.CERT_NONE

Check failure

Code scanning / SonarCloud

Server certificates should be verified during SSL/TLS connections

<!--SONAR_ISSUE_KEY:AY5RiuHYjUYMSc5tiJ4C-->Enable server certificate validation on this SSL/TLS connection. <p>See more on <a href="https://sonarcloud.io/project/issues?id=Uninett_Argus&issues=AY5RiuHYjUYMSc5tiJ4C&open=AY5RiuHYjUYMSc5tiJ4C&pullRequest=737">SonarCloud</a></p>
ssl_context.load_cert_chain(self.ssl_certfile, self.ssl_keyfile)
return ssl_context
else:
ssl_context = ssl.create_default_context()

Check failure

Code scanning / SonarCloud

Server hostnames should be verified during SSL/TLS connections

<!--SONAR_ISSUE_KEY:AY5RiuHYjUYMSc5tiJ4D-->Enable server hostname verification on this SSL/TLS connection. <p>See more on <a href="https://sonarcloud.io/project/issues?id=Uninett_Argus&issues=AY5RiuHYjUYMSc5tiJ4D&open=AY5RiuHYjUYMSc5tiJ4D&pullRequest=737">SonarCloud</a></p>
@codecov-commenter
Copy link

codecov-commenter commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.43%. Comparing base (8a3e712) to head (ccf5da8).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #737   +/-   ##
=======================================
  Coverage   79.43%   79.43%           
=======================================
  Files          73       73           
  Lines        3608     3608           
=======================================
  Hits         2866     2866           
  Misses        742      742           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented Mar 18, 2024

Test results

       7 files     511 suites   19m 33s ⏱️
   408 tests    407 ✔️ 1 💤 0
2 856 runs  2 849 ✔️ 7 💤 0

Results for commit ccf5da8.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@johannaengland johannaengland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few typo fixes and small comments, not a proper full review

* incident
* happening
* event
* .. se synonym dictionary for more
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* .. se synonym dictionary for more
* .. see synonym dictionary for more

An *incident* is reported (pushed) by a machine *source*. That source has a *type*. Any
change in the incident at the source is reported by the source as an *event*.
Any changes done by humans on a specific incident are also reported as an
*event*. The machine source can categorize incidents via *tags*, but argus does
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*event*. The machine source can categorize incidents via *tags*, but argus does
*event*. The machine source can categorize incidents via *tags*, but Argus does


Argus was started to solve three problems:

1. To aggregate/collect incidents from multiple NAV's without having to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a link to NAV here for people who don't know of NAV?


* Argus is not an inventory system
* Argus is not a monitoring system, real-time or other
* There is no pull. The source pushes incidents, argus pushes notifications.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* There is no pull. The source pushes incidents, argus pushes notifications.
* There is no pull. The source pushes incidents, Argus pushes notifications.

.. [1] There is of course Boolean logic underlying the filters but we will
never allow the full expressitivity
.. [2] There is no way to send notifications for ALL incidents/events. The
closes you can get is sending for all stateful incidents, which will then
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
closes you can get is sending for all stateful incidents, which will then
closest you can get is sending for all stateful incidents, which will then

never allow the full expressitivity
.. [2] There is no way to send notifications for ALL incidents/events. The
closes you can get is sending for all stateful incidents, which will then
not allow sending for stateless incidents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I remember correctly, if we decide to merge #701 it will be possible to send notifications for everything by having all event types in the filter

Copy link

sonarcloud bot commented Apr 15, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@hmpf hmpf added the paused Assignee is busy with things of higher priority label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
paused Assignee is busy with things of higher priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants