canonical / discourse-k8s-operator

discourse-k8s-operator - charm repository.
Apache License 2.0
7 stars 5 forks source link

Add backup and restore and external access documentation #237

Closed javierdelapuente closed 7 months ago

javierdelapuente commented 7 months ago

Overview

Add documentation for the backup and restore procedure (redeployment) and also for the external accesses needed by the Discourse charm.

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

github-actions[bot] commented 7 months ago

Test coverage for f41e5ea37e7da421496c9cc847e708bfe125938f

Name              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------
src/charm.py        321     27     78     12    90%   186, 194-195, 207, 335->343, 376->381, 393, 581-583, 588-589, 601-603, 608-609, 621-623, 646-648, 690->exit, 700->exit, 730-736, 762->exit, 776-777, 787->exit, 801
src/database.py      30      1      8      1    95%   56
-------------------------------------------------------------
TOTAL               351     28     86     13    91%

Static code analysis report

Run started:2024-04-30 11:08:06.354915

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 1984
    Total lines skipped (#nosec): 3
    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):