Skip to content

Remove the deprecated "search" function in favor of "get"

Akmod requested to merge vmware/idem/employeeforks/akm0d/idem-vault:search_for_list into master

This MR removes the deprecated search function in favor of the more streamlined get method within the idem-vault. As part of the update to idem-vault version 2, the following state configurations need to be changed:

Details

Old Configuration for kv_v1: 

[Idem-state-name]:
   vault.secrets.kv_v1.secret.search:
       - path: 'string'

Replace with New Configuration for kv_v1: 

[Idem-state-name]:
    exec.run:
        - path: vault.secrets.kv_v1.secret.get
        - kwargs: path: 'string'

Old Configuration for kv_v2: 

[Idem-state-name]:
   vault.secrets.kv_v2.secret.search:
       - path: 'string'

Replace with New Configuration for kv_v2: 

[Idem-state-name]:
    exec.run:
        - path: vault.secrets.kv_v2.secret.get
        - kwargs: path: 'string'

Why this change?

The deprecated search function has been replaced by the standard exec get method. This change aligns with changes in other projects.

Impact

Please review and update all states using the old search state, as it will be incompatible with the new version of idem-vault. By following the above examples, the migration to the new get method should be straightforward.

Action Required

Please ensure to replace all instances of the old search method with the new get method before updating to idem-vault version 2.

Merge request reports