From 26c182c8ef6b1c41b2dacd32789b8439533ba004 Mon Sep 17 00:00:00 2001 From: Hideki Saito Date: Fri, 7 Apr 2023 13:57:13 +0900 Subject: [PATCH] Release 1.5.2 commit Signed-off-by: Hideki Saito --- .azure-pipelines/azure-pipelines.yml | 14 -- CHANGELOG.rst | 23 +++ README.md | 3 + changelogs/changelog.yaml | 27 +++ ...ewalld_create_remove_zone_when_offline.yml | 3 - .../fragments/413-synchronize-seealso.yml | 2 - .../fragments/417-add-protocol-parameter.yml | 2 - changelogs/fragments/419-fix-patch-doc.yml | 2 - .../425-support_test-sanity-docker-devel.yml | 2 - .../426-firewalld_info-doc-update.yml | 4 - .../434-fix-rhel_facts-exit_json.yml | 2 - .../fragments/535-add-jsonl-callback.yml | 2 - docs/ansible.posix.acl_module.rst | 7 +- docs/ansible.posix.at_module.rst | 2 +- docs/ansible.posix.authorized_key_module.rst | 18 +- docs/ansible.posix.firewalld_info_module.rst | 10 +- docs/ansible.posix.firewalld_module.rst | 53 ++++-- docs/ansible.posix.mount_module.rst | 26 ++- docs/ansible.posix.patch_module.rst | 10 +- docs/ansible.posix.rhel_facts_module.rst | 103 +++++++++++ docs/ansible.posix.rhel_rpm_ostree_module.rst | 156 ++++++++++++++++ ...nsible.posix.rpm_ostree_upgrade_module.rst | 175 ++++++++++++++++++ docs/ansible.posix.seboolean_module.rst | 6 +- docs/ansible.posix.synchronize_module.rst | 28 +-- docs/ansible.posix.sysctl_module.rst | 12 +- galaxy.yml | 2 +- 26 files changed, 595 insertions(+), 99 deletions(-) delete mode 100644 changelogs/fragments/399_firewalld_create_remove_zone_when_offline.yml delete mode 100644 changelogs/fragments/413-synchronize-seealso.yml delete mode 100644 changelogs/fragments/417-add-protocol-parameter.yml delete mode 100644 changelogs/fragments/419-fix-patch-doc.yml delete mode 100644 changelogs/fragments/425-support_test-sanity-docker-devel.yml delete mode 100644 changelogs/fragments/426-firewalld_info-doc-update.yml delete mode 100644 changelogs/fragments/434-fix-rhel_facts-exit_json.yml delete mode 100644 changelogs/fragments/535-add-jsonl-callback.yml create mode 100644 docs/ansible.posix.rhel_facts_module.rst create mode 100644 docs/ansible.posix.rhel_rpm_ostree_module.rst create mode 100644 docs/ansible.posix.rpm_ostree_upgrade_module.rst diff --git a/.azure-pipelines/azure-pipelines.yml b/.azure-pipelines/azure-pipelines.yml index e403638..728ef40 100644 --- a/.azure-pipelines/azure-pipelines.yml +++ b/.azure-pipelines/azure-pipelines.yml @@ -135,18 +135,12 @@ stages: test: centos6 - name: CentOS 7 test: centos7 - - name: Fedora 32 - test: fedora32 - - name: Fedora 33 - test: fedora33 - name: openSUSE 15 py2 test: opensuse15py2 - name: openSUSE 15 py3 test: opensuse15 - name: Ubuntu 18.04 test: ubuntu1804 - - name: Ubuntu 20.04 - test: ubuntu2004 - stage: Docker_2_10 displayName: Docker 2.10 dependsOn: [] @@ -159,10 +153,6 @@ stages: test: centos6 - name: CentOS 7 test: centos7 - - name: Fedora 30 - test: fedora30 - - name: Fedora 31 - test: fedora31 - name: openSUSE 15 py2 test: opensuse15py2 - name: openSUSE 15 py3 @@ -183,10 +173,6 @@ stages: test: centos6 - name: CentOS 7 test: centos7 - - name: Fedora 30 - test: fedora30 - - name: Fedora 31 - test: fedora31 - name: openSUSE 15 py2 test: opensuse15py2 - name: openSUSE 15 py3 diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 45421b2..06cdf22 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,29 @@ ansible.posix Release Notes .. contents:: Topics +v1.5.2 +====== + +Release Summary +--------------- + +This is the minor release of the ``ansible.posix`` collection. +This changelog contains all changes to the modules and plugins +in this collection that have been added after the release of +``ansible.posix`` 1.5.1. + +Minor Changes +------------- + +- Add jsonl callback plugin to ansible.posix collection +- firewalld - add `protocol` parameter + +Bugfixes +-------- + +- Fixed a bug where firewalld module fails to create/remove zones when the daemon is stopped +- rhel_facts - Call exit_json with all keyword arguments + v1.5.1 ====== diff --git a/README.md b/README.md index c0ee2b4..b0cd705 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,9 @@ Name | Description [ansible.posix.firewalld_info](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.firewalld_info_module.rst)|Gather information about firewalld [ansible.posix.mount](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.mount_module.rst)|Control active and configured mount points [ansible.posix.patch](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.patch_module.rst)|Apply patch files using the GNU patch tool +[ansible.posix.rhel_facts](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rhel_facts_module.rst)|Facts module to set or override RHEL specific facts. +[ansible.posix.rhel_rpm_ostree](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rhel_rpm_ostree_module.rst)|Ensure packages exist in a RHEL for Edge rpm-ostree based system +[ansible.posix.rpm_ostree_upgrade](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rpm_ostree_upgrade_module.rst)|Manage rpm-ostree upgrade transactions [ansible.posix.seboolean](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.seboolean_module.rst)|Toggles SELinux booleans [ansible.posix.selinux](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.selinux_module.rst)|Change policy and state of SELinux [ansible.posix.synchronize](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.synchronize_module.rst)|A wrapper around rsync to make common tasks in your playbooks quick and easy diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index d313a88..0b59c25 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -294,3 +294,30 @@ releases: - 407_fix_firewalld_port_test.yml - 409_update_azp_matrix.yml release_date: '2023-01-20' + 1.5.2: + changes: + bugfixes: + - Fixed a bug where firewalld module fails to create/remove zones when the daemon + is stopped + - rhel_facts - Call exit_json with all keyword arguments + minor_changes: + - Add jsonl callback plugin to ansible.posix collection + - firewalld - add `protocol` parameter + release_summary: 'This is the minor release of the ``ansible.posix`` collection. + + This changelog contains all changes to the modules and plugins + + in this collection that have been added after the release of + + ``ansible.posix`` 1.5.1.' + fragments: + - 1.5.2.yml + - 399_firewalld_create_remove_zone_when_offline.yml + - 413-synchronize-seealso.yml + - 417-add-protocol-parameter.yml + - 419-fix-patch-doc.yml + - 425-support_test-sanity-docker-devel.yml + - 426-firewalld_info-doc-update.yml + - 434-fix-rhel_facts-exit_json.yml + - 535-add-jsonl-callback.yml + release_date: '2023-04-07' diff --git a/changelogs/fragments/399_firewalld_create_remove_zone_when_offline.yml b/changelogs/fragments/399_firewalld_create_remove_zone_when_offline.yml deleted file mode 100644 index 691fc65..0000000 --- a/changelogs/fragments/399_firewalld_create_remove_zone_when_offline.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - Fixed a bug where firewalld module fails to create/remove zones when the daemon is stopped diff --git a/changelogs/fragments/413-synchronize-seealso.yml b/changelogs/fragments/413-synchronize-seealso.yml deleted file mode 100644 index ac680af..0000000 --- a/changelogs/fragments/413-synchronize-seealso.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - "synchronize - fix broken ``seealso`` module reference (https://github.com/ansible-collections/ansible.posix/pull/413)." diff --git a/changelogs/fragments/417-add-protocol-parameter.yml b/changelogs/fragments/417-add-protocol-parameter.yml deleted file mode 100644 index ad78cea..0000000 --- a/changelogs/fragments/417-add-protocol-parameter.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- firewalld - add `protocol` parameter diff --git a/changelogs/fragments/419-fix-patch-doc.yml b/changelogs/fragments/419-fix-patch-doc.yml deleted file mode 100644 index 7a39a27..0000000 --- a/changelogs/fragments/419-fix-patch-doc.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - patch - fix format syntax and boolean values on document (https://github.com/ansible-collections/ansible.posix/pull/419). diff --git a/changelogs/fragments/425-support_test-sanity-docker-devel.yml b/changelogs/fragments/425-support_test-sanity-docker-devel.yml deleted file mode 100644 index e66622c..0000000 --- a/changelogs/fragments/425-support_test-sanity-docker-devel.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - ansible.posix - removed unused module import from the code. diff --git a/changelogs/fragments/426-firewalld_info-doc-update.yml b/changelogs/fragments/426-firewalld_info-doc-update.yml deleted file mode 100644 index 71037f5..0000000 --- a/changelogs/fragments/426-firewalld_info-doc-update.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- - -trivial: - - firewalld_info - fixed typo in return value and improved examples in documentation diff --git a/changelogs/fragments/434-fix-rhel_facts-exit_json.yml b/changelogs/fragments/434-fix-rhel_facts-exit_json.yml deleted file mode 100644 index dcf16d9..0000000 --- a/changelogs/fragments/434-fix-rhel_facts-exit_json.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - rhel_facts - Call exit_json with all keyword arguments diff --git a/changelogs/fragments/535-add-jsonl-callback.yml b/changelogs/fragments/535-add-jsonl-callback.yml deleted file mode 100644 index 64eb192..0000000 --- a/changelogs/fragments/535-add-jsonl-callback.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- Add jsonl callback plugin to ansible.posix collection diff --git a/docs/ansible.posix.acl_module.rst b/docs/ansible.posix.acl_module.rst index aab5a37..6a13d89 100644 --- a/docs/ansible.posix.acl_module.rst +++ b/docs/ansible.posix.acl_module.rst @@ -49,8 +49,8 @@ Parameters -
If the target is a directory, setting this to yes will make it the default ACL for entities created inside the directory.
-
Setting default to yes causes an error if the path is a file.
+
If the target is a directory, setting this to true will make it the default ACL for entities created inside the directory.
+
Setting default to true causes an error if the path is a file.
@@ -63,6 +63,7 @@ Parameters + Default:
""
The actual user or group that the ACL applies to when matching entity types user or group are selected.
@@ -285,7 +286,7 @@ Examples entity: joe etype: user permissions: rw - default: yes + default: true state: present - name: Same as previous but using entry shorthand diff --git a/docs/ansible.posix.at_module.rst b/docs/ansible.posix.at_module.rst index d9f3cc8..3d731a2 100644 --- a/docs/ansible.posix.at_module.rst +++ b/docs/ansible.posix.at_module.rst @@ -171,7 +171,7 @@ Examples command: ls -d / >/dev/null count: 20 units: minutes - unique: yes + unique: true diff --git a/docs/ansible.posix.authorized_key_module.rst b/docs/ansible.posix.authorized_key_module.rst index bfbb444..53efe25 100644 --- a/docs/ansible.posix.authorized_key_module.rst +++ b/docs/ansible.posix.authorized_key_module.rst @@ -139,8 +139,8 @@ Parameters
Whether this module should manage the directory of the authorized key file.
-
If set to yes, the module will create the directory, as well as set the owner and permissions of an existing directory.
-
Be sure to set manage_dir=no if you are using an alternate directory for authorized_keys, as set with path, since you could lock yourself out of SSH access.
+
If set to true, the module will create the directory, as well as set the owner and permissions of an existing directory.
+
Be sure to set manage_dir=false if you are using an alternate directory for authorized_keys, as set with path, since you could lock yourself out of SSH access.
See the example below.
@@ -212,9 +212,9 @@ Parameters
This only applies if using a https url as the source of the keys.
-
If set to no, the SSL certificates will not be validated.
-
This should only set to no used on personally controlled sites using self-signed certificates as it avoids verifying the source site.
-
Prior to 2.1 the code worked as if this was set to yes.
+
If set to false, the SSL certificates will not be validated.
+
This should only set to false used on personally controlled sites using self-signed certificates as it avoids verifying the source site.
+
Prior to 2.1 the code worked as if this was set to true.
@@ -252,7 +252,7 @@ Examples state: present key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" path: /etc/ssh/authorized_keys/charlie - manage_dir: False + manage_dir: false - name: Set up multiple authorized keys ansible.posix.authorized_key: @@ -275,14 +275,14 @@ Examples user: charlie state: present key: https://github.com/user.keys - validate_certs: False + validate_certs: false - name: Set authorized key, removing all the authorized keys already set ansible.posix.authorized_key: user: root key: "{{ lookup('file', 'public_keys/doe-jane') }}" state: present - exclusive: True + exclusive: true - name: Set authorized key for user ubuntu copying it from current user ansible.posix.authorized_key: @@ -460,7 +460,7 @@ Common return values are documented `here success -
This only applies if using a https url as the source of the keys. If set to no, the SSL certificates will not be validated.
+
This only applies if using a https url as the source of the keys. If set to false, the SSL certificates will not be validated.

Sample:
True
diff --git a/docs/ansible.posix.firewalld_info_module.rst b/docs/ansible.posix.firewalld_info_module.rst index 8bb6508..911acce 100644 --- a/docs/ansible.posix.firewalld_info_module.rst +++ b/docs/ansible.posix.firewalld_info_module.rst @@ -89,7 +89,12 @@ Examples - name: Gather information about active zones ansible.posix.firewalld_info: - active_zones: yes + active_zones: true + register: result + + - name: Print default zone for debugging + ansible.builtin.debug: + var: result.firewalld_info.default_zone - name: Gather information about specific zones ansible.posix.firewalld_info: @@ -97,6 +102,7 @@ Examples - public - external - internal + register: result @@ -163,7 +169,7 @@ Common return values are documented `here  
- default_zones + default_zone
string diff --git a/docs/ansible.posix.firewalld_module.rst b/docs/ansible.posix.firewalld_module.rst index ea58ff2..0932ac2 100644 --- a/docs/ansible.posix.firewalld_module.rst +++ b/docs/ansible.posix.firewalld_module.rst @@ -155,7 +155,7 @@ Parameters
Should this configuration be in the running firewalld configuration or persist across reboots.
As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 0.3.9).
-
Note that if this is no, immediate is assumed yes.
+
Note that if this is false, immediate is assumed true.
@@ -262,6 +262,21 @@ Parameters + + +
+ protocol + +
+ string +
+ + + + +
Name of a protocol to add/remove to/from firewalld.
+ +
@@ -414,29 +429,35 @@ Examples - name: permit traffic in default zone for https service ansible.posix.firewalld: service: https - permanent: yes + permanent: true + state: enabled + + - name: permit ospf traffic + ansible.posix.firewalld: + protocol: ospf + permanent: true state: enabled - name: do not permit traffic in default zone on port 8081/tcp ansible.posix.firewalld: port: 8081/tcp - permanent: yes + permanent: true state: disabled - ansible.posix.firewalld: port: 161-162/udp - permanent: yes + permanent: true state: enabled - ansible.posix.firewalld: zone: dmz service: http - permanent: yes + permanent: true state: enabled - ansible.posix.firewalld: rich_rule: rule service name="ftp" audit limit value="1/m" accept - permanent: yes + permanent: true state: enabled - ansible.posix.firewalld: @@ -447,44 +468,44 @@ Examples - ansible.posix.firewalld: zone: trusted interface: eth2 - permanent: yes + permanent: true state: enabled - ansible.posix.firewalld: - masquerade: yes + masquerade: true state: enabled - permanent: yes + permanent: true zone: dmz - ansible.posix.firewalld: zone: custom state: present - permanent: yes + permanent: true - ansible.posix.firewalld: zone: drop state: enabled - permanent: yes - icmp_block_inversion: yes + permanent: true + icmp_block_inversion: true - ansible.posix.firewalld: zone: drop state: enabled - permanent: yes + permanent: true icmp_block: echo-request - ansible.posix.firewalld: zone: internal state: present - permanent: yes + permanent: true target: ACCEPT - name: Redirect port 443 to 8443 with Rich Rule ansible.posix.firewalld: rich_rule: rule family=ipv4 forward-port port=443 protocol=tcp to-port=8443 zone: public - permanent: yes - immediate: yes + permanent: true + immediate: true state: enabled diff --git a/docs/ansible.posix.mount_module.rst b/docs/ansible.posix.mount_module.rst index 3ec3ce9..f38621f 100644 --- a/docs/ansible.posix.mount_module.rst +++ b/docs/ansible.posix.mount_module.rst @@ -73,6 +73,7 @@ Parameters
For Solaris systems, true will set yes as the value of mount at boot in /etc/vfstab.
For Linux, FreeBSD, NetBSD and OpenBSD systems, false will add noauto to mount options in /etc/fstab.
To avoid mount option conflicts, if noauto specified in opts, mount module will ignore boot.
+
This parameter is ignored when state is set to ephemeral.
@@ -90,7 +91,7 @@ Parameters
Dump (see fstab(5)).
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Has no effect on Solaris systems.
+
Has no effect on Solaris systems or when used with ephemeral.
@@ -110,6 +111,7 @@ Parameters
This might be useful if you need to configure mountpoints in a chroot environment.
OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.
This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.
+
This parameter is ignored when state is set to ephemeral.
@@ -125,7 +127,7 @@ Parameters
Filesystem type.
-
Required when state is present or mounted.
+
Required when state is present, mounted or ephemeral.
@@ -158,7 +160,7 @@ Parameters
Passno (see fstab(5)).
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Deprecated on Solaris systems.
+
Deprecated on Solaris systems. Has no effect when used with ephemeral.
@@ -192,7 +194,7 @@ Parameters
Device (or NFS volume, or something else) to be mounted on path.
-
Required when state set to present or mounted.
+
Required when state set to present, mounted or ephemeral.
@@ -208,18 +210,22 @@ Parameters
    Choices:
  • absent
    • +
  • absent_from_fstab
  • mounted
  • present
  • unmounted
  • remounted
    • +
  • ephemeral
If mounted, the device will be actively mounted and appropriately configured in fstab. If the mount point is not present, the mount point will be created.
If unmounted, the device will be unmounted without changing fstab.
present only specifies that the device is to be configured in fstab and does not trigger or require a mount.
+
ephemeral only specifies that the device is to be mounted, without changing fstab. If it is already mounted, a remount will be triggered. This will always return changed=True. If the mount point path has already a device mounted on, and its source is different than src, the module will fail to avoid unexpected unmount or mount point override. If the mount point is not present, the mount point will be created. The fstab is completely ignored. This option is added in version 1.5.0.
absent specifies that the device mount's entry will be removed from fstab and will also unmount the device and remove the mount point.
-
remounted specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. If opts is set, the options will be applied to the remount, but will not change fstab. Additionally, if opts is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using mounted instead to work around this issue.
+
remounted specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. If opts is set, the options will be applied to the remount, but will not change fstab. Additionally, if opts is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using mounted instead to work around this issue. remounted expects the mount point to be present in the fstab. To remount a mount point not registered in fstab, use ephemeral instead, especially with BSD nodes.
+
absent_from_fstab specifies that the device mount's entry will be removed from fstab. This option does not unmount it or delete the mountpoint.
@@ -304,10 +310,18 @@ Examples src: 192.168.1.100:/nfs/ssd/shared_data path: /mnt/shared_data opts: rw,sync,hard - boot: no + boot: false state: mounted fstype: nfs + - name: Mount ephemeral SMB volume + ansible.posix.mount: + src: //192.168.1.200/share + path: /mnt/smb_share + opts: "rw,vers=3,file_mode=0600,dir_mode=0700,dom={{ ad_domain }},username={{ ad_username }},password={{ ad_password }}" + fstype: cifs + state: ephemeral + diff --git a/docs/ansible.posix.patch_module.rst b/docs/ansible.posix.patch_module.rst index 60c30cf..07f672a 100644 --- a/docs/ansible.posix.patch_module.rst +++ b/docs/ansible.posix.patch_module.rst @@ -84,9 +84,9 @@ Parameters -
Setting to yes will disable patch's heuristic for transforming CRLF line endings into LF.
+
Setting to true will disable patch's heuristic for transforming CRLF line endings into LF.
Line endings of src and dest must match.
-
If set to no, patch will replace CRLF in src files on POSIX.
+
If set to false, patch will replace CRLF in src files on POSIX.
@@ -122,7 +122,7 @@ Parameters -
Setting to yes will ignore white space changes between patch and input..
+
Setting to true will ignore white space changes between patch and input.
@@ -141,7 +141,7 @@ Parameters -
If no, it will search for src at originating/controller machine, if yes it will go to the remote/target machine for the src.
+
If false, it will search for src at originating/controller machine, if true it will go to the remote/target machine for the src.
@@ -157,7 +157,7 @@ Parameters -
Path of the patch file as accepted by the GNU patch tool. If remote_src is 'no', the patch source file is looked up from the module's files directory.
+
Path of the patch file as accepted by the GNU patch tool. If remote_src is false, the patch source file is looked up from the module's files directory.

aliases: patchfile
diff --git a/docs/ansible.posix.rhel_facts_module.rst b/docs/ansible.posix.rhel_facts_module.rst new file mode 100644 index 0000000..d4c8fb6 --- /dev/null +++ b/docs/ansible.posix.rhel_facts_module.rst @@ -0,0 +1,103 @@ +.. _ansible.posix.rhel_facts_module: + + +************************ +ansible.posix.rhel_facts +************************ + +**Facts module to set or override RHEL specific facts.** + + +Version added: 1.5.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Compatibility layer for using the "package" module for rpm-ostree based systems via setting the "pkg_mgr" fact correctly. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- rpm-ostree + + + + +See Also +-------- + +.. seealso:: + + :ref:`ansible.builtin.package_module` + The official documentation on the **ansible.builtin.package** module. + + +Examples +-------- + +.. code-block:: yaml + + - name: Playbook to use the package module on all RHEL footprints + vars: + ansible_facts_modules: + - setup # REQUIRED to be run before all custom fact modules + - ansible.posix.rhel_facts + tasks: + - name: Ensure packages are installed + ansible.builtin.package: + name: + - htop + - ansible + state: present + + +Returned Facts +-------------- +Facts returned by this module are added/updated in the ``hostvars`` host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them. + +.. raw:: html + + + + + + + + + + + + +
FactReturnedDescription
+
+ pkg_mgr + +
+ string +
+ 		when needed +
System-level package manager override +
+
+
Sample:
+
{'pkg_mgr': 'ansible.posix.rhel_facts'}
+
+

+ + + +Status +------ + + +Authors +~~~~~~~ + +- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.rhel_rpm_ostree_module.rst b/docs/ansible.posix.rhel_rpm_ostree_module.rst new file mode 100644 index 0000000..b170b15 --- /dev/null +++ b/docs/ansible.posix.rhel_rpm_ostree_module.rst @@ -0,0 +1,156 @@ +.. _ansible.posix.rhel_rpm_ostree_module: + + +***************************** +ansible.posix.rhel_rpm_ostree +***************************** + +**Ensure packages exist in a RHEL for Edge rpm-ostree based system** + + +Version added: 1.5.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Compatibility layer for using the "package" module for RHEL for Edge systems utilizing the RHEL System Roles. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- rpm-ostree + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ name + +
+ list + / elements=string +
+ 		+ Default:
[]
+ 		+
A package name or package specifier with version, like name-1.0.
+
Comparison operators for package version are valid here >, <, >=, <=. Example - name>=1.0
+
If a previous version is specified, the task also needs to turn allow_downgrade on. See the allow_downgrade documentation for caveats with downgrading packages.
+
When using state=latest, this can be '*' which means run yum -y update.
+
You can also pass a url or a local path to a rpm file (using state=present). To operate on several packages this can accept a comma separated string of packages or (as of 2.0) a list of packages.
+

aliases: pkg
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • absent
    • +
  • installed
    • +
  • latest
    • +
  • present
    • +
  • removed
    • +
+ 		+
Whether to install (present or installed, latest), or remove (absent or removed) a package.
+
present and installed will simply ensure that a desired package is installed.
+
latest will update the specified package if it's not of the latest available version.
+
absent and removed will remove the specified package.
+
Default is None, however in effect the default action is present unless the autoremove option is enabled for this module, then absent is inferred.
+
+
+ + +Notes +----- + +.. note:: + - This module does not support installing or removing packages to/from an overlay as this is not supported by RHEL for Edge, packages needed should be defined in the osbuild Blueprint and provided to Image Builder at build time. This module exists only for ``package`` module compatibility. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure htop and ansible are installed on rpm-ostree based RHEL + ansible.posix.rhel_rpm_ostree: + name: + - htop + - ansible + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		always +
status of rpm transaction
+
+
Sample:
+
No changes made.
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.rpm_ostree_upgrade_module.rst b/docs/ansible.posix.rpm_ostree_upgrade_module.rst new file mode 100644 index 0000000..d683166 --- /dev/null +++ b/docs/ansible.posix.rpm_ostree_upgrade_module.rst @@ -0,0 +1,175 @@ +.. _ansible.posix.rpm_ostree_upgrade_module: + + +******************************** +ansible.posix.rpm_ostree_upgrade +******************************** + +**Manage rpm-ostree upgrade transactions** + + +Version added: 1.5.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage an rpm-ostree upgrade transactions. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- rpm-ostree + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ allow_downgrade + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Allow for the upgrade to be a chronologically older tree.
+
+
+ cache_only + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Perform the transaction using only pre-cached data, do not download.
+
+
+ os + +
+ string +
+ 		+ Default:
""
+ 		+
The OSNAME upon which to operate.
+
+
+ peer + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Force peer-to-peer connection instead of using a system message bus.
+
+
+ + + + +Examples +-------- + +.. code-block:: yaml + + - name: Upgrade the rpm-ostree image without options, accept all defaults + ansible.posix.rpm_ostree_upgrade: + + - name: Upgrade the rpm-ostree image allowing downgrades + ansible.posix.rpm_ostree_upgrade: + allow_downgrade: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ msg + +
+ string +
+ 		always +
The command standard output
+
+
Sample:
+
No upgrade available.
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.seboolean_module.rst b/docs/ansible.posix.seboolean_module.rst index 03a9b33..330d091 100644 --- a/docs/ansible.posix.seboolean_module.rst +++ b/docs/ansible.posix.seboolean_module.rst @@ -92,7 +92,7 @@ Parameters -
Set to yes if the boolean setting should survive a reboot.
+
Set to true if the boolean setting should survive a reboot.
@@ -135,8 +135,8 @@ Examples - name: Set httpd_can_network_connect flag on and keep it persistent across reboots ansible.posix.seboolean: name: httpd_can_network_connect - state: yes - persistent: yes + state: true + persistent: true diff --git a/docs/ansible.posix.synchronize_module.rst b/docs/ansible.posix.synchronize_module.rst index 82458df..7cb3059 100644 --- a/docs/ansible.posix.synchronize_module.rst +++ b/docs/ansible.posix.synchronize_module.rst @@ -150,7 +150,7 @@ Parameters
Delete files in dest that do not exist (after transfer, not before) in the src path.
-
This option requires recursive=yes.
+
This option requires recursive=true.
This option ignores excluded files and behaves like the rsync opt --delete-after.
@@ -465,7 +465,7 @@ Parameters
Put user@ for the remote paths.
-
If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to no.
+
If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to false.
@@ -502,8 +502,8 @@ Parameters
SSH connection multiplexing for rsync is disabled by default to prevent misconfigured ControlSockets from resulting in failed SSH connections. This is accomplished by setting the SSH ControlSocket to none.
-
Set this option to yes to allow multiplexing and reduce SSH connection overhead.
-
Note that simply setting this option to yes is not enough; You must also configure SSH connection multiplexing in your SSH client config by setting values for ControlMaster, ControlPersist and ControlPath.
+
Set this option to true to allow multiplexing and reduce SSH connection overhead.
+
Note that simply setting this option to true is not enough; You must also configure SSH connection multiplexing in your SSH client config by setting values for ControlMaster, ControlPersist and ControlPath.
@@ -595,8 +595,8 @@ See Also .. seealso:: - :ref:`copy_module` - The official documentation on the **copy** module. + :ref:`ansible.builtin.copy_module` + The official documentation on the **ansible.builtin.copy** module. :ref:`community.windows.win_robocopy_module` The official documentation on the **community.windows.win_robocopy** module. @@ -639,27 +639,27 @@ Examples ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path - archive: no + archive: false - name: Synchronization with --archive options enabled except for --recursive ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path - recursive: no + recursive: false - name: Synchronization with --archive options enabled except for --times, with --checksum option enabled ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path - checksum: yes - times: no + checksum: true + times: false - name: Synchronization without --archive options enabled except use --links ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path - archive: no - links: yes + archive: false + links: true - name: Synchronization of two paths both on the control machine ansible.posix.synchronize: @@ -689,8 +689,8 @@ Examples ansible.posix.synchronize: src: some/relative/path dest: /some/absolute/path - delete: yes - recursive: yes + delete: true + recursive: true # This specific command is granted su privileges on the destination - name: Synchronize using an alternate rsync command diff --git a/docs/ansible.posix.sysctl_module.rst b/docs/ansible.posix.sysctl_module.rst index 1f49cf6..1a3b111 100644 --- a/docs/ansible.posix.sysctl_module.rst +++ b/docs/ansible.posix.sysctl_module.rst @@ -85,7 +85,7 @@ Parameters -
If yes, performs a /sbin/sysctl -p if the sysctl_file is updated. If no, does not reload sysctl even if the sysctl_file is updated.
+
If true, performs a /sbin/sysctl -p if the sysctl_file is updated. If false, does not reload sysctl even if the sysctl_file is updated.
@@ -139,7 +139,7 @@ Parameters -
Verify token value with the sysctl command and set with -w if necessary
+
Verify token value with the sysctl command and set with -w if necessary.
@@ -186,21 +186,21 @@ Examples name: kernel.panic value: '3' sysctl_file: /tmp/test_sysctl.conf - reload: no + reload: false # Set ip forwarding on in /proc and verify token value with the sysctl command - ansible.posix.sysctl: name: net.ipv4.ip_forward value: '1' - sysctl_set: yes + sysctl_set: true # Set ip forwarding on in /proc and in the sysctl file and reload if necessary - ansible.posix.sysctl: name: net.ipv4.ip_forward value: '1' - sysctl_set: yes + sysctl_set: true state: present - reload: yes + reload: true diff --git a/galaxy.yml b/galaxy.yml index 9520636..e31ae2e 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: ansible name: posix -version: 1.5.0 +version: 1.5.2 readme: README.md authors: - Ansible (github.com/ansible)