IntenseWebs/ansible-fqcn-converter
3
0
Fork 0
mirror of https://github.com/zerwes/ansible-fqcn-converter.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity
ansible fqcn converter: auto-convert your ansible playbooks / roles / tasks etc. to use fqcn notation
24 Commits 1 Branch 25 Tags 860 KiB
Python 97%
Shell 2.1%
Makefile 0.9%
f24a464691
Go to file
Klaus Zerwes f24a464691 updated README.md
2022-08-05 22:23:38 +02:00
.github/workflows pylint workflow (closes #2) 2022-08-05 19:21:22 +02:00
.ansible-lint test exclude_paths from .ansible-lint file 2022-08-05 17:46:08 +02:00
.gitignore updated .gitignore 2022-08-05 19:21:38 +02:00
fqcn-fixer.py implemented: fqcnmapfile and updatefqcnmapfile 2022-08-05 21:44:09 +02:00
LICENSE Initial commit 2022-08-05 10:10:21 +02:00
README.md updated README.md 2022-08-05 22:23:38 +02:00

README.md

pylint

ansible-fqcn-converter

ansible fqcn converter: update ansible tasks, playbooks etc. to use fully qualified collection name in playbooks (even for ansible buildins)

howto

  1. Clone this repo to a convenient place: git clone https://github.com/zerwes/ansible-fqcn-converter.git

  2. Ensure the python script is executable: chmod 755 ansible-fqcn-converter/fqcn-fixer.py

  3. Optional: re-create the fqcn-map-file (⚠️ takes about 40 minutes ⚠️): ./ansible-fqcn-converter/fqcn-fixer.py --update-fqcn-map-file

  4. Go to the desired directory containing the ansible roles/playbooks etc and execute: $PATH_TO_ansible-fqcn-converter/fqcn-fixer.py

  5. If the diff displayed seems OK to you, let the script modify your files (❗ use at your own risk ❗): $PATH_TO_ansible-fqcn-converter/fqcn-fixer.py -w

  6. Run the latest ansible-lint and enjoy missing the Error: fqcn-builtins Use FQCN for builtin actions.

usage

usage: fqcn-fixer.py [-h] [-d DIRECTORY] [-e FILEEXTENSIONS [FILEEXTENSIONS ...]]
                     [--exclude EXCLUDE_PATHS [EXCLUDE_PATHS ...]]
                     [-c CONFIG] [-w] [-b BACKUPEXTENSION] [-x] [-m FQCNMAPFILE] [-u]

simple script to fix the fqcn module names

optional arguments:
  -h, --help            show this help message and exit
  -d DIRECTORY, --directory DIRECTORY
                        directory to search files (default: current directory)
  -e FILEEXTENSIONS [FILEEXTENSIONS ...], --extensions FILEEXTENSIONS [FILEEXTENSIONS ...]
                        list of file extensions to use (default: 'yml', 'yaml')
  --exclude EXCLUDE_PATHS [EXCLUDE_PATHS ...]
                        path(s) to directories or files to skip.
  -c CONFIG, --config CONFIG
                        read some cfg args from this file (.ansible-lint can be used)
  -w, --write-files     write back changed files
  -b BACKUPEXTENSION, --backup-extension BACKUPEXTENSION
                        backup extension to use (default: .bak)
  -x, --no-diff         do not print a diff after parsing a file (default: print it)
  -m FQCNMAPFILE, --fqcn-map-file FQCNMAPFILE
                        yaml file to use for the fqcn map (default: /home/zerwes/git/ansible-fqcn-converter/fqcn.yml)
  -u, --update-fqcn-map-file
                        update the fqcn-map-file

notes

collections

The script uses all collections installed (in the current directory) to build a translation map (aka. fqcn-map-file).

If the file is not found (or --update-fqcn-map-file is in use), the file defined by --fqcn-map-file will be created. (⚠️ this wounds time ⚠️)

exclude paths

You can use a .ansible-lint config file as input to -c in order to define EXCLUDE_PATHS