# Copyright (c) 2019 Red Hat, Inc.

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

[driver.amphora]
title=Amphora Provider
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html

[driver.ovn]
title=OVN Provider
link=https://docs.openstack.org/ovn-octavia-provider/latest/admin/driver.html

# Note: These should be in the order they appear in a create call.

[operation.admin_state_up]
title=admin_state_up
status=mandatory
notes=Enables and disables the L7 rule.
cli=openstack loadbalancer l7rule create [--enable | --disable] <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.compare_type.CONTAINS]
title=compare_type - CONTAINS
status=mandatory
notes=The CONTAINS comparison type for the L7 rule.
cli=openstack loadbalancer l7rule create --compare-type CONTAINS <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.compare_type.ENDS_WITH]
title=compare_type - ENDS_WITH
status=mandatory
notes=The ENDS_WITH comparison type for the L7 rule.
cli=openstack loadbalancer l7rule create --compare-type ENDS_WITH <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.compare_type.EQUAL_TO]
title=compare_type - EQUAL_TO
status=mandatory
notes=The EQUAL_TO comparison type for the L7 rule.
cli=openstack loadbalancer l7rule create --compare-type EQUAL_TO <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.compare_type.REGEX]
title=compare_type - REGEX
status=mandatory
notes=The REGEX comparison type for the L7 rule.
cli=openstack loadbalancer l7rule create --compare-type REGEX <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.compare_type.STARTS_WITH]
title=compare_type - STARTS_WITH
status=mandatory
notes=The STARTS_WITH comparison type for the L7 rule.
cli=openstack loadbalancer l7rule create --compare-type STARTS_WITH <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.invert]
title=invert
status=optional
notes=When true the logic of the rule is inverted.
cli=openstack loadbalancer l7rule create [--invert] <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.key]
title=key
status=optional
notes=The key to use for the comparison.
cli=openstack loadbalancer l7rule create [--key <key>] <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.tags]
title=tags
status=optional
notes=The tags for the L7 rule. Provided by the Octavia API service.
cli=openstack loadbalancer l7rule create [--tag <tag>] <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.COOKIE]
title=type - COOKIE
status=optional
notes=The COOKIE L7 rule type.
cli=openstack loadbalancer l7rule create --type COOKIE <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.FILE_TYPE]
title=type - FILE_TYPE
status=optional
notes=The FILE_TYPE L7 rule type.
cli=openstack loadbalancer l7rule create --type FILE_TYPE <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.HEADER]
title=type - HEADER
status=optional
notes=The HEADER L7 rule type.
cli=openstack loadbalancer l7rule create --type HEADER <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.HOST_NAME]
title=type - HOST_NAME
status=optional
notes=The HOST_NAME L7 rule type.
cli=openstack loadbalancer l7rule create --type HOST_NAME <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.PATH]
title=type - PATH
status=optional
notes=The PATH L7 rule type.
cli=openstack loadbalancer l7rule create --type PATH <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.SSL_CONN_HAS_CERT]
title=type - SSL_CONN_HAS_CERT
status=optional
notes=The SSL_CONN_HAS_CERT L7 rule type.
cli=openstack loadbalancer l7rule create --type SSL_CONN_HAS_CERT <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.SSL_VERIFY_RESULT]
title=type - SSL_VERIFY_RESULT
status=optional
notes=The SSL_VERIFY_RESULT L7 rule type.
cli=openstack loadbalancer l7rule create --type SSL_VERIFY_RESULT <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.type.SSL_DN_FIELD]
title=type - SSL_DN_FIELD
status=optional
notes=The SSL_DN_FIELD L7 rule type.
cli=openstack loadbalancer l7rule create --type SSL_DN_FIELD <l7policy>
driver.amphora=complete
driver.ovn=missing

[operation.value]
title=value
status=mandatory
notes=The value to use for the comparison.
cli=openstack loadbalancer l7rule create --value <value> <l7policy>
driver.amphora=complete
driver.ovn=missing