FAQ | This is a LIVE service | Changelog

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

Initial service document template.

parent a166d687
No related branches found
No related tags found
1 merge request!69Issue 85 document eduroam tokens
Pipeline #76099 passed
# Eduroam Tokens
# `<service_name>`
This page documents key information about the Eduroam 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.
Environments and Servers they run on
------------------------------------
## Service Description
- [Production]({link to application}) {link to api if applicable (see information-asset-register.md)}
- {list the servers the application is deployed to (see self-service-gateway.md) or link to cluster management (see information-asset-register.md)}
- [Test]({link to application}) {include link to api if applicable see information-asset-register.md}
- {list the servers the application is deployed to (see self-service-gateway.md) or link to cluster management (see information-asset-register.md)}
- {any other environments}
`<high level description of what the service does>`
Application repositories
------------------------
- [{application component 1}]({link to repo})
- [{application component 2}]({link to repo})
## Service Status
Technology
----------
The `<service_name>` is currently `pre-alpha|alpha|beta|live|decommissioning`.
| Category | Language | Framework |
`<notes about status and links to roadmaps / timelines for future development or decommissioning>`
## Contact
Technical queries and support should be directed to `<role email>` 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 `<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>)`.
## Environments
The `<service_name>` 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>`
## Source code
The source code for the `<service_name>` 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 |
## Technologies used
The following gives an overview of the technologies the `<service_name>` is built on.
| 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} |
Deployment
----------
{brief description of technologies involved - links where appropriate (use completed templates as guide)}
Deployment repository
---------------------
- [{application deployment repo 1}]({link to repo})
- [{application deployment repo 2}]({link to repo})
## Operational documentation
The following gives an overview of how the `<service_name>` is deployed and maintained.
### How and where the `<service_name>` is deployed
`<documentation or links to external docs describing how and where the application is deployed>`
### Deploying a new release
`<documentation or links to external docs about how a new release is made and deployed>`
### Monitoring
`<documentation or links to external docs about monitoring and how alerts should be responded to>`
### Debugging
`<documentation or links to external docs describing how to debug both a deployed instance and locally>`
### `<other operation issues>`
`<documentation or links to external docs about other operation issues>`
## Service Management and tech lead
The **service owner** for the `<service_name>` is `<service owner name and Lookup link>`.
Service Owner
-------------
[{Full Name}](https://www.lookup.cam.ac.uk/person/crsid/{crsid})
The **service manager** for the `<service_name>` is `<service manager name and Lookup link>`.
Service Managers
----------------
[{Full Name}](https://www.lookup.cam.ac.uk/person/crsid/{crsid})
The **tech lead** for the `<service_name>` is `<tech lead name and Lookup link>`.
Current Status
--------------
Alpha
The following engineers have operational experience with the `<service_name>` and are able to
respond to support requests or incidents:
Documentation
-------------
- [{description of documentation 1}]({link to documentation})
- [{description of documentation 2}]({link to documentation})
* `<engineer name and Lookup link>`
* `<engineer name and Lookup link>`
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