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.

Sign up for GitHub

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

adds documentation for importing data into docker #1703

Merged
merged 1 commit into from
Dec 14, 2023
Merged

adds documentation for importing data into docker #1703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 43 additions & 5 deletions docs/backup-and-restore-database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,22 @@ a plugin, run this command:
cf uninstall-plugin <plugin name>
```

Then follow the installation instructions found in the plugin's documentation.
Then follow the installation instructions found in the plugin's documentation. Once installed, you may log in and select your org and space:

## Step 1: Exporting data
```bash
cf login -a api.fr.cloud.gov --sso
```

## Exporting data from cloud.gov

```bash
# Target the environment you're exporting from
# If you have not already targeted the environment for export or wish to change
cf target [-o <org name>] -s <space name>

# List the available apps services for this space. Make note of the tock app name and the database service name
cf apps
cf services

# Check to see if a SERVICE_CONNECT service key already exists
cf service-keys <service name>

Expand All @@ -31,7 +39,7 @@ cf delete-service-key <service name> SERVICE_CONNECT
# note the credentials and connection info given in the output
cf connect-to-service -no-client <app name> <service name>

# Back in the original window, dump the database
# Back in the original window, dump the database. This may take several minutes.
pg_dump -F c --no-acl --no-owner -f <file name> postgres://<username>:<password>@<host>:<port>/<name>

# In the window with the SSH Tunnel, close the SSH tunnel
Expand All @@ -43,7 +51,7 @@ cf delete-service-key <service name> SERVICE_CONNECT

Tock retains daily backups for 14 days; for details, see the [cloud.gov backup documentation](https://cloud.gov/docs/services/relational-database/#backups). (Please note that if you are planning contingency tests, the cloud.gov support team prefers at least 48 hours of advance notice.)

## Step 2: Importing data
## Importing data into cloud.gov

```bash
# Target the environment you're restoring into
Expand Down Expand Up @@ -88,3 +96,33 @@ cf delete-service-key <service name> SERVICE_CONNECT
# Restage the app associated with the service
cf restage <app name>
```

## Importing data into docker locally

These instructions assume that you already have Docker installed and are set up for [local development](local-development.md).

```bash
# Make sure the Tock app is running locally
docker-compose up
```

From the Docker dashboard application, find the tock database container and open up the terminal.

```bash
# Connect to the database
psql -U tock_user -d tock

# from inside the psql terminal, drop the public schema to get rid of testing data
DROP SCHEMA public CASCADE;

# recreate the public schema
CREATE SCHEMA public;
```

From a regular (non-Docker) terminal window, import the database. This may take several minutes.

```bash
docker exec -i tock-db-1 pg_restore -U tock_user -v -d tock < <file name>
```

Once the import is done, log in with admin.user@gsa.gov or any user's email which appears in the newly imported data.