Skip to content

Commit

Permalink
microcluster: Update doc comment for RecoverFromQuorumLoss
Browse files Browse the repository at this point in the history
Signed-off-by: Wesley Hershberger <[email protected]>
  • Loading branch information
MggMuggins committed Jul 19, 2024
1 parent b684d55 commit 3c097e7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions microcluster/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -249,14 +249,12 @@ func (m *MicroCluster) GetDqliteClusterMembers() ([]cluster.DqliteMember, error)
// recovery operation.
//
// RecoverFromQuorumLoss should be invoked _exactly once_ for the entire cluster.
// This function creates a gz-compressed tarball
// path.Join(m.FileSystem.StateDir, "recovery_db.tar.gz"). This tarball should
// be manually copied by the user to the state dir of all other cluster members.
// This function creates a gz-compressed tarball and returns its path. This
// tarball should be manually copied by the user to the state dir of all other
// cluster members.
//
// On start, Microcluster will automatically check for & load the recovery
// tarball. A database backup will be taken before the load.
//
// RecoverFromQuorumLoss returns the path to the recovery tarball.
func (m *MicroCluster) RecoverFromQuorumLoss(members []cluster.DqliteMember) (string, error) {
// Double check to make sure the cluster configuration has actually changed
oldMembers, err := m.GetDqliteClusterMembers()
Expand Down

0 comments on commit 3c097e7

Please sign in to comment.