Change documentation table

aristanetworks · Jul 2, 2024 · 142707d · 142707d
1 parent 4684ef0
commit 142707d
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 30 deletions.
diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/ospf-settings.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/ospf-settings.md
@@ -8,6 +8,12 @@
     | Variable | Type | Required | Default | Value Restrictions | Description |
     | -------- | ---- | -------- | ------- | ------------------ | ----------- |
     | [<samp>underlay_ospf_area</samp>](## "underlay_ospf_area") | String |  | `0.0.0.0` | Format: ipv4 |  |
+    | [<samp>underlay_ospf_authentication</samp>](## "underlay_ospf_authentication") | Dictionary |  |  |  |  |
+    | [<samp>&nbsp;&nbsp;enabled</samp>](## "underlay_ospf_authentication.enabled") | Boolean |  | `False` |  |  |
+    | [<samp>&nbsp;&nbsp;message_digest_keys</samp>](## "underlay_ospf_authentication.message_digest_keys") | List, items: Dictionary |  |  |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;id</samp>](## "underlay_ospf_authentication.message_digest_keys.[].id") | Integer |  |  |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hash_algorithm</samp>](## "underlay_ospf_authentication.message_digest_keys.[].hash_algorithm") | String |  | `sha512` | Valid Values:<br>- <code>md5</code><br>- <code>sha1</code><br>- <code>sha256</code><br>- <code>sha384</code><br>- <code>sha512</code> |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key</samp>](## "underlay_ospf_authentication.message_digest_keys.[].key") | String |  |  |  | Key password<br>Only plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.<br>To protect the password at rest it is recommended to make use of Ansible Vault or similar.<br> |
     | [<samp>underlay_ospf_bfd_enable</samp>](## "underlay_ospf_bfd_enable") | Boolean |  | `False` |  |  |
     | [<samp>underlay_ospf_max_lsa</samp>](## "underlay_ospf_max_lsa") | Integer |  | `12000` |  |  |
     | [<samp>underlay_ospf_process_id</samp>](## "underlay_ospf_process_id") | Integer |  | `100` |  |  |
@@ -16,6 +22,16 @@
 
     ```yaml
     underlay_ospf_area: <str; default="0.0.0.0">
+    underlay_ospf_authentication:
+      enabled: <bool; default=False>
+      message_digest_keys:
+        - id: <int>
+          hash_algorithm: <str; "md5" | "sha1" | "sha256" | "sha384" | "sha512"; default="sha512">
+
+          # Key password
+          # Only plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.
+          # To protect the password at rest it is recommended to make use of Ansible Vault or similar.
+          key: <str>
     underlay_ospf_bfd_enable: <bool; default=False>
     underlay_ospf_max_lsa: <int; default=12000>
     underlay_ospf_process_id: <int; default=100>

diff --git a/...ctions/arista/avd/roles/eos_designs/docs/tables/underlay-ospf-authentication.md b/...ctions/arista/avd/roles/eos_designs/docs/tables/underlay-ospf-authentication.md
diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
@@ -4027,6 +4027,8 @@ keys:
     format: ipv4
     default: 0.0.0.0
   underlay_ospf_authentication:
+    documentation_options:
+      table: ospf-settings
     type: dict
     keys:
       enabled:

diff --git a/...on-avd/pyavd/_eos_designs/schema/schema_fragments/underlay_ospf_authentication_schema.yml b/...on-avd/pyavd/_eos_designs/schema/schema_fragments/underlay_ospf_authentication_schema.yml
@@ -7,6 +7,8 @@
 type: dict
 keys:
   underlay_ospf_authentication:
+    documentation_options:
+      table: ospf-settings
     type: dict
     keys:
       enabled: