howler-api 3.3.0.dev708__tar.gz → 3.3.0.dev710__tar.gz

{howler_api-3.3.0.dev708 → howler_api-3.3.0.dev710}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 3.3.0.dev708
+Version: 3.3.0.dev710
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

howler_api-3.3.0.dev710/howler/external/README.md

@@ -0,0 +1,30 @@
+# External scripts
+
+## reindex_data.py
+
+Reindex one or more Elasticsearch indexes used by Howler.
+
+### Usage
+
+```bash
+# Reindex specific indexes (confirms each one before proceeding)
+python reindex_data.py hit user
+
+# Reindex all indexes
+python reindex_data.py --all
+
+# Skip confirmation prompts and countdown
+python reindex_data.py hit --force
+
+# Print index schema before reindexing
+python reindex_data.py hit --verbose
+```
+
+### Options
+
+| Argument    | Description                                  |
+|-------------|----------------------------------------------|
+| `indexes`   | One or more index names to reindex.          |
+| `--all`     | Reindex all indexes.                         |
+| `--force`   | Skip confirmation prompts and countdown.     |
+| `--verbose` | Print the index schema before reindexing.    |

howler_api-3.3.0.dev710/howler/external/reindex_data.py

@@ -0,0 +1,64 @@
+import argparse
+import json
+import time
+
+DELAY = 5
+INDEX_NAMES = ["analytic", "hit", "view", "template", "overview", "action", "user", "dossier"]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="Reindex elasticsearch indexes.",
+        epilog=f"Valid index names: {', '.join(INDEX_NAMES)}",
+    )
+    parser.add_argument("indexes", nargs="*", help="Indexes to reindex.")
+    parser.add_argument("--all", action="store_true", help="Reindex all indexes.")
+    parser.add_argument("--force", action="store_true", help="Skip confirmation prompts and countdown.")
+    parser.add_argument("--verbose", action="store_true", help="Print index schema before reindexing.")
+    args = parser.parse_args()
+
+    if args.all and args.indexes:
+        parser.error("--all cannot be combined with positional index arguments.")
+
+    if not args.indexes and not args.all:
+        parser.error("Provide index names as arguments, or use --all.")
+
+    invalid = [name for name in args.indexes if name not in INDEX_NAMES]
+    if invalid:
+        parser.error(f"Invalid index(es): {', '.join(invalid)}. Valid options: {', '.join(INDEX_NAMES)}")
+
+    from howler.datastore.collection import ESCollection
+
+    ESCollection.IGNORE_ENSURE_COLLECTION = True
+
+    if args.force:
+        ESCollection.ENSURE_COLLECTION_WARNED = True
+
+    from howler.common import loader
+
+    ds = loader.datastore(archive_access=False)
+
+    selected = list(dict.fromkeys(INDEX_NAMES if args.all else args.indexes))
+
+    for index_name in selected:
+        collection: ESCollection = getattr(ds, index_name)
+
+        if args.verbose:
+            print(f"Index schema for '{index_name}':")
+            print(json.dumps(collection._get_index_mappings(), indent=2))
+
+        print(f"Reindexing: {', '.join(collection.index_list_full)}")
+
+        if not args.force:
+            answer = input(f"Are you sure you want to reindex '{index_name}'? [yes/NO] ")
+            if not answer.startswith("y"):
+                print("Confirmation not provided, skipping.")
+                continue
+
+            for i in range(2 * DELAY):
+                print(f"Reindexing in {2 * DELAY - i}...", end="\r")
+                time.sleep(1)
+            print()
+
+        result = collection.reindex()
+        print(f"Reindex of '{index_name}' complete. Success: {result}.")

{howler_api-3.3.0.dev708 → howler_api-3.3.0.dev710}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "3.3.0.dev708"
+version = "3.3.0.dev710"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",

howler_api-3.3.0.dev708/howler/external/reindex_data.py

@@ -1,66 +0,0 @@
-import json
-import sys
-import time
-from typing import Callable
-
-DELAY = 5
-
-
-if __name__ == "__main__":
-    print("This script will allow you to reindex all indexes in elasticsearch.")
-    print("For obvious reasons, be EXTREMELY CAREFUL running this code.")
-    print()
-    answer = input("Are you sure you want to reindex data for an index in this cluster? [yes/NO]\n")
-
-    if not answer.startswith("y"):
-        print("Confirmation not provided, stopping.")
-        sys.exit(1)
-
-    from howler.datastore.collection import ESCollection
-
-    ESCollection.IGNORE_ENSURE_COLLECTION = True
-
-    from howler.common import loader
-
-    ds = loader.datastore(archive_access=False)
-
-    indexes: dict[str, tuple[ESCollection, Callable]] = {
-        "analytic": (ds.analytic, ds.analytic.reindex),
-        "hit": (ds.hit, ds.hit.reindex),
-        "view": (ds.view, ds.view.reindex),
-        "template": (ds.template, ds.template.reindex),
-        "overview": (ds.overview, ds.overview.reindex),
-        "action": (ds.action, ds.action.reindex),
-        "user": (ds.user, ds.user.reindex),
-        "dossier": (ds.dossier, ds.dossier.reindex),
-    }
-
-    print("Which index will you reindex?")
-    index_answer = input(", ".join(indexes.keys()) + "\n> ")
-
-    if index_answer not in indexes:
-        print("Invalid index provided, stopping.")
-        sys.exit(1)
-
-    print("Index schema:")
-    print(json.dumps(indexes[index_answer][0]._get_index_mappings(), indent=2))
-
-    print("\nYou will be reindexing the following indexes:")
-    print("\n".join(indexes[index_answer][0].index_list_full))
-
-    answer = input(("\nAre you sure you want to reindex these indexes? [yes/NO]\n"))
-    print()
-
-    if not answer.startswith("y"):
-        print("Confirmation not provided, stopping.")
-        sys.exit(1)
-
-    for i in range(2 * DELAY):
-        print(f"Reindexing in {2 * DELAY - i}...", end="\r")
-        time.sleep(1)
-
-    print()
-
-    result = indexes[index_answer][1]()
-
-    print(f"Reindex complete. Success: {result}.")