hash_policy.envoy
*****************

.. include:: template.service.hash_policy.envoy.example

.. _hash_policy.envoy.connection_source_ip:

:kw:`connection_source_ip`
==========================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

Hash on source IP address.

.. _hash_policy.envoy.cookie_name:

:kw:`cookie_name`
=================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

The name of the cookie that will be used to obtain the hash key. If the cookie is not present and ttl below is not set, no hash will be produced.

.. _hash_policy.envoy.cookie_path:

:kw:`cookie_path`
=================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.

.. _hash_policy.envoy.cookie_ttl:

:kw:`cookie_ttl`
================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       duration
================= ================================================================

If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie.

.. _hash_policy.envoy.header_header_name:

:kw:`header_header_name`
========================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

The name of the request header that will be used to obtain the hash key. If the request header is not present, no hash will be produced.

.. _hash_policy.envoy.terminal:

:kw:`terminal`
==============

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       boolean
================= ================================================================

Shortcircuits the hash computing. This field provides a fallback style of configuration: if a terminal policy doesn't work, fallback to rest of the policy list. It saves time when the terminal policy works.