# Copyright 2016
# All Rights Reserved.
#
#    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.

from oslo_config import cfg


group = cfg.OptGroup(
    name='whitebox',
    title='Whitebox Tempest plugin config options')

opts = [
    # NOTE(stephenfin): The below options are all required, but because of
    # oslo.config bug #1735790 simply adding the 'required' option won't work.
    # When that bug is resolved, however, we should use this option.
    cfg.StrOpt(
        'target_controller',
        help='Address of a controller node.'),
    cfg.StrOpt(
        'target_ssh_user',
        help='Username of the SSH connection.'),
    cfg.StrOpt(
        'target_private_key_path',
        help='Path to the private key.'),
    cfg.BoolOpt(
        'containers',
        default=False,
        help='Deployment is containerized.'),
    cfg.DictOpt(
        'hypervisors',
        help="Dictionary of hypervisor IP addresses, in the "
             "id => IP format. Should be used when the IP returned "
             "by 'nova hypervisor-show' isn't reachable from the "
             "node running tempest. Starting with microversion "
             "2.53, the id is a UUID."),
]