https://github.com/nhsdigital/az-backup

Terraform module to support teams in implementing an immutable backup vault in Azure.
https://github.com/nhsdigital/az-backup

Last synced: 9 months ago
JSON representation

Terraform module to support teams in implementing an immutable backup vault in Azure.

• Host: GitHub
• URL: https://github.com/nhsdigital/az-backup
• Owner: NHSDigital
• License: mit
• Created: 2024-08-09T08:40:26.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-21T22:19:04.000Z (10 months ago)
• Last Synced: 2025-03-26T08:37:31.868Z (10 months ago)
• Language: Go
• Homepage: https://nhsdigital.github.io/az-backup/
• Size: 1.36 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Security: docs/security-guide.md

Awesome Lists containing this project

README

          
# Azure Immutable Backup

![CI](https://github.com/nhsdigital/az-backup/actions/workflows/ci-pipeline.yaml/badge.svg)

## Introduction

This repository contains a terraform module that supports teams in implementing immutable backups in Azure. It's aim is to give developers a consistent way of creating, configuring and monitoring immutable backups using Azure Backup Vault.

The solution consists of a configurable Terraform module which deploys the following capabilities:

* Backup vault

* Backup policies

* Backup instances for the following resources:

    * Blob storage

    * Managed disks

    * PostgreSQL flexible server

* Integration of diagnostic settings with Azure Monitor

By default the module will create a dedicated resource group to house the vault, however you can overide this behaviour and use your own resource group managed externally to the module.

See the following key docs for more information:

* [Design](./docs/design.md)

* [Usage](./docs/usage.md)

* [Developer Guide](./docs/developer-guide.md)

* [Security Guide](./docs/security-guide.md)

* [Pipelines](./docs/pipelines.md)

## Repository Structure

The repository consists of the following directories:

* `./.github`

  

  Contains the GitHub workflows in `yaml` format.

  

  [See the YAML schema documentation for more details.](https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/?view=azure-pipelines)

* `./docs`

  Stores files and assets related to the documentation.

* `./infrastructure`

  Stores the infrastructure as code - a set of terraform scripts and modules.

  

  [See the Terraform AzureRM documentation for more details.](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs)

  [Also see the backup instance for blob storage as an example of the all the components that make up a blob storage backup.](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/data_protection_backup_instance_blob_storage)

* `./scripts`

  Contains scripts that are used to create and maintain the environment.

* `./tests`

  Contains the different types of tests used to verify the solution.

## Documentation

The documentation in markdown format resides in [`./docs`](./docs/index.md). It can also be built and served as a static site using [MkDocs](https://www.mkdocs.org/).

To build and run the docs locally, install Docker then run the following command from the root of the repository:

```pwsh

docker-compose -f ./docs/docker-compose.yml up

```

Once the container is running, navigate to [http://localhost:8000](http://localhost:8000).

## Releases

The project uses [Semantic Release](https://github.com/cycjimmy/semantic-release-action) to create and publish releases within the CI pipeline, which relies on [commit message conventions.](https://github.com/semantic-release/semantic-release/tree/master?tab=readme-ov-file#commit-message-format)

[See the following section of the documentation for more information](./docs/developer-guide.md#creating-a-release).

## Contributing

If you want to contribute to the project, raise a PR on GitHub.

We use pre-commit to run analysis and checks on the changes being committed. Take the following steps to ensure the pre-commit hook is installed and working:

1. Install git

    * Ensure the git `bin` directory has been added to %PATH%: `C:\Program Files\Git\bin`

1. Install Python

    * Ensure the python `bin` directory has been added to %PATH%

1. Install pre-commit

    * Open a terminal and navigate to the repository root directory

    * Install pre-commit with the following command: `pip install pre-commit`

    * Install pre-commit within the repository with the following command: `pre-commit install`

    * Run `pre-commit run --all-files` to check pre-commit is working

> For full details [see this link](https://pre-commit.com/#installation)