From 2f71267d1b2cffef61ef8de127dfac76f2bd9c2c Mon Sep 17 00:00:00 2001 From: Russ Poetker Date: Fri, 25 Sep 2026 09:23:55 -0400 Subject: [PATCH] Update docs for latest changes - Remove references to pass-docker invenio-rdm - Update ns queue name, it was wrong --- SUMMARY.md | 1 - .../notification-service/ns-configuration.md | 2 +- developer-documentation/pass-docker/README.md | 34 -------------- .../pass-docker/invenio-rdm.md | 47 ------------------- 4 files changed, 1 insertion(+), 83 deletions(-) delete mode 100644 developer-documentation/pass-docker/invenio-rdm.md diff --git a/SUMMARY.md b/SUMMARY.md index d53d951..3e947ea 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -62,7 +62,6 @@ * [Next Steps / Institution Configuration](developer-documentation/notification-service/ns-new-institution.md) * [PASS Acceptance Testing](developer-documentation/pass-acceptance-testing/README.md) * [PASS Docker](developer-documentation/pass-docker/README.md) - * [Testing InvenioRDM](developer-documentation/pass-docker/invenio-rdm.md) * [Release](developer-documentation/release/README.md) * [Release Projects One At a Time](developer-documentation/release/release-steps-project-one-at-a-time.md) * [Manual Release](developer-documentation/release/release-steps-manual.md) diff --git a/developer-documentation/notification-service/ns-configuration.md b/developer-documentation/notification-service/ns-configuration.md index bc89253..778b0ea 100644 --- a/developer-documentation/notification-service/ns-configuration.md +++ b/developer-documentation/notification-service/ns-configuration.md @@ -170,7 +170,7 @@ address (for the `PRODUCTION` mode), then no notification will be dispatched. Supported environment variables (system property analogs) and default values are: -* `PASS_NOTIFICATION_QUEUE_EVENT_NAME` (`pass.notification.queue.event.name`): `event` +* `PASS_JMS_QUEUE_SUBMISSION_EVENT_NAME` (`pass.notification.queue.event.name`): `event` * `PASS_NOTIFICATION_MODE` (`pass.notification.mode`): `DEMO` * `PASS_CORE_URL` (`pass.client.url`): `{PASS_CORE_URL}` * `PASS_CORE_USER` (`pass.client.user`): `{PASS_CORE_USER}` diff --git a/developer-documentation/pass-docker/README.md b/developer-documentation/pass-docker/README.md index 870305d..2cbd1a6 100644 --- a/developer-documentation/pass-docker/README.md +++ b/developer-documentation/pass-docker/README.md @@ -36,36 +36,6 @@ Run the following to load sample data into dspace: docker compose -p pass-docker -f docker-compose.yml -f eclipse-pass.local.yml -f docker-compose-deposit.yml -f dspace-cli.yml -f dspace-cli.ingest.yml run --rm dspace-cli ``` -#### Run With Deposit Services and InvenioRDM -In order to run a local instance **_with_** deposit-service, SFTP, InvenioRDM, you can run the following command: - -Refer to [PASS Docker Testing InvenioRDM](./invenio-rdm.md) for instructions managing a local test InvenioRDM instance that will communicate with `pass-docker`. - -**Note this configuration for deposit services and InvenioRDM is for local testing only and is not intended for production.** - -First, start the local test InvenioRDM and add the `Access token` to the appropriate `env` file by following the steps highlighted in [PASS Docker Testing InvenioRDM](./invenio-rdm.md). - -After the InvenioRDM service is up and running, run the following commands in the `pass-docker` directory: - -```console -docker compose -p pass-docker -f docker-compose.yml -f eclipse-pass.local.yml -f docker-compose-deposit.yml -f docker-compose-deposit-invenio-rdm.yml up -d --no-build --quiet-pull --pull always -``` - -#### InvenioRDM Submission Requirements - -When creating a Submission in PASS that will deposit into InvenioRDM with this local test configuration, there are a -few requirements for Submission input: - -* Open a browser and go to [http://localhost:8080/app/](http://localhost:8080/app/) -* Login using the staff1 user -* Create a new submission -* On the Grants step, select the `invenio-test-awd-num-1` grant -* On the Details step: - * Enter a Publisher - * Enter Publication Date (format: yyyy-mm-dd) - * Enter Author in format , - - ### Stopping a Local Instance In order to stop a local instance, you can run the following command: ``` @@ -172,7 +142,3 @@ Once you have the repository cloned, wait for the Docker Compose environment to yarn # Installs project dependencies yarn run test # Runs tests ``` - - -## Related Documentation: -* [PASS Docker Testing InvenioRDM](./invenio-rdm.md) diff --git a/developer-documentation/pass-docker/invenio-rdm.md b/developer-documentation/pass-docker/invenio-rdm.md deleted file mode 100644 index 2df9b09..0000000 --- a/developer-documentation/pass-docker/invenio-rdm.md +++ /dev/null @@ -1,47 +0,0 @@ -# PASS Docker Testing InvenioRDM - -An InvenioRDM instance that can be run locally for testing [`pass-docker`](./README.md). **Note**: This is intended for testing a local instance of `pass-docker` and is not meant for Production use. - -The `pass-docker-invenio-rdm` directory was created following these instructions: [InvenioRDM Installation](https://inveniordm.docs.cern.ch/install/) - - -## Technologies Utilized -* Python v3.8 or greater installed. -* The `invenio-cli` python tool installed and available in your PATH: [InvenioRDM CLI Installation](https://inveniordm.docs.cern.ch/install/cli/) - - -### Running the InvenioRDM Instance - -Run the following commands in order to start the InvenioRDM instance: - -```console -./build.sh -./start.sh -``` - -The above commands starts by building the application docker image, once the docker image has been built the commands will start the application and its related services (database, Elasticsearch, Redis and RabbitMQ). The build and boot process will take time to complete. The first time the commands run the docker images will need to be downloaded, the inital downloading of docker images will result in the commands taking longer to complete. - - -### Accessing the InvenioRDM Instance - -* Visit [https://127.0.0.1/](https://127.0.0.1/) in your browser -* Login using the credentials for the admin user in `invenio-rdm/pass-docker-invenio-rdm/app_data/users.yaml` -* Click on the `user menu button` located in the top right corner -* Click on `Applications` -* Click `New token` in the Personal access tokens -* Enter a Name and click `Create` -* Copy the Access token that was created -* Paste the token value in the `pass-docker/invenio-rdm/pass-docker-invenio-rdm/.eclipse-pass.invenio.local_env` as the -value for the `INVENIORDM_API_TOKEN` property - -**Note**: The server is using a self-signed SSL certificate, so your browser -will issue a warning that you will have to by-pass. - - -### Stopping the InvenioRDM Instance - -To stop the InvenioRDM instance, run the following commands: - -```console -./stop.sh -```