Skip to content

solidify/azure-devops-backup-tool-docs

Repository files navigation

Azure DevOps Backup Tool Documentation

Welcome to the Azure DevOps Backup Tool Documentation repository. This repository contains all the necessary resources and guides for using the Azure DevOps Backup Tool to backup and restore your Azure DevOps organization or project.

Overview

Documents

  • backup.md
    • A beginner-friendly guide for backing up your Azure DevOps (ADO) organization or project for the first time.
  • restore.md
    • Detailed procedure for restoring your Azure DevOps organization or project using Azure DevOps Pipelines.
  • custom-configs.md
    • A guide on how to use custom configuration files in order to extend the functioality of Azure DevOps Backup Tool on a per-component basis.
  • order-of-adapter-dependencies.md
    • A graph showing which components must be restored togheter when restoring a subset of all components.

Folders

  • adapter-docs

    • Contains documentation on using the CLI to backup and restore individual components.
    • Includes detailed guides on creating and using custom configuration files for your backup and restore processes.
    • Includes sample configuration files for each component.
  • config-templates

    • Template custom configuration files for each component.
    • Use these templates as a reference or starting point for creating your own custom configuration files.

Getting Started

To begin using the Azure DevOps Backup Tool, refer to the appropriate documentation based on your needs:

  1. For a beginner-friendly guide on getting started and setting up your first backup job, read backup.md. Most new customers should start here.
  2. For backing up and restoring individual components or understanding CLI commands, see the adapter-docs folder.
  3. To view or use sample custom configuration files, read through custom-configs.md and check the config-samples folder.
  4. For a comprehensive guide on restoring your Azure DevOps organization or project, read the restore.md document.