1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
"""Set up voluptuous Schema defaults for various actions"""
from voluptuous import Schema
from curator.defaults import option_defaults
# Methods for building the schema
def action_specific(action):
"""
:param action: The name of an action
:type action: str
:returns: A :py:class:`list` containing one or more
:py:class:`~.voluptuous.schema_builder.Optional` or
:py:class:`~.voluptuous.schema_builder.Required` options from
:py:mod:`~.curator.defaults.option_defaults`, defining acceptable values
for each for the given ``action``
:rtype: list
"""
options = {
'alias': [
option_defaults.name(action),
option_defaults.warn_if_no_indices(),
option_defaults.extra_settings(),
],
'allocation': [
option_defaults.search_pattern(),
option_defaults.key(),
option_defaults.value(),
option_defaults.allocation_type(),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
],
'close': [
option_defaults.search_pattern(),
option_defaults.delete_aliases(),
option_defaults.skip_flush(),
],
'cluster_routing': [
option_defaults.routing_type(),
option_defaults.cluster_routing_setting(),
option_defaults.cluster_routing_value(),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
],
'cold2frozen': [
option_defaults.search_pattern(),
option_defaults.c2f_index_settings(),
option_defaults.c2f_ignore_index_settings(),
option_defaults.wait_for_completion('cold2frozen'),
],
'create_index': [
option_defaults.name(action),
option_defaults.ignore_existing(),
option_defaults.extra_settings(),
],
'delete_indices': [
option_defaults.search_pattern(),
],
'delete_snapshots': [
option_defaults.repository(),
option_defaults.retry_interval(),
option_defaults.retry_count(),
],
'forcemerge': [
option_defaults.search_pattern(),
option_defaults.delay(),
option_defaults.max_num_segments(),
],
'index_settings': [
option_defaults.search_pattern(),
option_defaults.index_settings(),
option_defaults.ignore_unavailable(),
option_defaults.preserve_existing(),
],
'open': [
option_defaults.search_pattern(),
],
'reindex': [
option_defaults.request_body(),
option_defaults.refresh(),
option_defaults.requests_per_second(),
option_defaults.slices(),
option_defaults.timeout(action),
option_defaults.wait_for_active_shards(action),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
option_defaults.remote_certificate(),
option_defaults.remote_client_cert(),
option_defaults.remote_client_key(),
option_defaults.remote_filters(),
option_defaults.migration_prefix(),
option_defaults.migration_suffix(),
],
'replicas': [
option_defaults.search_pattern(),
option_defaults.count(),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
],
'rollover': [
option_defaults.name(action),
option_defaults.new_index(),
option_defaults.conditions(),
option_defaults.extra_settings(),
option_defaults.wait_for_active_shards(action),
],
'restore': [
option_defaults.repository(),
option_defaults.name(action),
option_defaults.indices(),
option_defaults.ignore_unavailable(),
option_defaults.include_aliases(),
option_defaults.include_global_state(action),
option_defaults.partial(),
option_defaults.rename_pattern(),
option_defaults.rename_replacement(),
option_defaults.extra_settings(),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
option_defaults.skip_repo_fs_check(),
],
'snapshot': [
option_defaults.search_pattern(),
option_defaults.repository(),
option_defaults.name(action),
option_defaults.ignore_unavailable(),
option_defaults.include_global_state(action),
option_defaults.partial(),
option_defaults.wait_for_completion(action),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
option_defaults.skip_repo_fs_check(),
],
'shrink': [
option_defaults.search_pattern(),
option_defaults.shrink_node(),
option_defaults.node_filters(),
option_defaults.number_of_shards(),
option_defaults.number_of_replicas(),
option_defaults.shrink_prefix(),
option_defaults.shrink_suffix(),
option_defaults.copy_aliases(),
option_defaults.delete_after(),
option_defaults.post_allocation(),
option_defaults.wait_for_active_shards(action),
option_defaults.extra_settings(),
option_defaults.wait_for_completion(action),
option_defaults.wait_for_rebalance(),
option_defaults.wait_interval(action),
option_defaults.max_wait(action),
],
}
return options[action]
def get_schema(action):
"""
Return a :py:class:`~.voluptuous.schema_builder.Schema` of acceptable options
and their default values as returned by :py:func:`action_specific`, passing
along the value of ``action``.
:param action: The name of an action
:type action: str
:returns: A valid :py:class:`~.voluptuous.schema_builder.Schema` of the options
for ``action``
"""
options = {}
defaults = [
option_defaults.allow_ilm_indices(),
option_defaults.continue_if_exception(),
option_defaults.disable_action(),
option_defaults.ignore_empty_list(),
option_defaults.include_hidden(),
option_defaults.timeout_override(action),
]
for each in defaults:
options.update(each)
for each in action_specific(action):
options.update(each)
return Schema(options)
|