Skip to content

Commit

Permalink
README-*: Bump minimum supported Ansible version to 2.13
Browse files Browse the repository at this point in the history 
As ansible-freeipa roles do not support version 2.8 anymore, change the
minimum supported version to 2.13, which is the currently minimum
available and supported Ansible version.

This patch fixes documentation on all plugin READMEs, spec file and
module templates.
  • Loading branch information
@rjeffman
rjeffman committed Sep 5, 2023
1 parent 70cb7aa commit 69c7bd1
Show file tree
Hide file tree
Showing 40 changed files with 42 additions and 50 deletions.
2 changes: 1 addition & 1 deletion README-automember.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-automountkey.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ FreeIPA versions 4.4.0 and up are supported by the ipaautomountkey module.
Requirements
------------
**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-automountlocation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ FreeIPA versions 4.4.0 and up are supported by the ipaautomountlocation module.
Requirements
------------
**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-automountmap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ FreeIPA versions 4.4.0 and up are supported by the ipaautomountmap module.
Requirements
------------
**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-cert.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+
* Some tool to generate a certificate signing request (CSR) might be needed, like `openssl`.

**Node**
Expand Down
2 changes: 1 addition & 1 deletion README-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-delegation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-dnsconfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-dnsforwardzone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ FreeIPA versions 4.4.0 and up are supported by the ipadnsforwardzone module.
Requirements
------------
**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-dnsrecord.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-dnszone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+


**Node**
Expand Down
2 changes: 1 addition & 1 deletion README-group.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-hbacrule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-hbacsvc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-hbacsvcgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-host.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-hostgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-idrange.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-location.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-netgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-permission.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-privilege.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-pwpolicy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-role.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-selfservice.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FReeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-servicedelegationrule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-servicedelegationtarget.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-sudocmd.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-sudocmdgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-sudorule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-topology.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-trust.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Requirements

**Controller**

* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**

Expand Down
2 changes: 1 addition & 1 deletion README-user.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion README-vault.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
12 changes: 1 addition & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+ (ansible-freeipa is an Ansible Collection)
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down Expand Up @@ -129,18 +129,8 @@ This command will get the whole collection from galaxy:
ansible-galaxy collection install freeipa.ansible_freeipa
```

Installing collections using the ansible-galaxy command is only supported with ansible 2.9+.

The mazer tool can be used for to install the collection for ansible 2.8:

```bash
mazer install freeipa.ansible_freeipa
```

Ansible galaxy does not support the use of dash ('-') in a name and is automatically replacing this with an underscore ('\_'). Therefore the name is `ansible_freeipa`. The ansible_freeipa collection will be placed in the directory `~/.ansible/collections/ansible_collections/freeipa/ansible_freeipa` where it will be automatically be found for this user.

The needed adaptions of collection prefixes for `modules` and `module_utils` will be done with ansible-freeipa release `0.1.6` for galaxy.


Ansible inventory file
----------------------
Expand Down
4 changes: 3 additions & 1 deletion utils/ansible-freeipa.spec.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Features
- Modules for automount key management
- Modules for automount location management
- Modules for automount map management
- Modules for certificate management
- Modules for config management
- Modules for delegation management
- Modules for dns config management
Expand All @@ -49,6 +50,7 @@ Features
- Modules for hostgroup management
- Modules for idrange management
- Modules for location management
- Modules for netgroup management
- Modules for permission management
- Modules for privilege management
- Modules for pwpolicy management
Expand Down Expand Up @@ -84,7 +86,7 @@ Supported Distributions
Requirements

Controller
- Ansible version: 2.8+ (ansible-freeipa is an Ansible Collection)
- Ansible version: 2.13+
- /usr/bin/kinit is required on the controller if a one time password (OTP)
is used

Expand Down
2 changes: 1 addition & 1 deletion utils/templates/README-module+member.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down
2 changes: 1 addition & 1 deletion utils/templates/README-module.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Requirements
------------

**Controller**
* Ansible version: 2.8+
* Ansible version: 2.13+

**Node**
* Supported FreeIPA version (see above)
Expand Down

0 comments on commit 69c7bd1

Please sign in to comment.