Helper Scripts

As part of our infrastructure repository (soon to be open source), we have a set of helper scripts to help with common tasks that have long or hard to remember commands.

The best place to get more detailed information on running these is from the --help flag on each of these, but this will serve as a quick reference to know which scripts are available.

Each script also offers tab completion for ease-of-use.

Deploy Helper (pc-deploy)

Deploys stacks for a given environment and docker compose. This is useful because it does the step of sourcing the .env file for the environment directory used and calling envsubstr on the compose file before deploying the stack.

# Deploy the catalog stack for the catalog-prod environment
pc-deploy catalog-prod catalog

# Do a dry-run of the traefik stack, which is a core-stack
pc-deploy core-stacks traefik -n

# Deploy the solr bootstrap compose file for the devel-test stack
pc-deploy devel-test solr-bootstrap
# or
pc-deploy devel-test docker-compose.solr-bootstrap.yml

OAI File Locator (pc-locate-oai)

Locates the OAI harvest file that contains the given FOLIO instance ID, which can be then used for importing a specific record into your stack (or re-importing it). Additionally, it has the option to extract the single record from an OAI file and put it in a temporary file. The script is available on the host machines as well as within the catalog, cron and build containers in the catalog stack.

# Locate the file that contains data for in01234 in catalog-prod's OAI files
# that have previously been imported to that environment
pc-locate-oai in01234
# or
pc-locate-oai in01234

# Give verbose output to show you the grep command being run
pc-locate-oai in01234 --debug

# Locate the file that contains data for in01234 in catalog-beta's OAI files
pc-locate-oai in01234 catalog-beta

# Locate the files that contain data for in00005342798 and in00001442723
# then extract the data for those specific records into a temp file
pc-locate-oai in00005342798,in00001442723 --extract

Record manipulation (pc-record)

Helper to manipulate records Currently available : - Delete : delete records from provided files and or inline ids. The script is available on the host machines as well as within the catalog, cron and build containers in the catalog stack.

# delete the record with id hlm.in01234 on catalog-beta
pc-record delete catalog-beta hlm.in01234

# delete records with ids in input file on devel-robby being verbose
pc-record delete devel-robby --input file_containing_ids.txt --debug

# show the command to delete the record with id in01234 (folio.in01234 with prefix) on catalog-beta being verbose 
pc-record delete catalog-beta in01234 --dry-run --vvv --prefix folio