Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arturo-seijas committed Feb 4, 2025
1 parent 1be3089 commit 39bdb24
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src-docs/charm.py.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Charm the service.
- <b>`master_fqdn`</b>: the FQDN for unit 0.
- <b>`state`</b>: the charm state.

<a href="../src/charm.py#L45"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../src/charm.py#L46"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>function</kbd> `__init__`

Expand Down Expand Up @@ -95,7 +95,7 @@ Unit that this execution is responsible for.

---

<a href="../src/charm.py#L128"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../src/charm.py#L133"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>function</kbd> `reconcile`

Expand Down
13 changes: 11 additions & 2 deletions src-docs/state.py.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ reconcile(_: HookEvent) → None
Reconcile configuration.


---

## <kbd>class</kbd> `IncompleteStateError`
Exception raised when a charm configuration is invalid and automatically recoverable.





---

## <kbd>class</kbd> `InvalidStateError`
Expand Down Expand Up @@ -148,7 +157,7 @@ The Wazuh Server charm state.
- <b>`custom_config_ssh_key`</b>: the SSH key for the git repository.
- <b>`proxy`</b>: proxy configuration.

<a href="../src/state.py#L260"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../src/state.py#L264"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>function</kbd> `__init__`

Expand Down Expand Up @@ -236,7 +245,7 @@ Returns: a map containing the unconfigured users and their details.

---

<a href="../src/state.py#L322"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../src/state.py#L326"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `from_charm`

Expand Down

0 comments on commit 39bdb24

Please # to comment.