Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat(eos_cli_config_gen): Add capability to hide passwords and keys in generated doc and conf #2806

Merged
merged 12 commits into from
May 14, 2023

Conversation

gmuloc
Copy link
Contributor

@gmuloc gmuloc commented May 9, 2023

Change Summary

Introduce a new filter hide_passwords which allow to replace a value in a Jinja Template by <removed>.
By default the values identified in Jinja are hidden in the documentation but kept in the generated config (cf eos_cil_config_gen/default/main/main.yml)

Related Issue(s)

Fixes #2493

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

  • new filter implemented
  • added default values for documentation (true) and config (false)

How to test

molecule documentation updated.

Checklist

User Checklist

  • Add tests for filter
  • Add molecule test for config filter
  • plugin documentation written

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)

@gmuloc gmuloc added this to the v4.0.0-dev12 milestone May 9, 2023
@github-actions github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR type: Python filters labels May 9, 2023
@gmuloc gmuloc marked this pull request as ready for review May 10, 2023 09:16
@gmuloc gmuloc requested a review from a team as a code owner May 10, 2023 09:16
@github-actions github-actions bot added state: Documentation role Updated type: documentation Improvements or additions to documentation labels May 10, 2023
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a few more:

  • daemon_terminattr the ingest auth key
  • radius_server keys (seen in deprecated vars so maybe old variant?)
  • snmp community with vrf and version
  • documentation tables with snmp communities. That becomes a bit hard...

@ClausHolbechArista ClausHolbechArista requested a review from a team May 10, 2023 16:55
@github-actions github-actions bot added the state: conflict PR with conflict label May 12, 2023
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label May 14, 2023
Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@carlbuchmann carlbuchmann merged commit 428639a into aristanetworks:devel May 14, 2023
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Feat(eos_cli_config_gen) role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated type: documentation Improvements or additions to documentation type: Python filters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove passwords, hashes from documentation (sanitized)
3 participants