Fix boolean values in docs

[vladislav-sharapov]

SUMMARY

Fixes #397

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

Docs of several modules

ADDITIONAL INFORMATION

Notes about testing. I'm not sure how to test collections properly. I have ran ansible-test sanity --python 3.10 and ansible-test units --python 3.10 in venv with ansible-core 2.14 (with 0 return code in both cases). To run units test successfully I had to install pytest-forked pip package in addition to this one pytest-xdist from test-requirements.txt.

Note about issue #397. I haven't changed yes here because in this case it is value from /etc/vfstab. Also I've changed yes for parameters masquerade and icmp_block_inversion because they both are converted to bool by boolean function and will be changed to boolean in a future release (1, 2), for required too.

[softwarefactory-project-zuul]

Build failed.

❌ ansible-changelog-fragment FAILURE in 15s
❌ ansible-test-sanity-docker-devel FAILURE in 9m 33s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 7m 10s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 10m 17s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 8m 15s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 37s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 7m 23s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 8m 00s
✔️ ansible-test-units-posix-python39 SUCCESS in 5m 37s
✔️ ansible-test-units-posix-python310 SUCCESS in 5m 18s
✔️ ansible-galaxy-importer SUCCESS in 3m 42s
✔️ build-ansible-collection SUCCESS in 3m 11s

[samccann]

Thanks @vladislav-sharapov for taking on this and changing the booleans for this collection. I don't unfortunately know what's causing the CI failures but hoping someone else can pipe in on this to help out.

[briantist]

The sanity failures show these messages:

ERROR: plugins/modules/acl.py:0:0: doc-default-does-not-match-spec: Argument 'entity' in argument_spec defines default as ('') but documentation defines default as (None)
ERROR: plugins/modules/rhel_rpm_ostree.py:0:0: doc-default-does-not-match-spec: Argument 'name' in argument_spec defines default as ([]) but documentation defines default as (None)

These don't look like they are based on this PR; the history looks like the last commit also may have failed, I would ignore these for now until the project maintainers can comment.

The other failure is because this PR is missing a changelog fragment.

[felixfontein]

These sanity errors remind me of ansible-collections/news-for-maintainers#25 :)

[felixfontein]

#403 should fix the sanity tests.

[softwarefactory-project-zuul]

Build succeeded.

✔️ ansible-changelog-fragment SUCCESS in 16s
❌ ansible-test-sanity-docker-devel FAILURE in 8m 39s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 6m 55s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 10m 13s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 8m 35s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 58s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 7m 11s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 6m 54s
✔️ ansible-test-units-posix-python39 SUCCESS in 5m 14s
✔️ ansible-test-units-posix-python310 SUCCESS in 5m 43s
✔️ ansible-galaxy-importer SUCCESS in 3m 46s
✔️ build-ansible-collection SUCCESS in 3m 21s

[felixfontein]

recheck

[softwarefactory-project-zuul]

Build succeeded.

✔️ ansible-changelog-fragment SUCCESS in 18s
✔️ ansible-test-sanity-docker-devel SUCCESS in 7m 34s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 10m 32s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 9m 55s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 8m 56s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 10m 01s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 7m 41s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 6m 53s
✔️ ansible-test-units-posix-python39 SUCCESS in 5m 31s
✔️ ansible-test-units-posix-python310 SUCCESS in 5m 02s
✔️ ansible-galaxy-importer SUCCESS in 3m 49s
✔️ build-ansible-collection SUCCESS in 3m 11s

[vladislav-sharapov]

I suppose build has failed because of this issue uqfoundation/dill#514. I see dill-0.3.5.1 in build log, this problem should be fixed in dill-0.3.6.

[saito-hideki]

@vladislav-sharapov Hi, I think there are two issues [a] and [b].

• [a] As you posted out, it related dill version issue,but this test is non-voting. So we can ignore it at this time: https://ansible.softwarefactory-project.io/zuul/build/0c7737932d924be48af489c8f6664375
• [b] It probably the integration test issue for firewalld module on RHEL9(https://dev.azure.com/ansible/ansible.posix/_build/results?buildId=63072&view=logs&jobId=949dd205-d835-55f0-9652-ccba8c57c9c2&j=949dd205-d835-55f0-9652-ccba8c57c9c2&t=e496763b-41b9-58d8-cd3f-c7f71828f9bd)

We are checking [b] and will get back to you when we have resolved this issue.
Thanks!

[felixfontein]

The dill version has long been fixed in ansible-core devel. It's just that the milestone branch is way behind both devel and stable-2.14... (its state is three weeks before 2.14.0 has been released; according to https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/roadmap/ROADMAP_2_15.rst#development-phase it will be updated in four days.)

[felixfontein]

The milestone branch has been bumped, so that should pass now.

[saito-hideki]

LTGM

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).

✔️ ansible-changelog-fragment SUCCESS in 17s
✔️ ansible-test-sanity-docker-devel SUCCESS in 6m 59s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 6m 48s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 11m 57s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 8m 06s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 07s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 8m 11s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 8m 13s
✔️ ansible-test-units-posix-python39 SUCCESS in 6m 06s
✔️ ansible-test-units-posix-python310 SUCCESS in 5m 17s
✔️ ansible-galaxy-importer SUCCESS in 3m 44s
✔️ build-ansible-collection SUCCESS in 3m 10s