48 lines
4.1 KiB
Markdown
48 lines
4.1 KiB
Markdown
---
|
|
title: Disaster recovery for GitHub Codespaces
|
|
intro: 'This article describes guidance for a disaster recovery scenario, when a whole region experiences an outage due to major natural disaster or widespread service interruption.'
|
|
versions:
|
|
fpt: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- Codespaces
|
|
shortTitle: Disaster recovery
|
|
redirect_from:
|
|
- /codespaces/codespaces-reference/disaster-recovery-for-codespaces
|
|
- /codespaces/codespaces-reference/disaster-recovery-for-github-codespaces
|
|
---
|
|
|
|
We work hard to make sure that {% data variables.product.prodname_github_codespaces %} is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions.
|
|
|
|
Although disaster recovery scenarios are rare occurrences, we recommend that you prepare for the possibility that there is an outage of an entire region. If an entire region experiences a service disruption, the locally redundant copies of your data would be temporarily unavailable.
|
|
|
|
The following guidance provides options on how to handle service disruption to the entire region where your codespace is deployed.
|
|
|
|
> [!NOTE]
|
|
> You can reduce the potential impact of service-wide outages by pushing to remote repositories frequently.
|
|
|
|
## Option 1: Create a new codespace in another region
|
|
|
|
In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see [AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces).
|
|
|
|
You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
|
|
|
## Option 2: Wait for recovery
|
|
|
|
In this case, no action on your part is required. Know that we are working diligently to restore service availability.
|
|
|
|
You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/).
|
|
|
|
## Option 3: Clone the repository locally or edit in the browser
|
|
|
|
While {% data variables.product.prodname_github_codespaces %} provides the benefit of a pre-configured developer environment, your source code should always be accessible through the repository hosted on {% data variables.product.github %}. In the event of a {% data variables.product.prodname_github_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-files/editing-files).
|
|
|
|
While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve.
|
|
|
|
## Option 4: Use the Dev Containers extension and Docker for a local containerized environment
|
|
|
|
If your repository has a `devcontainer.json`, consider using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in the {% data variables.product.prodname_vscode_shortname %} documentation.
|
|
|
|
> [!NOTE]
|
|
> Be sure your local setup meets the [minimum requirements](https://code.visualstudio.com/docs/remote/containers#_system-requirements) before attempting this option.
|