From e96ef4e98e523f20c25777308c093ebbff272b2d Mon Sep 17 00:00:00 2001 From: Rafael Guterres Jeffman Date: Wed, 5 Aug 2020 15:24:15 -0300 Subject: [PATCH 1/3] Updated documentation for ipavault module in the source code. This change fixes a wrong parameter name in the documentation of RESULT_VALUES, and also provide a correct YAML snippet to ensure presence of an asymmetric vault with a formatted private key. --- plugins/modules/ipavault.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/modules/ipavault.py b/plugins/modules/ipavault.py index 46c6fcdb..84645c73 100644 --- a/plugins/modules/ipavault.py +++ b/plugins/modules/ipavault.py @@ -267,7 +267,7 @@ EXAMPLES = """ username: user01 description: An asymmetric vault vault_type: asymmetric - public_key: + public_key: | LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlHZk1BMEdDU3FHU0liM0RRRUJBUVVBQTR HTkFEQ0JpUUtCZ1FDdGFudjRkK3ptSTZ0T3ova1RXdGowY3AxRAowUENoYy8vR0pJMTUzTi 9CN3UrN0h3SXlRVlZoNUlXZG1UcCtkWXYzd09yeVpPbzYvbHN5eFJaZ2pZRDRwQ3VGCjlxM @@ -303,7 +303,7 @@ EXAMPLES = """ """ RETURN = """ -user: +data: description: The vault data. returned: If state is retrieved. type: string From cee8b3a39b28f415889d940488cbf08308018c84 Mon Sep 17 00:00:00 2001 From: Rafael Guterres Jeffman Date: Wed, 5 Aug 2020 15:28:22 -0300 Subject: [PATCH 2/3] Fix README for ipaservice module. The attribute `skip_host_check` was using dashes instead of underscores, and the certificate examples could not be used directly due to formatting. These changes fix both issues. --- README-service.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README-service.md b/README-service.md index fd2a6d3c..d93d5002 100644 --- a/README-service.md +++ b/README-service.md @@ -56,7 +56,7 @@ Example playbook to make sure service is present: - ipaservice: ipaadmin_password: SomeADMINpassword name: HTTP/www.example.com - certificate: + certificate: | - MIIC/zCCAeegAwIBAgIUMNHIbn+hhrOVew/2WbkteisV29QwDQYJKoZIhvcNAQELBQAw DzENMAsGA1UEAwwEdGVzdDAeFw0yMDAyMDQxNDQxMDhaFw0zMDAyMDExNDQxMDhaMA8xDT ALBgNVBAMMBHRlc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC+XVVGFYpH @@ -77,7 +77,7 @@ Example playbook to make sure service is present: requires_pre_auth: false ok_as_delegate: false ok_to_auth_as_delegate: false - skip-host-check: true + skip_host_check: true force: true ``` @@ -167,7 +167,7 @@ Example playbook to ensure service has a certificate: - ipaservice: ipaadmin_password: SomeADMINpassword name: HTTP/www.example.com - certificate: + certificate: | - MIIC/zCCAeegAwIBAgIUMNHIbn+hhrOVew/2WbkteisV29QwDQYJKoZIhvcNAQELBQAw DzENMAsGA1UEAwwEdGVzdDAeFw0yMDAyMDQxNDQxMDhaFw0zMDAyMDExNDQxMDhaMA8xDT ALBgNVBAMMBHRlc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC+XVVGFYpH From ee370ad3f8cdfd6bec3220fd4bec4621816fb1f0 Mon Sep 17 00:00:00 2001 From: Rafael Guterres Jeffman Date: Wed, 5 Aug 2020 15:33:42 -0300 Subject: [PATCH 3/3] Fix documentation for iparole module. Replaced occurrences of `service` where `role` was expected, in both module source code and module README. --- README-role.md | 4 ++-- plugins/modules/iparole.py | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README-role.md b/README-role.md index 49e3e581..e046297c 100644 --- a/README-role.md +++ b/README-role.md @@ -1,5 +1,5 @@ -Service module -============== +Role module +=========== Description ----------- diff --git a/plugins/modules/iparole.py b/plugins/modules/iparole.py index cc6f6a8f..31b01788 100644 --- a/plugins/modules/iparole.py +++ b/plugins/modules/iparole.py @@ -30,9 +30,9 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- -module: ipaservice -short description: Manage FreeIPA service -description: Manage FreeIPA service +module: iparole +short description: Manage FreeIPA role +description: Manage FreeIPA role options: ipaadmin_principal: description: The admin principal. @@ -66,7 +66,7 @@ options: description: List of services. required: false action: - description: Work on service or member level. + description: Work on role or member level. choices: ["role", "member"] default: role required: false