community.general.chef_databag (8.5.0) — lookup

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This is a lookup plugin to provide access to chef data bags using the pychef package. It interfaces with the chef server api using the same methods to find a knife or chef-client config file to load parameters from, starting from either the given base path or the current working directory. The lookup order mirrors the one from Chef, all folders in the base path are walked back looking for the following configuration file in order : .chef/knife.rb, ~/.chef/knife.rb, /etc/chef/client.rb

Requirements

• pychef (L(Python library, https://pychef.readthedocs.io), C(pip install pychef))

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - ansible.builtin.debug:
        msg: "{{ lookup('community.general.chef_databag', 'name=data_bag_name item=data_bag_item') }}"

Inputs

    
item:
    description:
    - Item to fetch
    required: true

name:
    description:
    - Name of the databag
    required: true

Outputs

_raw:
  description:
  - The value from the databag.
  elements: dict
  type: list