Goal

Implement a feature that allows Quay to toggle between read-only and writable states through a hot-reload mechanism. This capability will enable Quay operators to declaratively set the registry into a read-only mode.

The Why

The current process for enabling read-only mode in Quay is complex and error-prone, requiring multiple steps such as generating a key, inserting it into the database, and modifying the quay config.yaml. This complexity can lead to human errors and complicates backup routines for customers who need to ensure data consistency during backups. By simplifying this process to a single toggle managed in the app-interface, we will:

• Eliminate the need for Quay-specific knowledge and manual database operations.
• Facilitate effective backup routines by allowing users to easily switch to read-only mode when needed.
• Reduce the risk of unintended modifications during maintenance.

Scenarios

1. Hot Reload Capability: Users can set Quay to read-only mode without restarting the instance or updating existing configurations.
2. Completion of Writes: All write operations must be finalized before transitioning to read-only mode.
3. Trigger Mechanism: The read-only state can be activated via the Quay operator.

Acceptance Criteria

• Continuous Integration (CI): Must be running successfully with automated tests.
• Release Technical Enablement: Provide necessary release enablement details and documentation.
• Documentation: Update documentation and release notes to reflect this new feature.

This feature aims to enhance the usability and reliability of Quay, making it easier for administrators to manage their container registries while minimizing risks associated with configuration errors.