Skip to content

Commit

Permalink
Update docs (#1130)
Browse files Browse the repository at this point in the history
  • Loading branch information
StepanBrychta committed Jul 1, 2024
1 parent c30eb5d commit 6b73588
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion monitoring/ingest_inspector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,14 @@ The app has a number of features designed to make it as easy as possible for som

You can use the app by visiting <https://d1dti1kbjcy26.cloudfront.net>.


## Development
### Backend

The backend consists of a single Lambda function, which fetches ingests from the Wellcome Storage Service. To run the Lambda function code locally, navigate into the `ingest_inspector/backend_lambda` directory and run:

```shell
AWS_PROFILE=storage-developer python3 src/ingest_inspector_backend.py --ingest-id=<INGEST_ID>
```

### Frontend

Expand All @@ -149,9 +154,16 @@ npm run dev

### Deployments

To upload a new version of the backend Lambda function into S3, run:

```shell
AWS_PROFILE=storage-developer python3 ./builds/publish_lambda_zip.py monitoring/ingest_inspector/backend_lambda --bucket=wellcomecollection-storage-infra --key=lambdas/monitoring/ingest_inspector_backend.zip
```

The frontend is hosted as a static website on S3 and served via CloudFront. To build and deploy the app, navigate into
the `ingest_inspector/frontend` directory and run:

```shell
sh deploy.sh
```

Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def lambda_handler(event, context):

if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Index EBSCO item fields into the Elasticsearch reporting cluster."
description="Retrieve a single ingest from the Wellcome Storage Service by its ID."
)
parser.add_argument(
"--ingest-id",
Expand Down

0 comments on commit 6b73588

Please sign in to comment.