.. _envoy_v3_api_file_envoy/extensions/health_checkers/redis/v3/redis.proto: Redis ===== .. _extension_envoy.health_checkers.redis: This extension may be referenced by the qualified name ``envoy.health_checkers.redis`` .. note:: This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted. .. tip:: This extension extends and can be used with the following extension category: - :ref:`envoy.health_checkers ` Redis health checker :ref:`configuration overview `. .. _envoy_v3_api_msg_extensions.health_checkers.redis.v3.Redis: extensions.health_checkers.redis.v3.Redis ----------------------------------------- :repo:`[extensions.health_checkers.redis.v3.Redis proto] ` .. code-block:: json { "key": "..." } .. _envoy_v3_api_field_extensions.health_checkers.redis.v3.Redis.key: key (`string `_) If set, optionally perform ``EXISTS `` instead of ``PING``. A return value from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance by setting the specified key to any value and waiting for traffic to drain.