Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Einführung des Supervisor-Skripts und Modularisierung der S3 Restore Utilities #95

Merged
merged 8 commits into from
May 22, 2024

Conversation

kurmann
Copy link
Owner

@kurmann kurmann commented May 22, 2024

Die S3 Restore Utilities wurden durch die Einführung eines Supervisor-Skripts und die Modularisierung der einzelnen Funktionen erheblich verbessert. Diese Änderungen zielen darauf ab, den Workflow zu vereinfachen und die Nutzung der verschiedenen Funktionen konsistenter und benutzerfreundlicher zu gestalten.

Änderungen:

  1. Einführung des Supervisor-Skripts:

    • Ein zentrales Skript (supervisor.py) wurde eingeführt, um die verschiedenen Funktionen der S3 Restore Utilities zu verwalten und auszuführen.
    • Das Supervisor-Skript verwendet argparse, um Befehle und Argumente zu verarbeiten und die entsprechenden Funktionen aufzurufen.
  2. Modularisierung der Funktionen:

    • Die einzelnen Skripte (list_buckets.py, check_restore_status.py, restore_deep_glacier.py, download_s3_directory.py) wurden so angepasst, dass sie als Module importiert und innerhalb des Supervisor-Skripts aufgerufen werden können.
    • configure_aws.py wurde aktualisiert, um die AWS CLI Konfiguration über Umgebungsvariablen zu laden und in allen Modulen verwendet zu werden.
  3. Ersetzung des bisherigen Start-Skripts (start.py):

    • Das bisherige Start-Skript (start.py), das benutzereingabegesteuert war, wurde durch das neue Supervisor-Skript ersetzt.
    • Anstatt benutzereingabegesteuert zu arbeiten, bietet das Supervisor-Skript eine klare und einheitliche CLI für alle Funktionen der S3 Restore Utilities.

Vorteile für den Anwender:

  • Zentralisierte Steuerung: Alle Funktionen der S3 Restore Utilities können jetzt zentral über das supervisor.py-Skript aufgerufen und verwaltet werden. Dadurch wird die Nutzung der verschiedenen Tools vereinfacht und vereinheitlicht.
  • Klare CLI: Der Anwender muss keine Skripte mehr direkt mit python3 aufrufen. Stattdessen können alle Befehle über eine einheitliche und klare CLI aufgerufen werden, was die Bedienung erheblich vereinfacht.
  • Konsistenter Workflow: Der Aufruf der verschiedenen Funktionen erfolgt nun konsistent über das Supervisor-Skript, was Fehler reduziert und die Handhabung verbessert.
  • Entfall von Benutzereingaben: Die vorherige, benutzereingabegesteuerte Methode wurde durch eine automatische, CLI-basierte Methode ersetzt, wodurch die Nutzung schneller und weniger fehleranfällig wird.

Neue CLI

Hier sind einige Beispiele, wie die verschiedenen Skripte jetzt über Docker Compose aufgerufen werden können:

  • List Buckets Skript ausführen:

    docker-compose run s3-restore-utilities list_buckets
  • Check Restore Status Skript ausführen:

    docker-compose run s3-restore-utilities check_restore_status dein-bucket-name pfad/zum/verzeichnis
  • Restore Deep Glacier Skript ausführen:

    docker-compose run s3-restore-utilities restore_deep_glacier dein-bucket-name pfad/zum/verzeichnis [--glacier_tier Standard]
  • Download S3 Directory Skript ausführen:

    docker-compose run s3-restore-utilities download_s3_directory dein-bucket-name pfad/zum/verzeichnis lokaler-pfad

Mit diesen Änderungen wird die Nutzung der S3 Restore Utilities durch eine zentralisierte und konsistente CLI erheblich vereinfacht und verbessert.

* chore: Konfiguriere AWS CLI mit Umgebungsvariablen und unterdrücke die Ausgabe auf der Konsole aus Sicherheitsgründen.

* Standard-Wert für Glacier Tier ist "Bulk"

* chore: AWS CLI zu Beginn des Scripts `check_restore_status.py`

* chore: Configure AWS CLI at the beginning of the script `download_s3_directory.py`
* 90 aws cli config executed on start by every script (#92)

* chore: Konfiguriere AWS CLI mit Umgebungsvariablen und unterdrücke die Ausgabe auf der Konsole aus Sicherheitsgründen.

* Standard-Wert für Glacier Tier ist "Bulk"

* chore: AWS CLI zu Beginn des Scripts `check_restore_status.py`

* chore: Configure AWS CLI at the beginning of the script `download_s3_directory.py`

* chore: Skip file download if it already exists
@kurmann kurmann added the enhancement New feature or request label May 22, 2024
@kurmann kurmann linked an issue May 22, 2024 that may be closed by this pull request
3 tasks
@kurmann kurmann merged commit 1f16420 into main May 22, 2024
1 check passed
@kurmann kurmann deleted the 87-direct-script-calling-replaces-start-script branch May 22, 2024 09:38
@kurmann kurmann restored the 87-direct-script-calling-replaces-start-script branch May 22, 2024 09:38
@kurmann kurmann deleted the 87-direct-script-calling-replaces-start-script branch May 22, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Direct script calling replaces start script
1 participant