Feat(eos_cli_config_gen): Add support for logging format rfc5424

[durd]

Change Summary

This PR adds support for logging format rfc5424

Related Issue(s)

Fixes #3365

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

This adds support for logging format rfc5424.
It adds the templates, documentation and schemas for this.

How to test

I'm not sure how to run tests. I'm using vscode and the dev-container included in the repo.
I'm familiar with Makefiles from *BSD, but not while developing.

See separate comment below.

Checklist

User Checklist

Repository Checklist

• My code has been rebased from devel before I start
• I have read the CONTRIBUTING document.
• My change requires a change to the documentation and documentation have been updated accordingly.
• I have updated molecule CI testing accordingly. (check the box if not applicable)

[durd]

I found the link to molecule in the PR checkbox comment. Looking through that I couldn't find a test for logging format sequence-numbers, so I figure that this change is as straight forward since I followed sequence-numbers and where it was located.
If there still is a need for a test I'll try to make one with molecule.

[ClausHolbechArista]

Moving to draft until we have tests in here. You can mark is as "ready for review" when it is ready.

For Molecule, you should add the new key to ansible_collections/arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/logging.yml and run Molecule locally:

cd ansible_collections/arista/avd
molecule converge -s eos_cli_config_gen -- --limit logging

[durd]

Moving to draft until we have tests in here. You can mark is as "ready for review" when it is ready.

For Molecule, you should add the new key to ansible_collections/arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/logging.yml and run Molecule locally:

cd ansible_collections/arista/avd
molecule converge -s eos_cli_config_gen -- --limit logging

PLAY [Converge] ****************************************************************

TASK [arista.avd.eos_cli_config_gen : Verify Requirements] *********************
AVD version 4.5.0-dev1
Use -v for details.
ok: [logging -> localhost]

TASK [arista.avd.eos_cli_config_gen : Create required output directories if not present] ***
ok: [logging -> localhost] => (item=/workspaces/ansible-avd/ansible_collections/arista/avd/molecule/eos_cli_config_gen/intended/structured_configs)
ok: [logging -> localhost] => (item=/workspaces/ansible-avd/ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation)
ok: [logging -> localhost] => (item=/workspaces/ansible-avd/ansible_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs)
ok: [logging -> localhost] => (item=/workspaces/ansible-avd/ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices)

TASK [arista.avd.eos_cli_config_gen : Include device intended structure configuration variables] ***
skipping: [logging]

TASK [arista.avd.eos_cli_config_gen : Generate eos intended configuration] *****
changed: [logging -> localhost]

TASK [arista.avd.eos_cli_config_gen : Generate device documentation] ***********
changed: [logging -> localhost]

PLAY RECAP *********************************************************************
logging                    : ok=4    changed=2    unreachable=0    failed=0    skipped=1    rescued=0    ignored=0

Should I commit the changes? There are a lot of deletes because of --limit logging...

[ClausHolbechArista]

It should not delete anything. It sometimes happens if it is the first time you run it. So try to run without limit and then commit the updates.

[durd]

Thanks, ran the command again without --limit logging and it recreated the cfg-files. Ran it again with --limit to be sure and committed and pushed the changes.

Edit: ah, sorry, I just noticed I committed the template change with the test artefacts. I hope that's ok?

[ClausHolbechArista]

We don't care about your commits in your branch. We will squash them into a single commit using the PR title, once we merge it to the devel branch.

[durd]

Well, tests passed and the workflow test passed locally earlier once I corrected the capitalization in the schema.
I think I'm ready for review!

Thank you so much for your help! I couldn't have managed the last mile without your help and guidance!

[ClausHolbechArista]

LGTM. Thank you for this and congratulations on your first contribution to AVD! Looking forward to many more :)

[carlbuchmann]

Applied review comments from @tgodaA - LGTM