Uploaded image for project: 'OpenShift API for Data Protection'
  1. OpenShift API for Data Protection
  2. OADP-6504

[DOC] Improve linkage to other products

XMLWordPrintable

    • Quality / Stability / Reliability
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • ToDo
    • Very Likely
    • 0
    • Unset
    • Unknown
    • None

      Improve linkage for other product documentation

      Official Red Hat Product Documentation

      Integrating links to other specific Red Hat product documentation pages would provide users with essential context and prerequisites.

      •   *OpenShift Container Platform Documentation*:
            *   General OpenShift Container Platform documentation, and specifically for supported versions like 4.12, where OADP is discussed. This is crucial for understanding the underlying platform OADP operates on.
            *   Information on "About OpenShift Container Platform monitoring" and "Managing alerts as an Administrator" would be beneficial when discussing OADP's monitoring capabilities.
            *   Links to "Installing Operators on clusters for administrators" and "Installing Operators in namespaces for non-administrators" would provide essential guidance for OADP deployment methods.
            *   A link to "A Guide to OpenShift and UIDs" would help users understand potential UID range issues during cross-cluster restores.
      •   *OpenShift Data Foundation (ODF) Documentation*:
            *   The "official documentation" for installing ODF, as ODF is a prerequisite for certain OADP features like CSI snapshots and local S3 bucket creation with Multicloud Object Gateway (MCG).
            *   Specific documentation for "Accessing the Multicloud Object Gateway with your applications" for more details on MCG as a backup location.
            *   Guidance on "Changing the CPU and memory resources on the rook-ceph pods" could be linked when discussing ODF performance tuning for OADP.
      •   *Red Hat Customer Portal and Support Resources*:
            *   A prominent link to the "OpenShift APIs for Data Protection (OADP) FAQ" would be very helpful, as it's a dedicated resource for common questions, verified solutions, articles, and discussions.
            *   Links to the "Official OpenShift Operator Life Cycle Support Page" to clarify OADP's support status.
            *   General Red Hat guides on "Updating installed Operators" and "Using Operator Lifecycle Manager in disconnected environments" are essential for installation and maintenance.
            *   Direct links to the "OADP team’s troubleshooting documentation" for detailed debugging tips. This includes specific articles like "Restic restore partially failing on OCP 4.15 due to changed PSA policy", and guidance for "Fixing PodSecurity Admission warnings for deployments".
            *   Reference to a "Red Hat knowledge base article" for the "Azure Files CSI Driver and Restores" workaround.
            *   The "Red Hat Container Catalog" provides details on all containers shipped for OpenShift, including OADP's.
      •   *Red Hat OpenShift Service on AWS (ROSA) Documentation*: The existing documentation already points to a "Tutorial: Deploying OpenShift API for Data Protection on a ROSA cluster", which is a valuable direct link.
      •   *Azure Red Hat OpenShift (ARO) Documentation*: Similarly, a link to "Deploying OpenShift API for Data Protection on an ARO cluster" would be useful.
      •   *Red Hat Ecosystem Catalog*: A link to this catalog could be provided to help users find solutions from Red Hat's collaborative community of experts and technologies, including partner data protection backends.
      •   *Red Hat Blog*: Including links to "OADP blog posts" and specific posts like the one detailing "how OADP datamover works" provides additional insights and explanations.

      From survey - 

      Backup of the OADP/Velero Installation Itself or its Configuration in a Meta Way:

      If the BackupStorageLocation or Schedule CRs themselves were somehow lost and not version controlled elsewhere (e.g., GitOps), restoring the backup system's configuration from the backup itself presents a circular dependency. These configurations should ideally be managed via infrastructure-as-code practices.

      Some of these are things customers would like guidance on and OADP docs could help guide/crosslink some of these to other red hat products like ODF for storage level real time replication.

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: