templates / Deployment template
DocsTemplatesDeployment template

Deployment template

Describe how to ship and how to undo it. State the environment each step runs in. Delete every template comment before committing.

1 min readTemplates
markdown
---
title: {{title}}
description: {{description}}
type: deployment
since: {{since}}
---

<!-- template: describe how to ship and how to undo it. State the environment each step runs in. Delete every template comment before committing. -->

## Overview

What is deployed, where, and how often.

## Environments

| Environment | Purpose | URL |
| --- | --- | --- |
| Production | Live traffic | `https://<domain>` |

## Prerequisites

- <access, tools, credentials the deployer needs>

## Deploy

1. <Step one>
2. <Step two>

```bash
<command>
```

## Configuration

| Variable | Required | Description |
| --- | --- | --- |
| `<NAME>` | yes | <purpose> |

## Verify

How to confirm the deployment is healthy.

## Roll back

Exact steps to return to the previous version.

## Logs and monitoring

Where to look when something is wrong.