Uploaded image for project: 'OpenShift Etcd'
  1. OpenShift Etcd
  2. ETCD-609

Automated Backups with No Config Tech Preview

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Major Major
    • 4.18
    • None
    • None
    • Automated Backups with No Config Tech Preview
    • BU Product Work
    • False
    • None
    • False
    • Not Selected
    • To Do
    • OCPSTRAT-1411 - [Tech Preview] automatic backup with etcd BackupAPI (no config)
    • OCPSTRAT-1411[Tech Preview] automatic backup with etcd BackupAPI (no config)
    • 33% To Do, 27% In Progress, 40% Done

      Epic Goal*

      Provide automated backups of etcd saved locally on the cluster on Day 1 with no additional config from the user.

       
      Why is this important? (mandatory)

      The current etcd automated backups feature requires some configuration on the user's part to save backups to a user specified PersistentVolume.
      See: https://github.com/openshift/api/blob/ba11c1587003dc84cb014fd8db3fa597a3faaa63/config/v1alpha1/types_backup.go#L46

      Before the feature can be shipped as GA, we would require the capability to save backups automatically by default without any configuration. This would help all customers have an improved disaster recovery experience by always having a somewhat recent backup. 

       
      Scenarios (mandatory) 

      • After a cluster is installed the etcd-operator should take etcd backups and save them to local storage.
      • The backups must be pruned according to a "reasonable" default retention policy so it doesn't exhaust local storage.
      • A warning alert must be generated upon failure to take backups.

      Implementation details:
      One issue we need to figure out during the design of this feature is how the current API might change as it is inherently tied to the configuration of the PVC name.
      See:
      https://github.com/openshift/api/blob/ba11c1587003dc84cb014fd8db3fa597a3faaa63/config/v1alpha1/types_backup.go#L99
      and 
      https://github.com/openshift/api/blob/ba11c1587003dc84cb014fd8db3fa597a3faaa63/operator/v1alpha1/types_etcdbackup.go#L44

      Additionally we would need to figure out how the etcd-operator knows about the available space on local storage of the host so it can prune and spread backups accordingly.
       

      Dependencies (internal and external) (mandatory)

      Depends on changes to the etcd-operator and the tech preview APIs 

      Contributing Teams(and contacts) (mandatory) 

      Our expectation is that teams would modify the list below to fit the epic. Some epics may not need all the default groups but what is included here should accurately reflect who will be involved in delivering the epic.

      • Development - etcd team
      • Documentation - etcd docs team
      • QE - Sandeep Kundu
      • PX - 
      • Others -

      Acceptance Criteria (optional)

      Upon installing a tech-preview cluster backups must be saved locally and their status and path must be visible to the user e.g on the operator.openshift.io/v1 Etcd cluster object.

      An e2e test to verify that the backups are being saved locally with some default retention policy.

      Drawbacks or Risk (optional)

      Reasons we should consider NOT doing this such as: limited audience for the feature, feature will be superseded by other work that is planned, resulting feature will introduce substantial administrative complexity or user confusion, etc.

      Done - Checklist (mandatory)

      The following points apply to all epics and are what the OpenShift team believes are the minimum set of criteria that epics should meet for us to consider them potentially shippable. We request that epic owners modify this list to reflect the work to be completed in order to produce something that is potentially shippable.

      • CI Testing -  Basic e2e automationTests are merged and completing successfully
      • Documentation - Content development is complete.
      • QE - Test scenarios are written and executed successfully.
      • Technical Enablement - Slides are complete (if requested by PLM)
      • Engineering Stories Merged
      • All associated work items with the Epic are closed
      • Epic status should be “Release Pending” 

            melbeher@redhat.com Mustafa Elbehery
            rhn-coreos-htariq Haseeb Tariq
            Sandeep Kundu Sandeep Kundu
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: