Document disabling of GC operations/maintenance queue #440

MrChrisW · 2018-09-24T01:13:16Z

Overview

The question of whether backup-utils stops maintenance/GC operations on GHE comes up frequently, often the easiest way to confirm this, is to look at the self-documenting code + comments:

backup-utils/share/github-backup-utils/ghe-backup-config

Lines 186 to 187 in 6136922

    
           # The location of the file used to disable GC operations on the remote side. 
        
           : ${SYNC_IN_PROGRESS_FILE:="$GHE_REMOTE_DATA_USER_DIR/repositories/.sync_in_progress"}

backup-utils/share/github-backup-utils/ghe-gc-disable

Lines 35 to 39 in 6136922

    
           # Touch the sync-in-progress file, disabling GC operations, and wait for all 
        
           # active GC processes to finish on the remote side. 
        
           echo " 
        
             set -e 
        
             sudo -u git touch '$SYNC_IN_PROGRESS_FILE'

Problem

Viewing the code to determine the application behaviour isn't efficient.

Solution

Document the fact maintenance/GC operations are paused when backup-utils is running. Preferably in the FAQ: https://github.com/github/backup-utils/blob/master/docs/faq.md

snh · 2018-09-24T02:47:23Z

Document the fact maintenance/GC operations are paused when backup-utils is running.

Just to clarify, we only pause these during the repositories stage of a backup and restore, and the storage stage of a backup, not the entire backup and restore process.

Specifically, the following scripts make use of ghe-gc-disable and ghe-gc-enable:

ghe-backup-storage
ghe-backup-repositories
ghe-restore-repositories-rsync
ghe-restore-repositories

lildude · 2018-09-24T09:31:05Z

Document the fact maintenance/GC operations are paused when backup-utils is running. Preferably in the FAQ: https://github.com/github/backup-utils/blob/master/docs/faq.md

👍 I'm in the process of adding a few other items to the FAQ and will add this.

MrChrisW · 2019-02-22T02:57:57Z

Friendly bump 🏗

MrChrisW added the documentation label Sep 24, 2018

lildude self-assigned this Sep 24, 2018

lildude removed their assignment Oct 19, 2020

github / backup-utils

Document disabling of GC operations/maintenance queue #440

Document disabling of GC operations/maintenance queue #440

MrChrisW commented Sep 24, 2018

snh commented Sep 24, 2018

lildude commented Sep 24, 2018

MrChrisW commented Feb 22, 2019

github / backup-utils

Join GitHub today

GitHub is where the world builds software

Document disabling of GC operations/maintenance queue #440

Document disabling of GC operations/maintenance queue #440

Comments

MrChrisW commented Sep 24, 2018

Overview

Problem

Solution

snh commented Sep 24, 2018

lildude commented Sep 24, 2018

MrChrisW commented Feb 22, 2019

Essential cookies

Always active

Analytics cookies