Skip to content

docs: Update chef-server-ctl restore documentation #3449

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-chef-io/content/server/ctl_chef_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ and then to restore those backups.
**Examples**

```bash
chef-server-ctl restore /path/to/tar/archive.tar.gz
chef-server-ctl restore /path/to/tar/archive.tgz
```

## cleanse
Expand Down
8 changes: 4 additions & 4 deletions docs-chef-io/content/server/server_backup_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ For the majority of use cases, `chef-server-ctl backup` is the recommended way t
#### Examples

```bash
chef-server-ctl restore /path/to/tar/archive.tar.gz
chef-server-ctl restore /path/to/tar/archive.tgz
```

## Backup and restore a Chef Backend install
Expand Down Expand Up @@ -87,13 +87,13 @@ Restoring Chef Backend for a Chef Infra Server cluster has two steps:
1. Restoring the back-end services creates a new cluster. Select one node as the leader and restore the backup on that node first. Use the IP address of the leader node as the value for the `--publish_address` option.

```bash
chef-backend-ctl restore --publish_address my.company.ip.address /path/to/backup.tar.gz
chef-backend-ctl restore --publish_address my.company.ip.address /path/to/backup.tgz
```

For example,

```bash
chef-backend-ctl restore --publish_address 198.52.1000.0 /backups/2021/backup.tar.gz
chef-backend-ctl restore --publish_address 198.52.1000.0 /backups/2021/backup.tgz
```

2. The restore process creates a new cluster and generates a JSON secrets file for setting up communication between the nodes. Locate the file in `/etc/chef-backend/chef-backend-secrets.json` and copy it to each node as `tmp/chef-backend-secrets.json`
Expand Down Expand Up @@ -131,7 +131,7 @@ The Chef Infra Server HA install documentation includes a [second process](https
1. Restore Chef Infra Server from your backed-up Infra Server configuration generated by the new cluster.

```bash
chef-server-ctl restore /path/to/chef-server-backup.tar.gz
chef-server-ctl restore /path/to/chef-server-backup.tgz
```

2. Copy the Chef generated config `/tmp/chef-server.rb`, to the front end node and replace it onto `/etc/opscode/chef-server.rb`.
Expand Down
2 changes: 1 addition & 1 deletion docs-chef-io/content/server/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ You are now finished with the upgrade.
1. Consult the [restore documentation]({{< relref "server_backup_restore" >}}) and restore the database from the path to where it was saved:

```bash
chef-server-ctl restore /path/to/tar/archive.tar.gz
chef-server-ctl restore /path/to/tar/archive.tgz
```

### External PostgreSQL
Expand Down