Layer 7 Load Balancing¶

Rule types¶

L7 rules have the following types:

• HOST_NAME: The rule does a comparison between the HTTP/1.1 hostname in the request against the value parameter in the rule.
• PATH: The rule compares the path portion of the HTTP URI against the value parameter in the rule.
• FILE_TYPE: The rule compares the last portion of the URI against the value parameter in the rule. (eg. “txt”, “jpg”, etc.)
• HEADER: The rule looks for a header defined in the key parameter and compares it against the value parameter in the rule.
• COOKIE: The rule looks for a cookie named by the key parameter and compares it against the value parameter in the rule.
• SSL_CONN_HAS_CERT: The rule will match if the client has presented a certificate for TLS client authentication. This does not imply the certificate is valid.
• SSL_VERIFY_RESULT: This rule will match the TLS client authentication certificate validation result. A value of ‘0’ means the certificate was successfully validated. A value greater than ‘0’ means the certificate failed validation. This value follows the openssl-verify result codes.
• SSL_DN_FIELD: The rule looks for a Distinguished Name feild defined in the key parameter and compares it against the value parameter in the rule.

Comparison types¶

L7 rules of a given type always do comparisons. The types of comparisons we support are listed below. Note that not all rule types support all comparison types:

• REGEX: Perl type regular expression matching
• STARTS_WITH: String starts with
• ENDS_WITH: String ends with
• CONTAINS: String contains
• EQUAL_TO: String is equal to

Invert¶

In order to more fully express the logic required by some policies, rules may have their result inverted. That is to say, if the invert parameter of a given rule is true, the result of its comparison will be inverted. (For example, an inverted “equal to” rule effectively becomes a “not equal to”, and an inverted “regex” rule returns true only if the given regex does not match.)

Policy Logic¶

Policy logic is very simple: All the rules associated with a given policy are logically ANDed together. A request must match all the policy’s rules to match the policy.

If you need to express a logical OR operation between rules, then do this by creating multiple policies with the same action (or, possibly, by making a more elaborate regular expression).

Policy Actions¶

If an L7 policy matches a given request, then that policy’s action is executed. The following are the actions an L7 Policy may take:

• REJECT: The request is denied with an appropriate response code, and not forwarded on to any back-end pool.
• REDIRECT_TO_URL: The request is sent an HTTP redirect to the URL defined in the redirect_url parameter.
• REDIRECT_TO_POOL: The request is forwarded to the back-end pool associated with the L7 policy.

Policy Position¶

When multiple L7 Policies are associated with a listener, then the policies’ position parameter becomes important. The position parameter is used when determining the order in which L7 policies are evaluated. Here are a few notes about how policy position affects listener behavior:

• In the reference implementation (haproxy amphorae) of Octavia, haproxy enforces the following ordering regarding policy actions:
  • REJECT policies take precedence over all other policies.
  • REDIRECT_TO_URL policies take precedence over REDIRECT_TO_POOL policies.
  • REDIRECT_TO_POOL policies are only evaluated after all of the above, and in the order specified by the position of the policy.
• L7 Policies are evaluated in a specific order (as defined by the position attribute), and the first policy that matches a given request will be the one whose action is followed.
• If no policy matches a given request, then the request is routed to the listener’s default pool ,if it exists. If the listener has no default pool, then an error 503 is returned.
• Policy position numbering starts with 1.
• If a new policy is created with a position that matches that of an existing policy, then the new policy is inserted at the given position.
• If a new policy is created without specifying a position, or specifying a position that is greater than the number of policies already in the list, the new policy will just be appended to the list.
• When policies are inserted, deleted, or appended to the list, the policy position values are re-ordered from 1 without skipping numbers. For example, if policy A, B, and C have position values of 1, 2 and 3 respectively, if you delete policy B from the list, policy C’s position becomes 2.