Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh the Backup and Restore guide with accurate information and best practices #14537

Open
zmb3 opened this issue Jul 15, 2022 · 3 comments
Open
Labels
documentation robustness Resistance to crashes and reliability

Comments

@zmb3
Copy link
Collaborator

zmb3 commented Jul 15, 2022

This page asks readers to back up the /var/lib/teleport/storage directory, but there is no storage subdirectory.

It should say

back up the /var/lib/teleport storage directory

@espadolini
Copy link
Contributor

Backing up the directory while Teleport is running might lead to an inconsistent database state, so in addition to copying the files, we should probably also suggest sqlite-specific steps when appropriate, like sqlite3 /var/lib/teleport/proc/sqlite.db ".timeout 1000" ".backup proc.db" and sqlite3 /var/lib/teleport/backend/sqlite.db ".timeout 1000" ".backup backend.db".

@ptgott ptgott changed the title [v.10.0] /docs/pages/setup/operations/backup-restore.mdx Refresh the Backup and Restore guide with accurate information and best practices May 22, 2023
@ptgott ptgott added the robustness Resistance to crashes and reliability label Apr 10, 2024
@ptgott
Copy link
Contributor

ptgott commented Sep 3, 2024

When would a user want to copy /var/lib/teleport? This guide has received only small changes in the last few years, but now that we're encouraging either (a) Teleport Enterprise (Cloud) use or (b) large, highly available self-hosted Enterprise clusters, would it make sense to rework the backup and restore guidance to:

  1. Export audit logs and session recordings to a third-party platform
  2. Manage configuration resources with git and an IaC tool (including, if necessary, tctl manifests in a directory)
  3. Manage configuration files with git and whatever deployment tool you're using

The table of information to back up also recommends backing up certificate authorities—what would be the recommended way to do this?

@zmb3
Copy link
Collaborator Author

zmb3 commented Dec 31, 2024

This was partially addressed by #50155

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation robustness Resistance to crashes and reliability
Projects
None yet
Development

No branches or pull requests

3 participants