Skip to content

[DOCS] absent info about install python package python3-redis for redis_cache #60899

@unix196

Description

@unix196

Description
In documentation about salt.cache.redis_cache absent info about installing important package:
pip python3-redis
Otherwise in salt master log:

2021-09-20 03:42:04,327 [salt.master      :1879][ERROR   ][39] Error in function _mine:
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/salt/master.py", line 1872, in run_func
    ret = getattr(self, func)(load)
  File "/usr/lib/python3/dist-packages/salt/master.py", line 1441, in _mine
    return self.masterapi._mine(load, skip_verify=True)
  File "/usr/lib/python3/dist-packages/salt/daemons/masterapi.py", line 608, in _mine
    data = self.cache.fetch(cbank, ckey)
  File "/usr/lib/python3/dist-packages/salt/cache/__init__.py", line 180, in fetch
    return self.modules[fun](bank, key, **self._kwargs)
  File "/usr/lib/python3/dist-packages/salt/loader.py", line 1208, in __getitem__
    func = super(LazyLoader, self).__getitem__(item)
  File "/usr/lib/python3/dist-packages/salt/utils/lazy.py", line 108, in __getitem__
    raise KeyError(key)
KeyError: 'redis.fetch'

#57069 - issue with the same problem.

Suggested Fix
For example in doc about etcd_cache:

To enable this cache plugin, the master will need the python client for Etcd installed. This can be easily installed with pip:
pip install python-etcd

Type of documentation
cache modules

Location or format of documentation
https://docs.saltproject.io/en/latest/ref/cache/all/salt.cache.redis_cache.html#module-salt.cache.redis_cache

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelates to Salt documentationseverity-medium3rd level, incorrect or bad functionality, confusing and lacks a work aroundtime-estimate-single-day

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions