FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit 31013cfe authored by Steve Ison's avatar Steve Ison
Browse files

first pas at updated docs.

parent 39fbc7a4
No related branches found
No related tags found
1 merge request!69Issue 85 document eduroam tokens
# `<service_name>`
# Network Access Tokens Service
This page gives an overview of the `<service_name>`, describing its current status, where and
how it's developed and deployed, and who is responsible for maintaining it.
This page gives an overview of the Network Access Tokens service, describing its current status, where and how it's developed and deployed, and who is responsible for maintaining it.
## Service Description
`<high level description of what the service does>`
The Network Access Tokens site provides a site for Raven-authenticated users to obtain and manage per-device tokens allowing them to use eduroam and the University’s wireless network, and the VPN service.
## Service Status
The `<service_name>` is currently `pre-alpha|alpha|beta|live|decommissioning`.
`<notes about status and links to roadmaps / timelines for future development or decommissioning>`
The Network Access Tokens service is currently live.
## Contact
......@@ -20,29 +17,25 @@ by a member of the team working on the service. To ensure that you receive a res
direct requests to `<role email>` 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](<link to gitlab issues page>)`.
[GitLab issues in the application repository](https://gitlab.developers.cam.ac.uk/uis/sysdev/devgroup/network-access/network-access/-/issues).
## Environments
The `<service_name>` is currently deployed to the following environments:
The Network Access Tokens service is currently deployed to the following environments:
| Name | URL | Supporting VMs |
| ----------- | ------------------ | --------------- |
| Production | `<production_url>` | `<list of vms>` |
| Staging | `<staging_url>` | `<list of vms>` |
| Development | `<dev_url>` | `<list of vms>` |
`<notes about access to environments and anything special about how an environment is used>`
| Production | [https://tokens.uis.cam.ac.uk](https://tokens.uis.cam.ac.uk) | tokens-node1.csi.private.cam.ac.uk|
| | | tokens-node2.csi.private.cam.ac.uk|
| | | tokens-nodeq.csi.private.cam.ac.uk|
## Source code
The source code for the `<service_name>` is spread over the following repositories:
The source code for the Network Access Tokens service is spread over the following repositories:
| Repository | Description
| ----------- | ------------------ |
| [Application Server]() | The source code for the main application server |
| [Infrastructure Deployment]() | The Terraform infrastructure code for deploying the application server to GCP |
| [Application Server](https://gitlab.developers.cam.ac.uk/uis/sysdev/devgroup/network-access/network-access) | The source code for the main application server |
## Technologies used
......@@ -50,9 +43,9 @@ The following gives an overview of the technologies the `<service_name>` is buil
| Category | Language | Framework(s) |
| -------- | -------- | --------- |
| Server | {name and version} | {name and version} |
| Client | {name and version} | {name and version} |
| {other} | {name and version} | {name and version} |
| Server | Groovy 2.4.12 | Grails 1.3.10 |
| DB | Postgres | 10.5 |
## Operational documentation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment