FAQ | This is a LIVE service | Changelog

Commit 1e5983c3 authored by Wajdi Hajji's avatar Wajdi Hajji
Browse files

Update Research Dashboard documentation

parent e30bfc06
Pipeline #177963 passed with stage
in 37 seconds
......@@ -15,9 +15,6 @@ This service allows those involved in research administration to view:
The Research Dashboard is currently beta.
The Research Dashboard service is planned to be migrated to a more standard
[GCP Cloud Run deployment](https://gitlab.developers.cam.ac.uk/groups/uis/devops/research-dashboard/-/epics/13).
## Contact
Technical queries and support should be directed to [devops@uis.cam.ac.uk](mailto:devops@uis.cam.ac.uk) and will be picked up
......@@ -40,9 +37,9 @@ The GCP console pages for managing the infrastructure of each component of the d
| Name | Main Application Hosting | Database |
| ----------- | ------------------------ | -------- |
| Production | [Kubernetes Engine (Namespace: pidash-production)](https://console.cloud.google.com/kubernetes/clusters/details/europe-west2/cluster/details?project=uis-automation-pidash) | [GCP Cloud SQL (DB name: pidash-production)](https://console.cloud.google.com/sql/instances/db/overview?project=uis-automation-pidash) |
| Staging | [Kubernetes Engine (Namespace: pidash-test)](https://console.cloud.google.com/kubernetes/clusters/details/europe-west2/cluster/details?project=uis-automation-pidash) | [GCP Cloud SQL (DB name: pidash-test)](https://console.cloud.google.com/sql/instances/db/overview?project=uis-automation-pidash) |
| Production | [Cloud Run (Project: rd-prod-e68d2d52)](https://console.cloud.google.com/run?project=rd-prod-e68d2d52) | [GCP Cloud SQL (DB name: sql-bbb6ecf4)](https://console.cloud.google.com/sql/instances/sql-bbb6ecf4/overview?project=rd-prod-e68d2d52) |
| Staging | [Cloud Run (Project: rd-test-692a8e82)](https://console.cloud.google.com/run?project=rd-test-692a8e82) | [GCP Cloud SQL (DB name: sql-f64dd06d)](https://console.cloud.google.com/sql/instances/sql-f64dd06d/overview?project=rd-test-692a8e82) |
| Development | [Cloud Run (Project: rd-devel-2d49ecb5)](https://console.cloud.google.com/run?project=rd-devel-2d49ecb5) | [GCP Cloud SQL (DB name: sql-722570e9)](https://console.cloud.google.com/sql/instances/sql-722570e9/overview?project=rd-devel-2d49ecb5) |
## Source code
The source code for the Research Dashboard is spread over the following repositories:
......@@ -55,7 +52,6 @@ The source code for the Research Dashboard is spread over the following reposito
| [CUFS Salary Commitments Calculator](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/salaries-commitments) | The source code for a salaries commitments calculator for CUFS. |
| [Staff oncost calculator](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/ucamstaffoncosts) | The source code for a python module to calculate total staff oncosts. |
| [School Data Cache](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/school-data-cache) | The source code for caching of university school metadata. |
| [Infrastructure Deployment](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/deploy) | The Google Cloud Deployment Manager infrastructure code for deploying the application server to GCP |
## Technologies used
......@@ -74,7 +70,7 @@ The following gives an overview of how the Research Dashboard is deployed and ma
### How and where the Self-Service Gateway is deployed
Database for application data is a PostgreSQL database hosted by GCP Cloud SQL.
The main web application is a Django application, hosted by a GCP Kubernetes cluster.
The main web application is a Django application, hosted by GCP Cloud Run.
### Deploying a new release
......@@ -82,8 +78,9 @@ The README.md file in the Infrastructure Deployment repository explains how to d
### Monitoring
The application emails errors to `automation+pidash-production@uis.cam.ac.uk`. More detailed logs can be found on the
[GCP Console](https://console.cloud.google.com/logs/viewer?project=uis-automation-pidash).
Production Uptime and SSL check alerts are being sent to `devops-alarms@uis.cam.ac.uk`.
To see the Monitoring dashboard go to
[GCP Console](https://console.cloud.google.com/monitoring?project=rd-meta-494d1ba5).
### Debugging
......@@ -106,4 +103,4 @@ The **tech lead** for the Research Dashboard is [Mike Bamford](https://www.looku
The following engineers have operational experience with the Research Dashboard and are able to
respond to support requests or incidents:
* [Rich Wareham](https://www.lookup.cam.ac.uk/person/crsid/rjw57)
* [Wajdi Hajji](https://www.lookup.cam.ac.uk/person/crsid/wh330)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment