Uploaded image for project: 'Red Hat OpenStack Services on OpenShift'
  1. Red Hat OpenStack Services on OpenShift
  2. OSPRH-17397

As a Developer, I want to create comprehensive documentation for the pause reconciliation feature, so that administrators understand its risks and how to use it correctly.

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • documentation
    • None
    • Document Pause/Resume Feature
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • Proposed
    • Proposed
    • To Do
    • RHOSSTRAT-800 - Provide service Operator reconciliation control
    • Proposed
    • Proposed

      User Story: As a Developer, I want to create comprehensive documentation for the pause reconciliation feature, so that administrators understand its risks and how to use it correctly.

      Goal: To create clear documentation that warns administrators about the significant risks of pausing reconciliation. The documentation must explain the intended use cases and provide a precise operational workflow. This ensures administrators use the feature correctly and are fully aware of its impact on the environment's stability.

      Acceptance Criteria:

      • The documentation must lead with a strong warning about the risks and why the feature should only be used when absolutely necessary.
      • It must explicitly state that self-healing is disabled while paused, meaning the Operator will not fix or recreate failed or deleted resources.
      • The documentation must clarify that service updates will still cause service interruptions when resumed; this feature only controls when that interruption occurs.
      • A clear, step-by-step operational workflow is provided: 1. Pause reconciliation. 2. Perform actions (e.g., Operator upgrade). 3. Resume reconciliation.
      • A YAML code snippet is included to show exactly how to set the reconciliationPaused field to true and false.
      • Instructions are provided on how an administrator can verify the paused state by checking the Operator's status.

      Open Questions:

      • Should this be included in the OpenStack documentation as a new module, or should it be created as a linked Knowledge Base Article?

              igallagh@redhat.com Irina Gallagher
              lmadsen@redhat.com Leif Madsen
              rhos-conplat-core-operators
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: