FAQ | This is a LIVE service | Changelog

Commit 2ea8b432 authored by Monty Dawson's avatar Monty Dawson
Browse files

Merge branch '75-update-pidash-service-page' into 'master'

Resolve "Document Research Dashboard"

Closes #75

See merge request !83
parents 1045a9c4 fd7568d9
Pipeline #92686 passed with stage
in 41 seconds
# Research Dashboard
This page documents key information about the Research Dashboard service.
This page gives an overview of the Research Dashboard, describing its current status, where and
how it's developed and deployed, and who is responsible for maintaining it.
Environments and Servers they run on
------------------------------------
- [Production](https://researchdashboard.admin.cam.ac.uk)
- [GCP Kubernetes Cluster](https://console.cloud.google.com/kubernetes/list?project=uis-automation-pidash)
- [Test](https://test.researchdashboard.admin.cam.ac.uk)
- [GCP Kubernetes Cluster (same as production)](https://console.cloud.google.com/kubernetes/list?project=uis-automation-pidash)
## Service Description
Application repositories
------------------------
- [Web Application](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/webapp)
- [CUFS GMS Microservice](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/datamart-api)
- [CHRIS Grant Contracts Microservice](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/chris-salaries-api)
- [CUFS Salary Commitments Calculator](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/salaries-commitments)
This service allows those involved in research administration to view:
Technology
----------
- Grant finances (summary expenditure, grant balances and team details)
- Application deadlines
- Contract status and progress updates
## Service Status
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
by a member of the team working on the service. To ensure that you receive a response, always
direct requests to [devops@uis.cam.ac.uk](mailto:devops@uis.cam.ac.uk) rather than reaching out to team members directly.
Issues discovered in the service or new feature requests should be opened as
[GitLab issues in the application repository](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/webapp/-/issues).
## Environments
The Self-Service Gateway is currently deployed to the following environments:
| Name | Main Application URL | Django Admin URL | Backend API URL |
| ----------- | -------------------- | ---------------- | --------------- |
| Production | [https://researchdashboard.admin.cam.ac.uk/](https://researchdashboard.admin.cam.ac.uk/) | [https://researchdashboard.admin.cam.ac.uk/admin](https://researchdashboard.admin.cam.ac.uk/admin) | [https://researchdashboard.admin.cam.ac.uk/api/](https://researchdashboard.admin.cam.ac.uk/api/) |
| Staging | [https://test.researchdashboard.admin.cam.ac.uk/](https://test.researchdashboard.admin.cam.ac.uk/) | [https://test.researchdashboard.admin.cam.ac.uk/admin](https://test.researchdashboard.admin.cam.ac.uk/admin) | [https://test.researchdashboard.admin.cam.ac.uk/api/](https://test.researchdashboard.admin.cam.ac.uk/api/) |
The GCP console pages for managing the infrastructure of each component of the deployment are:
| 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) |
## Source code
The source code for the Research Dashboard is spread over the following repositories:
| Repository | Description
| ----------- | ------------------ |
| [Application Server](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/webapp) | The source code for the main application server. |
| [CUFS GMS Microservice](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/datamart-api) | The source code for the micro-service querying CUFS grant management system data. |
| [CHRIS Grant Contracts Microservice](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/chris-salaries-api) | The source code for the micro-service querying CHRIS contracts data. |
| [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
The following gives an overview of the technologies the Research Dashboard is built on.
| Category | Language | Framework |
| -------- | -------- | --------- |
| Server | Python 3.7 | Django 2.1 |
| Client | TypeScript | React 16.4 |
| Server | Python 3.7 | Django 2.2 |
| Client | JavaScript | jQuery v3.2.1 |
| Client | TypeScript | React 16.12 |
## Operational documentation
The following gives an overview of how the Research Dashboard is deployed and maintained.
### 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.
### Deploying a new release
The README.md file in the Infrastructure Deployment repository explains how to deploy the Research Dashboard.
### 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).
### Debugging
See monitoring.
### Administration
Any operational or administration issues should be raised as an issue in [a repository for this purpose](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/operations/-/issues).
Deployment
----------
[GCP Kubernetes Cluster](https://console.cloud.google.com/kubernetes/list?project=uis-automation-pidash)
## Service Management and tech lead
Deployment repository
---------------------
[Deployment](https://gitlab.developers.cam.ac.uk/uis/devops/research-dashboard/deployment)
The **service owner** for the Research Dashboard is [Dawn Edwards](https://www.lookup.cam.ac.uk/person/crsid/dgb26).
Service Owner
-------------
[Dawn Edwards](https://www.lookup.cam.ac.uk/person/crsid/dgb26)
The **service managers** for the Research Dashboard are
[Abraham Martin](https://www.lookup.cam.ac.uk/person/crsid/amc203) and
[Will Russell](https://www.lookup.cam.ac.uk/person/crsid/weer2).
Service Managers
----------------
[Abraham Martin](https://www.lookup.cam.ac.uk/person/crsid/amc203) /
[Will Russell](https://www.lookup.cam.ac.uk/person/crsid/weer2)
The **tech lead** for the Research Dashboard is [Mike Bamford](https://www.lookup.cam.ac.uk/person/crsid/mb2174).
Current Status
--------------
Beta
The following engineers have operational experience with the Research Dashboard and are able to
respond to support requests or incidents:
Documentation
-------------
- [Main documentation](https://wiki.cam.ac.uk/uis/PI_Dashboard)
* [Rich Wareham](https://www.lookup.cam.ac.uk/person/crsid/rjw57)
......@@ -95,7 +95,7 @@ The following gives an overview of how the Self-Service Gateway is deployed and
### How and where the Self-Service Gateway is deployed
Database for undergraduate applicant data is a PostgreSQL database hosted by GCP Cloud SQL.
Database for storage license/project data is a PostgreSQL database hosted by GCP Cloud SQL.
The main web application is a Django application, currently hosted by a legacy Corosync/Pacemaker
cluster (shortly to be moved to GCP Cloud Run).
The application stores documents (Purchase Orders) in a GCP storage bucket.
......@@ -107,7 +107,7 @@ Gateway.
### Monitoring
The application emails error to `ssgw-admin@uis.cam.ac.uk`. More detailed logs can be found on the
The application emails errors to `ssgw-admin@uis.cam.ac.uk`. More detailed logs can be found on the
[GCP Console](https://console.cloud.google.com/logs/viewer?project=ssgw-prod-1d1c497f).
### Debugging
......@@ -116,7 +116,7 @@ See monitoring.
### Administration
Any operational or administration issues should be raised as an issue in [a repository for this purpose](https://gitlab.developers.cam.ac.uk/uis/devops/ssgw/operations).
Any operational or administration issues should be raised as an issue in [a repository for this purpose](https://gitlab.developers.cam.ac.uk/uis/devops/ssgw/operations/-/issues).
## Service Management and tech lead
......
# A human-friendly name for the site as a whole.
site_name: 'DevOps Division Guidebook'
# The canonical URL of the site.
site_url: 'https://guidebook.devops.uis.cam.ac.uk/'
# Site layout
nav:
- 'Overview': 'index.md'
......
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