From 65937ed8c39299d1d5ded8396c5a252b187dd59a Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Thu, 23 Dec 2021 15:17:27 +0100 Subject: [PATCH] module README files: Drop extra module header in Variables section The Variables and also the Return Variables sections contained an extra header with the module name. This is only needed if there are more than one module in the README. --- README-automember.md | 3 --- README-automountlocation.md | 3 --- README-config.md | 3 --- README-delegation.md | 3 --- README-dnsconfig.md | 3 --- README-dnsforwardzone.md | 3 --- README-dnsrecord.md | 3 --- README-dnszone.md | 6 ------ README-group.md | 3 --- README-hbacrule.md | 3 --- README-hbacsvc.md | 3 --- README-hbacsvcgroup.md | 3 --- README-host.md | 6 ------ README-hostgroup.md | 3 --- README-location.md | 3 --- README-permission.md | 3 --- README-privilege.md | 3 --- README-pwpolicy.md | 3 --- README-role.md | 3 --- README-selfservice.md | 3 --- README-server.md | 3 --- README-service.md | 2 -- README-sudocmd.md | 3 --- README-sudocmdgroup.md | 3 --- README-sudorule.md | 3 --- README-trust.md | 3 --- README-user.md | 6 ------ README-vault.md | 6 ------ utils/templates/README-module+member.md.in | 3 --- utils/templates/README-module.md.in | 3 --- 30 files changed, 101 deletions(-) diff --git a/README-automember.md b/README-automember.md index 42fc4aca..1519689b 100644 --- a/README-automember.md +++ b/README-automember.md @@ -115,9 +115,6 @@ Example playbook to add an inclusive condition to an existing rule Variables --------- -ipaautomember -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-automountlocation.md b/README-automountlocation.md index 6acb4f5b..1bf14780 100644 --- a/README-automountlocation.md +++ b/README-automountlocation.md @@ -97,9 +97,6 @@ Example playbook to ensure absence of an automount location: Variables ========= -ipaautomountlocation -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-config.md b/README-config.md index 86859471..17c85f1b 100644 --- a/README-config.md +++ b/README-config.md @@ -82,9 +82,6 @@ Example playbook to read config options: Variables ========= -ipauser -------- - **General Variables:** Variable | Description | Required diff --git a/README-delegation.md b/README-delegation.md index 643a1633..4260ed06 100644 --- a/README-delegation.md +++ b/README-delegation.md @@ -135,9 +135,6 @@ Example playbook to make sure delegation "basic manager attributes" is absent: Variables --------- -ipadelegation -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-dnsconfig.md b/README-dnsconfig.md index 33ed76f5..976251bb 100644 --- a/README-dnsconfig.md +++ b/README-dnsconfig.md @@ -119,9 +119,6 @@ Example playbook to disallow synchronization of forward (A, AAAA) and reverse (P Variables ========= -ipadnsconfig ------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-dnsforwardzone.md b/README-dnsforwardzone.md index e1ff1db0..92746984 100644 --- a/README-dnsforwardzone.md +++ b/README-dnsforwardzone.md @@ -100,9 +100,6 @@ Example playbook to ensure presence of a forwardzone to ipa DNS: Variables ========= -ipagroup -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-dnsrecord.md b/README-dnsrecord.md index 99beffbb..69838f91 100644 --- a/README-dnsrecord.md +++ b/README-dnsrecord.md @@ -242,9 +242,6 @@ Example playbook to ensure multiple DNS records are absent: Variables ========= -ipadnsrecord ------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-dnszone.md b/README-dnszone.md index 4118a97a..e6673dc0 100644 --- a/README-dnszone.md +++ b/README-dnszone.md @@ -195,9 +195,6 @@ Example playbook to create a zone for reverse DNS lookup, from an IP address, gi Variables ========= -ipadnszone ----------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no @@ -233,9 +230,6 @@ Variable | Description | Required Return Values ============= -ipadnszone ----------- - Variable | Description | Returned When -------- | ----------- | ------------- `dnszone` | DNS Zone dict with zone name infered from `name_from_ip`. <br>Options: | If `state` is `present`, `name_from_ip` is used, and a zone was created. diff --git a/README-group.md b/README-group.md index c3a27002..7d263612 100644 --- a/README-group.md +++ b/README-group.md @@ -147,9 +147,6 @@ Example playbook to remove groups: Variables ========= -ipagroup -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-hbacrule.md b/README-hbacrule.md index d246c8c9..c60d4d66 100644 --- a/README-hbacrule.md +++ b/README-hbacrule.md @@ -129,9 +129,6 @@ Example playbook to make sure HBAC Rule login is absent: Variables ========= -ipahbacrule ---------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-hbacsvc.md b/README-hbacsvc.md index 21d0f735..bf4a836c 100644 --- a/README-hbacsvc.md +++ b/README-hbacsvc.md @@ -91,9 +91,6 @@ Example playbook to make sure HBAC Services for http and tftp are absent Variables ========= -ipahbacsvc ----------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-hbacsvcgroup.md b/README-hbacsvcgroup.md index 4c9cb118..09f0f75e 100644 --- a/README-hbacsvcgroup.md +++ b/README-hbacsvcgroup.md @@ -129,9 +129,6 @@ Example playbook to make sure HBAC Service Group login is absent: Variables ========= -ipahbacsvcgroup ---------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-host.md b/README-host.md index 064b2478..10b1f829 100644 --- a/README-host.md +++ b/README-host.md @@ -313,9 +313,6 @@ Example playbook to ensure a host is absent: Variables ========= -ipahost -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no @@ -370,9 +367,6 @@ Variable | Description | Required Return Values ============= -ipahost -------- - There are only return values if one or more random passwords have been generated. Variable | Description | Returned When diff --git a/README-hostgroup.md b/README-hostgroup.md index 9c50a271..a06e2146 100644 --- a/README-hostgroup.md +++ b/README-hostgroup.md @@ -143,9 +143,6 @@ Example playbook to make sure host-group databases is absent: Variables ========= -ipahostgroup -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-location.md b/README-location.md index f551632f..e8ce363c 100644 --- a/README-location.md +++ b/README-location.md @@ -74,9 +74,6 @@ Example playbook to make sure location "my_location1" is absent: Variables --------- -ipalocation -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-permission.md b/README-permission.md index 88f1c410..d571e0b0 100644 --- a/README-permission.md +++ b/README-permission.md @@ -154,9 +154,6 @@ Example playbook to make sure permission "MyPermission" is renamed to "MyNewPerm Variables --------- -ipapermission -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-privilege.md b/README-privilege.md index ae02ff7a..593929e0 100644 --- a/README-privilege.md +++ b/README-privilege.md @@ -126,9 +126,6 @@ Example playbook to make sure privilege "DNS Special Privilege" is absent: Variables --------- -ipaprivilege ------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin`. | no diff --git a/README-pwpolicy.md b/README-pwpolicy.md index 4aefe998..7e1eb898 100644 --- a/README-pwpolicy.md +++ b/README-pwpolicy.md @@ -91,9 +91,6 @@ Example playbook to ensure maxlife is set to 49 in global policy: Variables ========= -ipapwpolicy -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-role.md b/README-role.md index fb9e2799..aa569f11 100644 --- a/README-role.md +++ b/README-role.md @@ -238,9 +238,6 @@ Example playbook to ensure that different members are not associated with a role Variables --------- -iparole -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-selfservice.md b/README-selfservice.md index 87a83591..8dc0f557 100644 --- a/README-selfservice.md +++ b/README-selfservice.md @@ -131,9 +131,6 @@ Example playbook to make sure selfservice "Users can manage their own name detai Variables --------- -ipaselfservice -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-server.md b/README-server.md index d1a4f78f..f4c46bd8 100644 --- a/README-server.md +++ b/README-server.md @@ -242,9 +242,6 @@ This task will always report a change. Variables --------- -ipaserver -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-service.md b/README-service.md index f59b083f..666c1893 100644 --- a/README-service.md +++ b/README-service.md @@ -285,8 +285,6 @@ Example playbook to allow users, groups, hosts or hostgroups to retrieve a keyta Variables --------- -ipaservice - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-sudocmd.md b/README-sudocmd.md index 7c548f32..6c479352 100644 --- a/README-sudocmd.md +++ b/README-sudocmd.md @@ -76,9 +76,6 @@ Example playbook to make sure sudocmd is absent: Variables ========= -ipasudocmd -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-sudocmdgroup.md b/README-sudocmdgroup.md index 0b1bd534..dea3c1ac 100644 --- a/README-sudocmdgroup.md +++ b/README-sudocmdgroup.md @@ -116,9 +116,6 @@ Example playbook to make sure sudocmdgroup is absent: Variables ========= -ipasudocmdgroup -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-sudorule.md b/README-sudorule.md index 28d8ab0b..089adab2 100644 --- a/README-sudorule.md +++ b/README-sudorule.md @@ -113,9 +113,6 @@ Example playbook to make sure Sudo Rule is absent: Variables ========= -ipasudorule ---------------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-trust.md b/README-trust.md index c182fa8c..ef04f6cb 100644 --- a/README-trust.md +++ b/README-trust.md @@ -94,9 +94,6 @@ This will only delete the ipa-side of the trust and it does NOT delete the id-ra Variables ========= -ipatrust -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/README-user.md b/README-user.md index 2f73d910..6cb3e629 100644 --- a/README-user.md +++ b/README-user.md @@ -356,9 +356,6 @@ Example playbook to ensure users are absent: Variables ========= -ipauser -------- - **General Variables:** Variable | Description | Required @@ -432,9 +429,6 @@ Variable | Description | Required Return Values ============= -ipauser -------- - There are only return values if one or more random passwords have been generated. Variable | Description | Returned When diff --git a/README-vault.md b/README-vault.md index a18079f0..b2d3b89f 100644 --- a/README-vault.md +++ b/README-vault.md @@ -210,9 +210,6 @@ Example playbook to make sure vault is absent: Variables ========= -ipavault -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no @@ -250,9 +247,6 @@ Variable | Description | Required Return Values ============= -ipavault --------- - There is only a return value if `state` is `retrieved`. Variable | Description | Returned When diff --git a/utils/templates/README-module+member.md.in b/utils/templates/README-module+member.md.in index 074ea4ec..4ed0d1d1 100644 --- a/utils/templates/README-module+member.md.in +++ b/utils/templates/README-module+member.md.in @@ -112,9 +112,6 @@ MORE EXAMPLE PLAYBOOKS HERE Variables --------- -ipa$name -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no diff --git a/utils/templates/README-module.md.in b/utils/templates/README-module.md.in index 25c69e4d..44f291e3 100644 --- a/utils/templates/README-module.md.in +++ b/utils/templates/README-module.md.in @@ -77,9 +77,6 @@ MORE EXAMPLE PLAYBOOKS HERE Variables --------- -ipa$name -------- - Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no -- GitLab