AFANDI Docs / Standardize CLI maintenance scripts
← Back to overview Getting Started

Standardize CLI maintenance scripts

Important CLI-Tasks document: Upgrade, Cache, Cron, Backups, Reports.

Moodle AFANDI standard Handover-ready documentation reviewed on a regular cycle

Quick overview

This page describes the working standard for Standardize CLI maintenance scripts – with a focus on concrete decisions rather than general guidance.

The main focus here is which data classes are protected and which RPO/RTO applies per area, so teams follow the same standard.

The standard only becomes traceable through linked evidence such as backup reports and error messages and through documented edge cases/exceptions.

Practical focusTopic-specificVerifiable

When this page helps

Typical situations in which this page adds value as a working document, and where another document is more appropriate.

Typical use cases

  • when for Standardize CLI maintenance scripts technical standards about backup jobs, time windows, and retention must be documented in a binding way
  • when team handovers or temporary cover the same process for which data classes are protected should be able to execute safely
  • when incidents or Changes show that evidence such as backup reports and error messages are still missing
  • when configuration or operational deviations (e.g. backup runs, restore was but never tested) occur repeatedly

Less suitable when

  • when Standardize CLI maintenance scripts only about a one-off individual case without need for standardization applies
  • when a detailed project ticket or a technical step-by-step guide is the better fit

Recommended process

A pragmatic sequence that works in practice, from scope to review.

  1. capture the current state and scope for Standardize CLI maintenance scripts capture, including backup jobs, time windows, and retention and critical dependencies.
  2. define the target state and standards; key decisions include which data classes are protected.
  3. test changes in a controlled way (Staging, Testsystem or Checklist) and Ergebnis document.
  4. implement in production, run follow-up checks, and backup reports and error messages + restore test logs link.
  5. Monitoring/Reviews auswerten and recurring Befunde such as „Backup runs, Restore was but never tested“ in the standard einarbeiten.

Decision rules

Note: Central standards remain ausgelagert. Here be only the for Standardize CLI maintenance scripts relevant decisions, Evidence and Exceptions maintained. Central guideline.

Standardize CLI maintenance scripts is well documented, when rules, Edge cases and Evidence so clearly are, dass teams so that without additional coordination work can.

scope

For Standardize CLI maintenance scripts first define the scope clearly: backup jobs, time windows, and retention.

Priorities

decisions about which data classes are protected and which RPO/RTO applies per area not implizit lassen, sondern roles and approvals explicitly benennen.

Exceptions

Allow exceptions only if they do not dilute the standard; especially relevant here are restore-szenarien and testdaten.

Evidence logic

Verifiable is the rule only, when backup reports and error messages and restore test logs cleanly verlinkt are.

What should be documented

Here only the spezifischen Inhalte about Standardize CLI maintenance scripts maintain; general documentation rules remain in the centraln guideline. Central guideline.

The page is good when a substitute can apply or review the standard without first collecting tribal knowledge.

scope & terms

terms, scope and boundaries about Standardize CLI maintenance scripts specify in concrete terms, including backup jobs, time windows, and retention.

Binding rules

Den standard so record, dass which data classes are protected and when restore-tests as bestanden apply eindeutig entschieden are.

Evidence & filing

Name and link evidence directly: backup reports and error messages, Restore-Testprotokolle, Retention-Konfiguration.

Exceptions & Historie

Aktive Exceptions, the latest change and the next review belong on the page—especially for topics with restore-szenarien and testdaten.

Common pitfalls

This section captures real-world pitfalls from Standardize CLI maintenance scripts; general guidance belongs in the central guideline. Central guideline.

  • scope driftet: Backup runs, Restore was but never tested.
  • the rule is too abstract: Retention fits not about Compliance-Anforderung.
  • evidence is missing: error messages remain without Ticket.
  • the exception gets out of control: Upgrade-Fenster without klare Abbruchkriterien.
Tip: It is better to document three concrete observations from real cases than to keep a long generic list.

Moodle reference (official docs 5.1)

Kurze Verweise on the offizielle Moodle documentation for Standardize CLI maintenance scripts. So remains this Page AFANDI-spezifisch and vermeidet doppelte Grundlagen.

Official references

Documentation focus

  • CLI-Skripte with Path, Benutzerkontext and Rollback-Hinweis document.
  • UI path, role and test case record explicitly (not only the desired target state).
  • Mark deviations from AFANDI standards separatelyely so that updates remain easier to review.
Note: Moodle interfaces, paths, and options can vary depending on the version, theme, and enabled plugins. Therefore always include the version, role, and test context on the page.

Review & maintenance

Check this Page gegen reale processes about Standardize CLI maintenance scripts – not only gegen the Wortlaut. Entscheidend is, ob standard, Exceptions and Evidence in the Alltag contribute.

  • Waren Backups in the definierten Fenster erfolgreich?
  • Were Restore-Tests with brauchbaren Daten geübt?
  • Passt Retention still to the need?
  • Were Vorabtests fully carried out?

Review focus for „Standardize CLI maintenance scripts“: Moodle-Operations; check especially backup jobs, time windows, and retention.

Useful metrics

A few metrics are enough – what matters is that they trigger decisions or improvements.

For „Standardize CLI maintenance scripts“ Kennzahlen directly an which data classes are protected and the most frequent Praxisrisiken koppeln.

Backup-Erfolgsrate

Anteil erfolgreicher Backup-Läufe

Interval: monthly

Restore-Test-Erfolg

Anteil bestandener Restore-Tests

Interval: quarterly

Backup-Fenster-Überschreitung

Läufe outside the plannedn Fensters

Interval: monthly

Next steps

Add jetzt the concrete Entscheidung about which data classes are protected incl. Verantwortlichen, Datum and Verweis on backup reports and error messages.

On „Standardize CLI maintenance scripts“ make especially clear as the next step: which backup jobs, time windows, and retention apply in the standard case and which exceptions are time-limited.