# 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/networking-ovn/latest/admin/loadbalancer.html

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

[operation.action.REDIRECT_TO_POOL]
title=action - REDIRECT_TO_POOL
status=optional
notes=The L7 policy action REDIRECT_TO_POOL.
cli=openstack loadbalancer l7policy create --action REDIRECT_TO_POOL <listener>
driver.amphora=complete
driver.ovn=missing

[operation.action.REDIRECT_TO_PREFIX]
title=action - REDIRECT_TO_PREFIX
status=optional
notes=The L7 policy action REDIRECT_TO_PREFIX.
cli=openstack loadbalancer l7policy create --action REDIRECT_TO_PREFIX <listener>
driver.amphora=complete
driver.ovn=missing

[operation.action.REDIRECT_TO_URL]
title=action - REDIRECT_TO_URL
status=optional
notes=The L7 policy action REDIRECT_TO_URL.
cli=openstack loadbalancer l7policy create --action REDIRECT_TO_URL <listener>
driver.amphora=complete
driver.ovn=missing

[operation.action.REJECT]
title=action - REJECT
status=optional
notes=The L7 policy action REJECT.
cli=openstack loadbalancer l7policy create --action REJECT <listener>
driver.amphora=complete
driver.ovn=missing

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

[operation.description]
title=description
status=optional
notes=The description of the L7 policy. Provided by the Octavia API service.
cli=openstack loadbalancer l7policy create [--description <description>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.name]
title=name
status=optional
notes=The name of the L7 policy. Provided by the Octavia API service.
cli=openstack loadbalancer l7policy create [--name <name>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.position]
title=position
status=optional
notes=The position of this policy on the listener.
cli=openstack loadbalancer l7policy create [--position <position>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.redirect_http_code]
title=redirect_http_code
status=optional
notes=Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code.
cli=openstack loadbalancer l7policy create [--redirect-http-code <redirect_http_code>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.redirect_pool_id]
title=redirect_pool_id
status=optional
notes=Requests matching this policy will be redirected to the pool with this ID.
cli=openstack loadbalancer l7policy create [--redirect-pool <pool>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.redirect_prefix]
title=redirect_prefix
status=optional
notes=Requests matching this policy will be redirected to this Prefix URL.
cli=openstack loadbalancer l7policy create [--redirect-prefix <url>] <listener>
driver.amphora=complete
driver.ovn=missing

[operation.redirect_url]
title=redirect_url
status=optional
notes=Requests matching this policy will be redirected to this URL.
cli=openstack loadbalancer l7policy create [--redirect-url <url>] <listener>
driver.amphora=complete
driver.ovn=missing

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