Merge branch 'master' into 8.x

Author: untergeek

.github/workflows/docs-build.yml

@@ -0,0 +1,19 @@
+name: docs-build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request_target: ~
+  merge_group: ~
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
+    with:
+      path-pattern: docs/**
+    permissions:
+      deployments: write
+      id-token: write
+      contents: read
+      pull-requests: read

.github/workflows/docs-cleanup.yml

@@ -0,0 +1,14 @@
+name: docs-cleanup
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@main
+    permissions:
+      contents: none
+      id-token: write
+      deployments: write

.gitignore

@@ -2,11 +2,10 @@
 localhost.es
 oneliners.py
 cacert.pem
-docs/
+docs/asciidoc.bak
 docker_test/.env
 docker_test/repo/
 docker_test/curatortestenv
-docker_test/scripts/Dockerfile
 html_docs/
 
 # Byte-compiled / optimized / DLL files

curator/_version.py

@@ -1,3 +1,3 @@
 """Curator Version"""
 
-__version__ = '8.0.17'
+__version__ = '8.0.18'

curator/actions/alias.py

@@ -1,19 +1,24 @@
 """Alias action"""
+
 import logging
+
 # pylint: disable=import-error
 from curator.exceptions import ActionError, MissingArgument, NoIndices
 from curator.helpers.date_ops import parse_date_pattern, parse_datemath
 from curator.helpers.testers import verify_index_list
 from curator.helpers.utils import report_failure
 
+
 class Alias:
     """Alias Action Class"""
+
     # pylint: disable=unused-argument
     def __init__(self, name=None, extra_settings=None, **kwargs):
         """
         :param name: The alias name
-        :param extra_settings: Extra settings, including filters and routing. For more information
-            see `here </https://www.elastic.co/guide/en/elasticsearch/reference/8.6/indices-aliases.html>`_.
+        :param extra_settings: Extra settings, including filters and routing.
+            For more information see `here
+            </https://www.elastic.co/guide/en/elasticsearch/reference/8.6/indices-aliases.html>`_.
 
         :type name: str
         :type extra_settings: dict
@@ -25,14 +30,16 @@ def __init__(self, name=None, extra_settings=None, **kwargs):
         #: The :py:func:`~.curator.helpers.date_ops.parse_date_pattern` rendered
         #: version of what was passed by param ``name``.
         self.name = parse_date_pattern(name)
-        #: The list of actions to perform.  Populated by :py:meth:`~.curator.actions.Alias.add` and
+        #: The list of actions to perform.  Populated by
+        #: :py:meth:`~.curator.actions.Alias.add` and
         #: :py:meth:`~.curator.actions.Alias.remove`
         self.actions = []
-        #: The :py:class:`~.elasticsearch.Elasticsearch` client object which will later be set by
-        #: :py:meth:`~.curator.actions.Alias.add` or :py:meth:`~.curator.actions.Alias.remove`
+        #: The :py:class:`~.elasticsearch.Elasticsearch` client object which will
+        #: later be set by :py:meth:`~.curator.actions.Alias.add` or
+        #: :py:meth:`~.curator.actions.Alias.remove`
         self.client = None
-        #: Any extra things to add to the alias, like filters, or routing. Gets the value from
-        #: param ``extra_settings``.
+        #: Any extra things to add to the alias, like filters, or routing. Gets
+        #: the value from param ``extra_settings``.
         self.extra_settings = extra_settings
         self.loggit = logging.getLogger('curator.actions.alias')
         #: Preset default value to ``False``.
@@ -41,7 +48,8 @@ def __init__(self, name=None, extra_settings=None, **kwargs):
     def add(self, ilo, warn_if_no_indices=False):
         """
         Create ``add`` statements for each index in ``ilo`` for :py:attr:`name`, then
-        append them to :py:attr:`actions`.  Add any :py:attr:`extra_settings` that may be there.
+        append them to :py:attr:`actions`.  Add any :py:attr:`extra_settings` that
+        may be there.
 
         :param ilo: An IndexList Object
         :type ilo: :py:class:`~.curator.indexlist.IndexList`
@@ -58,16 +66,20 @@ def add(self, ilo, warn_if_no_indices=False):
             if warn_if_no_indices:
                 self.warn_if_no_indices = True
                 self.loggit.warning(
-                    'No indices found after processing filters. Nothing to add to %s', self.name)
+                    'No indices found after processing filters. Nothing to add to %s',
+                    self.name,
+                )
                 return
             # Re-raise the exceptions.NoIndices so it will behave as before
             raise NoIndices('No indices to add to alias') from exc
         for index in ilo.working_list():
             self.loggit.debug(
-                'Adding index %s to alias %s with extra settings '
-                '%s', index, self.name, self.extra_settings
+                'Adding index %s to alias %s with extra settings %s',
+                index,
+                self.name,
+                self.extra_settings,
             )
-            add_dict = {'add' : {'index' : index, 'alias': self.name}}
+            add_dict = {'add': {'index': index, 'alias': self.name}}
             add_dict['add'].update(self.extra_settings)
             self.actions.append(add_dict)
 
@@ -92,7 +104,8 @@ def remove(self, ilo, warn_if_no_indices=False):
                 self.warn_if_no_indices = True
                 self.loggit.warning(
                     'No indices found after processing filters. '
-                    'Nothing to remove from %s', self.name
+                    'Nothing to remove from %s',
+                    self.name,
                 )
                 return
 
@@ -104,19 +117,24 @@ def remove(self, ilo, warn_if_no_indices=False):
                 self.loggit.debug('Index %s in get_aliases output', index)
                 # Only remove if the index is associated with the alias
                 if self.name in aliases[index]['aliases']:
-                    self.loggit.debug('Removing index %s from alias %s', index, self.name)
+                    self.loggit.debug(
+                        'Removing index %s from alias %s', index, self.name
+                    )
                     self.actions.append(
-                        {'remove' : {'index' : index, 'alias': self.name}})
+                        {'remove': {'index': index, 'alias': self.name}}
+                    )
                 else:
                     self.loggit.debug(
-                        'Can not remove: Index %s is not associated with alias %s', index, self.name
+                        'Can not remove: Index %s is not associated with alias %s',
+                        index,
+                        self.name,
                     )
 
     def check_actions(self):
         """
         :returns: :py:attr:`actions` for use with the
-            :py:meth:`~.elasticsearch.client.IndicesClient.update_aliases` API call if actions
-            exist, otherwise an exception is raised.
+            :py:meth:`~.elasticsearch.client.IndicesClient.update_aliases` API
+            call if actions exist, otherwise an exception is raised.
         """
         if not self.actions:
             if not self.warn_if_no_indices:
@@ -143,8 +161,8 @@ def do_dry_run(self):
 
     def do_action(self):
         """
-        :py:meth:`~.elasticsearch.client.IndicesClient.update_aliases` for :py:attr:`name` with
-        :py:attr:`actions`
+        :py:meth:`~.elasticsearch.client.IndicesClient.update_aliases` for
+        :py:attr:`name` with :py:attr:`actions`
         """
         self.loggit.info('Updating aliases...')
         self.loggit.info('Alias actions: %s', self.actions)

curator/actions/allocation.py

@@ -1,21 +1,33 @@
 """Allocation action class"""
+
 import logging
+
 # pylint: disable=import-error
 from curator.exceptions import MissingArgument
 from curator.helpers.testers import verify_index_list
 from curator.helpers.waiters import wait_for_it
 from curator.helpers.utils import chunk_index_list, report_failure, show_dry_run, to_csv
 
+
 class Allocation:
     """Allocation Action Class"""
+
     def __init__(
-            self, ilo, key=None, value=None, allocation_type='require', wait_for_completion=False,
-            wait_interval=3, max_wait=-1
-        ):
+        self,
+        ilo,
+        key=None,
+        value=None,
+        allocation_type='require',
+        wait_for_completion=False,
+        wait_interval=3,
+        max_wait=-1,
+    ):
         """
         :param ilo: An IndexList Object
-        :param key: An arbitrary metadata attribute key.  Must match the key assigned to at least
-        :param value: An arbitrary metadata attribute value.  Must correspond to values associated
+        :param key: An arbitrary metadata attribute key.  Must match the key
+            assigned to at least one node.
+        :param value: An arbitrary metadata attribute value.  Must correspond to
+            values associated with at least one node.
         :param allocation_type: Type of allocation to apply. Default is ``require``
         :param wait_for_completion: Wait for completion before returning.
         :param wait_interval: Seconds to wait between completion checks.
@@ -30,15 +42,16 @@ def __init__(
         :type max_wait: int
 
         .. note::
-            See more about `shard allocation filtering </https://www.elastic.co/guide/en/elasticsearch/reference/8.6/shard-allocation-filtering.html>`_.
+            See more about `shard allocation filtering
+            </https://www.elastic.co/guide/en/elasticsearch/reference/8.6/shard-allocation-filtering.html>`_.
         """
         verify_index_list(ilo)
         if not key:
             raise MissingArgument('No value for "key" provided')
         if allocation_type not in ['require', 'include', 'exclude']:
             raise ValueError(
-                f'{allocation_type} is an invalid allocation_type.  Must be one of "require", '
-                '"include", "exclude".'
+                f'{allocation_type} is an invalid allocation_type.  Must be one of '
+                f'"require", "include", "exclude".'
             )
         #: The :py:class:`~.curator.indexlist.IndexList` object passed as ``ilo``
         self.index_list = ilo
@@ -50,7 +63,7 @@ def __init__(
         #: Populated at instance creation time. Value is built from the passed params
         #: ``allocation_type``, ``key``, and ``value``, e.g.
         #: ``index.routing.allocation.allocation_type.key.value``
-        self.settings = {bkey : value}
+        self.settings = {bkey: value}
         #: Object attribute that gets the value of param ``wait_for_completion``
         self.wfc = wait_for_completion
         #: Object attribute that gets the value of param ``wait_interval``
@@ -74,8 +87,9 @@ def do_action(self):
         self.index_list.filter_closed()
         self.index_list.empty_list_check()
         self.loggit.info(
-            'Updating %s selected indices: %s', len(self.index_list.indices),
-            self.index_list.indices
+            'Updating %s selected indices: %s',
+            len(self.index_list.indices),
+            self.index_list.indices,
         )
         self.loggit.info('Updating index setting %s', self.settings)
         try:
@@ -86,10 +100,14 @@ def do_action(self):
                 )
                 if self.wfc:
                     self.loggit.debug(
-                        'Waiting for shards to complete relocation for indices: %s', to_csv(lst))
+                        'Waiting for shards to complete relocation for indices: %s',
+                        to_csv(lst),
+                    )
                     wait_for_it(
-                        self.client, 'allocation',
-                        wait_interval=self.wait_interval, max_wait=self.max_wait
+                        self.client,
+                        'allocation',
+                        wait_interval=self.wait_interval,
+                        max_wait=self.max_wait,
                     )
         # pylint: disable=broad-except
         except Exception as err:

curator/actions/close.py

@@ -1,10 +1,15 @@
 """Close index action class"""
+
 import logging
+import warnings
+from elasticsearch8.exceptions import ElasticsearchWarning
 from curator.helpers.testers import verify_index_list
 from curator.helpers.utils import chunk_index_list, report_failure, show_dry_run, to_csv
 
+
 class Close:
     """Close Action Class"""
+
     def __init__(self, ilo, delete_aliases=False, skip_flush=False):
         """
         :param ilo: An IndexList Object
@@ -16,7 +21,8 @@ def __init__(self, ilo, delete_aliases=False, skip_flush=False):
         :type skip_flush: bool
         """
         verify_index_list(ilo)
-        #: The :py:class:`~.curator.indexlist.IndexList` object passed from param ``ilo``
+        #: The :py:class:`~.curator.indexlist.IndexList` object passed from
+        #: param ``ilo``
         self.index_list = ilo
         #: The value passed as ``delete_aliases``
         self.delete_aliases = delete_aliases
@@ -29,17 +35,21 @@ def __init__(self, ilo, delete_aliases=False, skip_flush=False):
 
     def do_dry_run(self):
         """Log what the output would be, but take no action."""
-        show_dry_run(self.index_list, 'close', **{'delete_aliases':self.delete_aliases})
+        show_dry_run(
+            self.index_list, 'close', **{'delete_aliases': self.delete_aliases}
+        )
 
     def do_action(self):
         """
-        :py:meth:`~.elasticsearch.client.IndicesClient.close` open indices in :py:attr:`index_list`
+        :py:meth:`~.elasticsearch.client.IndicesClient.close` open indices in
+        :py:attr:`index_list`
         """
         self.index_list.filter_closed()
         self.index_list.empty_list_check()
         self.loggit.info(
             'Closing %s selected indices: %s',
-                len(self.index_list.indices), self.index_list.indices
+            len(self.index_list.indices),
+            self.index_list.indices,
         )
         try:
             index_lists = chunk_index_list(self.index_list.indices)
@@ -50,14 +60,24 @@ def do_action(self):
                     self.loggit.info('Deleting aliases from indices before closing.')
                     self.loggit.debug('Deleting aliases from:  %s', lst)
                     try:
-                        self.client.indices.delete_alias(index=lst_as_csv, name='_all')
+                        self.client.indices.delete_alias(index=lst_as_csv, name='*')
                         self.loggit.debug('Deleted aliases from: %s', lst)
                     # pylint: disable=broad-except
                     except Exception as err:
                         self.loggit.warning(
-                            'Some indices may not have had aliases.  Exception: %s', err)
+                            'Some indices may not have had aliases.  Exception: %s', err
+                        )
                 if not self.skip_flush:
-                    self.client.indices.flush(index=lst_as_csv, ignore_unavailable=True, force=True)
+                    self.client.indices.flush(
+                        index=lst_as_csv, ignore_unavailable=True, force=True
+                    )
+                # ElasticsearchWarning: the default value for the
+                # wait_for_active_shards parameter will change from '0' to
+                # 'index-setting' in version 8;
+                # specify 'wait_for_active_shards=index-setting' to adopt the
+                # future default behaviour, or
+                # 'wait_for_active_shards=0' to preserve today's behaviour
+                warnings.filterwarnings("ignore", category=ElasticsearchWarning)
                 self.client.indices.close(index=lst_as_csv, ignore_unavailable=True)
         # pylint: disable=broad-except
         except Exception as err: