Bug 1830941

Summary: [ansible-freeipa] vault_retrieve is missing from the vault module
Product: Red Hat Enterprise Linux 8 Reporter: Varun Mylaraiah <mvarun>
Component: ansible-freeipaAssignee: Rafael Jeffman <rjeffman>
Status: CLOSED ERRATA QA Contact: ipa-qe <ipa-qe>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.3CC: rjeffman, twoerner
Target Milestone: rcFlags: pm-rhel: mirror+
Target Release: 8.0   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: ansible-freeipa-0.1.11-1 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-11-04 02:46:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Varun Mylaraiah 2020-05-04 11:48:59 UTC
Description of problem:
In the ansible freeipa vault module, There is no option to retrieve data from the vault.

Version-Release number of selected component (if applicable):
ansible-freeipa-0.1.9-1

Expected results:
CLI option
vault-retrieve  :: Retrieve a data from a vault.


ipa vault-retrieve --help
Usage: ipa [global-options] vault-retrieve NAME [options]

Retrieve data from a vault.
Options:
  -h, --help            show this help message and exit
  --service=PRINCIPAL   Service name of the service vault
  --shared              Shared vault
  --user=STR            Username of the user vault
  --all                 Retrieve and print all attributes from the server.
                        Affects command output.
  --raw                 Print entries as stored on the server. Only affects
                        output format.
  --out=STR             File to store retrieved data
  --password=STR        Vault password
  --password-file=STR   File containing the vault password
  --private-key=BYTES   Vault private key
  --private-key-file=STR
                        File containing the vault private key

Comment 1 Rafael Jeffman 2020-05-07 03:08:42 UTC
Proposed fix on upstream PR: https://github.com/freeipa/ansible-freeipa/pull/263

Comment 2 Rafael Jeffman 2020-05-29 18:40:28 UTC
After review, the upstream PR is at https://github.com/freeipa/ansible-freeipa/pull/275

Comment 4 Thomas Woerner 2020-06-11 14:02:18 UTC
The upstream PR has been merged.

Comment 7 Varun Mylaraiah 2020-07-28 04:16:28 UTC
Verified

ansible-freeipa-0.1.12-5.el8.noarch

Automation test result:
ansible-freeipa-tests/ansible_freeipa_tests/vault_module.py::TestStandardVault::()::test_standard_vault_with_retrieved_data
------------------------------ Captured log call -------------------------------
channel.py                1212 DEBUG    [chan 53] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 53] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 53 opened.
transport.py               318 INFO     RUN ['kinit', 'admin']
transport.py               519 DEBUG    RUN ['kinit', 'admin']
channel.py                1212 DEBUG    [chan 53] Sesch channel 53 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    Password for admin: 
channel.py                1212 DEBUG    [chan 53] EOF received (53)
channel.py                1212 DEBUG    [chan 53] EOF sent (53)
transport.py               217 DEBUG    Exit code: 0
channel.py                1212 DEBUG    [chan 54] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 54] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 54 opened.
transport.py               318 INFO     RUN ['ipa', 'vault-retrieve', '21stdvault']
transport.py               519 DEBUG    RUN ['ipa', 'vault-retrieve', '21stdvault']
channel.py                1212 DEBUG    [chan 54] Sesch channel 54 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    --------------------------------------
transport.py               563 DEBUG    Retrieved data from vault "21stdvault"
transport.py               563 DEBUG    --------------------------------------
transport.py               563 DEBUG      Data: VGVzdF9WYXVsdF9EYXRh
channel.py                1212 DEBUG    [chan 54] EOF received (54)
channel.py                1212 DEBUG    [chan 54] EOF sent (54)
transport.py               217 DEBUG    Exit code: 0
channel.py                1212 DEBUG    [chan 55] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 55] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 55 opened.
transport.py               318 INFO     RUN ['kdestroy', '-A']
transport.py               519 DEBUG    RUN ['kdestroy', '-A']
channel.py                1212 DEBUG    [chan 55] Sesch channel 55 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
channel.py                1212 DEBUG    [chan 55] EOF received (55)
channel.py                1212 DEBUG    [chan 55] EOF sent (55)
transport.py               217 DEBUG    Exit code: 0
transport.py               293 INFO     WRITE inventory/vault.hosts
sftp.py                    158 DEBUG    [chan 0] open(b'inventory/vault.hosts', 'wb')
sftp.py                    158 DEBUG    [chan 0] open(b'inventory/vault.hosts', 'wb') -> 00000000
sftp.py                    158 DEBUG    [chan 0] close(00000000)
transport.py               329 INFO     PUT vault_module.yml
sftp.py                    158 DEBUG    [chan 0] open(b'vault_module.yml', 'wb')
sftp.py                    158 DEBUG    [chan 0] open(b'vault_module.yml', 'wb') -> 00000000
sftp.py                    158 DEBUG    [chan 0] close(00000000)
sftp.py                    158 DEBUG    [chan 0] stat(b'vault_module.yml')
channel.py                1212 DEBUG    [chan 13] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 13] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 13 opened.
transport.py               318 INFO     RUN ['ansible-playbook', '--ssh-extra-args="-o StrictHostKeyChecking=no"', '-vv', '-i', 'inventory/vault.hosts', 'vault_module.yml']
transport.py               519 DEBUG    RUN ['ansible-playbook', '--ssh-extra-args="-o StrictHostKeyChecking=no"', '-vv', '-i', 'inventory/vault.hosts', 'vault_module.yml']
channel.py                1212 DEBUG    [chan 13] Sesch channel 13 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    ansible-playbook 2.9.11
transport.py               563 DEBUG      config file = /root/ansible.cfg
transport.py               563 DEBUG      configured module search path = ['/root/ansible-freeipa/plugins/modules', '/usr/share/ansible/plugins/modules']
transport.py               563 DEBUG      ansible python module location = /usr/lib/python3.6/site-packages/ansible
transport.py               563 DEBUG      executable location = /usr/bin/ansible-playbook
transport.py               563 DEBUG      python version = 3.6.8 (default, Jun 26 2020, 12:10:09) [GCC 8.3.1 20191121 (Red Hat 8.3.1-5)]
transport.py               563 DEBUG    Using /root/ansible.cfg as config file
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAYBOOK: vault_module.yml *****************************************************
transport.py               563 DEBUG    1 plays in vault_module.yml
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAY [Playbook to ensure data is retrieved from standard vault.] ***************
transport.py               563 DEBUG    
transport.py               563 DEBUG    TASK [Gathering Facts] *********************************************************
transport.py               563 DEBUG    task path: /root/vault_module.yml:2
transport.py               563 DEBUG    ok: [master.ipadomain.test]
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    
transport.py               563 DEBUG    TASK [ipavault] ****************************************************************
transport.py               563 DEBUG    task path: /root/vault_module.yml:6
transport.py               563 DEBUG    ok: [master.ipadomain.test] => {"changed": false, "data": "Test_Vault_Data"}
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAY RECAP *********************************************************************
transport.py               563 DEBUG    master.ipadomain.test      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
transport.py               563 DEBUG    
channel.py                1212 DEBUG    [chan 13] EOF received (13)
channel.py                1212 DEBUG    [chan 13] EOF sent (13)
transport.py               217 DEBUG    Exit code: 0

Comment 10 errata-xmlrpc 2020-11-04 02:46:35 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (ansible-freeipa bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2020:4663