Initial documentation

[arturo-seijas]

Applicable spec:

Overview

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated
• The PR is tagged with appropriate label (urgent, trivial, complex)

[erinecon]

Thank you for adding all these docs!

[erinecon]

Is there a way to test that everything is working? Visit a website or something like that?

[arturo-seijas]

There's no website. There is an API exposed on port 55000, and the services for registering agents on 1515 and 1514, nothing very user friendly

[erinecon]

Thanks for explaining, I don't think we need to add more complexity to the tutorial. Let's leave it the way it is

[github-actions]

Test coverage for 29f2663

Name                            Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------------
src/certificates_observer.py       59      0      0      0   100%
src/charm.py                       92     19     24      6    73%   62-69, 107, 140-145, 155, 157, 159, 208-216
src/opensearch_observer.py         12      0      0      0   100%
src/state.py                      128     17     14      2    87%   89-90, 135-136, 163-164, 184-185, 188, 207, 209-211, 336-341
src/traefik_route_observer.py      39      0      6      0   100%
src/wazuh.py                      151     43     22      2    72%   100, 196-197, 210-216, 261->exit, 283-306, 317-329, 380-417
---------------------------------------------------------------------------
TOTAL                             481     79     66     10    82%

Static code analysis report

Run started:2024-12-05 08:52:16.846631

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2456
  Total lines skipped (#nosec): 12
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):