From f5f51bbfe881a12bea2f0ff891d2c34d16aa0b1b Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 09:44:33 +0100 Subject: [PATCH 1/6] adding configuration_oidc docs to for frontend and backend --- SUMMARY.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SUMMARY.md b/SUMMARY.md index ec939569..82877dcf 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -59,6 +59,8 @@ - [Theming](Development/v4.x/Theming.md) - [Login and Accounts](Development/v4.x/Login.md) - [OIDC Integration](Development/v4.x/OIDC.md) + - [Frontend](Development/v4.x/configuration_oidc.md) + - [Backend](Development/v4.x/backend/configuration_oidc.md) - [Testing](Development/v4.x/testing.md) - [Backend](Development/v4.x/backend/testing_backend.md) - [Instrument](Development/v4.x/backend/testing/instrument.md) From ea7ab56a6dcd99f068e6675926ca46f8ebee390d Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 14:28:49 +0100 Subject: [PATCH 2/6] adding missing content from --- Development/v4.x/backend/development_and_release_cycle.md | 0 Development/v4.x/backend/getting_started.md | 0 SUMMARY.md | 3 +++ 3 files changed, 3 insertions(+) delete mode 100644 Development/v4.x/backend/development_and_release_cycle.md delete mode 100644 Development/v4.x/backend/getting_started.md diff --git a/Development/v4.x/backend/development_and_release_cycle.md b/Development/v4.x/backend/development_and_release_cycle.md deleted file mode 100644 index e69de29b..00000000 diff --git a/Development/v4.x/backend/getting_started.md b/Development/v4.x/backend/getting_started.md deleted file mode 100644 index e69de29b..00000000 diff --git a/SUMMARY.md b/SUMMARY.md index 82877dcf..55265160 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -65,6 +65,9 @@ - [Backend](Development/v4.x/backend/testing_backend.md) - [Instrument](Development/v4.x/backend/testing/instrument.md) - [User Authorization](Development/v4.x/backend/testing/user_authorization.md) + - [Dataset Authorizatoin](Development/v4.x/backend/testing/dataset_authorization.md) + - [Dataset Types](Development/v4.x/backend/testing/dataset_types.md) + - [Sample Authorization](Development/v4.x/backend/testing/sample_authorization.md) - [Frontend](Development/v4.x/frontend/testing.md) - [Migration v3.x to v4.x](Development/v4.x/Migration.md) - [Documentation](Development/Documentation.md) From 702f99056fa9dbed5a865937ab5e2412f1064ab7 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 14:30:42 +0100 Subject: [PATCH 3/6] remove empty page on swagger interface --- Development/v4.x/backend/swagger_interface.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Development/v4.x/backend/swagger_interface.md diff --git a/Development/v4.x/backend/swagger_interface.md b/Development/v4.x/backend/swagger_interface.md deleted file mode 100644 index e69de29b..00000000 From 80dc510ceb7ed1bf36c60b4708b574616fbe5a73 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 14:39:25 +0100 Subject: [PATCH 4/6] adding backend overview - was unsure where to put it but can stay here before the restructure --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 55265160..2af4fe5f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -39,6 +39,7 @@ - [Git Flow Workflow](Development/v3.x/Development_Methods.md) - [v4.x](Development/v4.x/README.md) - [Overview](Development/v4.x/overview.md) + - [Backend Overview](Development/v4.x/backend_overview.md) - [Contributing](Development/v4.x/contributing.md) - [Developer Guide](Development/v4.x/developers_guide.md) - [An Introduction to the Data Model](Development/v4.x/Data_Model.md) From c20fd7dc3b889cd9ae9636197e1f98a854ff1bb6 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 14:46:25 +0100 Subject: [PATCH 5/6] adding the v3 documentation, I think this can be merged with the Development/Documentation.md in future, but this could be a new issue --- Development/v4.x/backend/swagger_interface.md | 0 SUMMARY.md | 1 + 2 files changed, 1 insertion(+) create mode 100644 Development/v4.x/backend/swagger_interface.md diff --git a/Development/v4.x/backend/swagger_interface.md b/Development/v4.x/backend/swagger_interface.md new file mode 100644 index 00000000..e69de29b diff --git a/SUMMARY.md b/SUMMARY.md index 2af4fe5f..bea6cd1f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -37,6 +37,7 @@ - [Testing Frontend](Development/v3.x/Testing.md) - [Contributing](Development/v3.x/Contributing.md) - [Git Flow Workflow](Development/v3.x/Development_Methods.md) + - [Documentation](Development/v3.x/Documentation.md) - [v4.x](Development/v4.x/README.md) - [Overview](Development/v4.x/overview.md) - [Backend Overview](Development/v4.x/backend_overview.md) From 03feb6c95b13bd052758fa976afff26e44be314f Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Fri, 4 Jul 2025 14:48:00 +0100 Subject: [PATCH 6/6] removing site specific documentation from the core SciCat Project, these can be adopted into a site's internal documentation. SciCat has been made more configurable which means that we no longer have to commit site specific things into core --- Operator/Sites/ESS.md | 4 ---- Operator/Sites/MaxIV.md | 3 --- Operator/Sites/PSI.md | 50 ---------------------------------------- Operator/Sites/README.md | 14 ----------- 4 files changed, 71 deletions(-) delete mode 100644 Operator/Sites/ESS.md delete mode 100644 Operator/Sites/MaxIV.md delete mode 100644 Operator/Sites/PSI.md delete mode 100644 Operator/Sites/README.md diff --git a/Operator/Sites/ESS.md b/Operator/Sites/ESS.md deleted file mode 100644 index ce6bc75f..00000000 --- a/Operator/Sites/ESS.md +++ /dev/null @@ -1,4 +0,0 @@ -# European Spallation Source Site Specific info - -TODO ESS site specific info - diff --git a/Operator/Sites/MaxIV.md b/Operator/Sites/MaxIV.md deleted file mode 100644 index 497b7f89..00000000 --- a/Operator/Sites/MaxIV.md +++ /dev/null @@ -1,3 +0,0 @@ -# MAX IV Site specific info - - TODO MAX IV Site specific info diff --git a/Operator/Sites/PSI.md b/Operator/Sites/PSI.md deleted file mode 100644 index e9327519..00000000 --- a/Operator/Sites/PSI.md +++ /dev/null @@ -1,50 +0,0 @@ -# PSI URLs - -These are the urls in use at PSI for all of the services. Currently \(8th March 2018\), the Node-RED deployments cannot be accessed using their URLs and a workaround for accessing them can be seen in the Node-RED section. - -## Environments: - -* development -* qa -* production - -## Services - -* discovery.psi.ch - Web Frontend -* dacat.psi.ch - API Server -* aries.psi.ch - Node-RED ingestor \(note that the ending slash is needed for correct loading\) - * /jobs/ - Jobs ingestor - * /<BEAMLINE>/ - beamline name -* hal.psi.ch - RabbitMQ - -## Node-RED - -Nginx is unable to locate the Node-RED instances currently, so the `aries.psi.ch` is not working. You will need `kubectl` installed in your system \(and available in your path\). - -1. `kubectl get pods -n ` -2. `kubectl port-forward 8001:1880` -3. `Navigate to localhost:8001` -4. Login with admin credentials \(can be found in the `secrets` section of the Kubernetes Web dashboard. - -The following is an example screenshot of the job-assembler Node-RED process - -![Job-Assembler at PSI](img/job-assembler.png) - -# Archiving/Retrieving/Resetting Datasets - -Actions performed on Datasets in the GUI are executed as a `job`, they are then handled by the queuing system you have. - -At PSI RabbitMQ is used as a queue. Jobs go to the queue and are passed onto the archiving system which is AREMA based at PSI. At this time the archive system is not publicly availble -and so it would be necessary to implement your own. - -## Archive -Send a job to initiate a transfer of data from local disk to tape. Local data can be deleted upon completion but this should be done by the data owner. - - -## Retrieve -Copy data from tape to a staging area on disk where users can execute an rsync to copy the data to a desired location. - - -## Reset -Remove the data from the tape facility. - diff --git a/Operator/Sites/README.md b/Operator/Sites/README.md deleted file mode 100644 index 1d6a6f75..00000000 --- a/Operator/Sites/README.md +++ /dev/null @@ -1,14 +0,0 @@ -## Sites - -Currently, there are three known sites actively using the SciCat project. If you are also using the product, please feel free to submit a pull request to add your site here: - -1. Paul Scherrer Institute \(PSI\) -2. European Spallation Source \(ESS\) -3. MaxIV - -Inside these folders, there may be site specific information that is relevant to a SciCat installation or just for general usage. An example of this could be your build pipeline, specifics for testing or deployment and/or administrative guidelines. - - - - -