FAQ
| This is a
LIVE
service |
Changelog
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
DevOps Division Guidebook
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Information Services
DevOps
General Documentation
DevOps Division Guidebook
Merge requests
!91
populate the service information page for the API Gateway
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
populate the service information page for the API Gateway
issue-109-technical-overview-of-gateway
into
master
Overview
3
Commits
2
Pipelines
2
Changes
1
All threads resolved!
Hide all comments
Merged
Dr Rich Wareham
requested to merge
issue-109-technical-overview-of-gateway
into
master
3 years ago
Overview
3
Commits
2
Pipelines
2
Changes
1
All threads resolved!
Hide all comments
Expand
Closes
#109 (closed)
0
0
Merge request reports
Compare
master
version 1
2ef438c9
3 years ago
master (base)
and
latest version
latest version
c29f3c0a
2 commits,
3 years ago
version 1
2ef438c9
1 commit,
3 years ago
1 file
+
64
−
44
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
docs/services/api-gateway.md
+
64
−
44
Options
# API Gateway
This page
documents key information about
the API Gateway service.
This page
gives an overview of
the API Gateway service.
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}
The API Gateway service allows people to publish APIs via
https://api.apps.cam.ac.uk/ which make use of common quota enforcement,
developer registration and authentication.
Application repositories
------------------------
-
[
{application component 1}
](
{link
to repo})
-
[
{application component 2}
](
{link
to repo})
A developer portal allowing self-service registration of applications which make
use of the published APIs is at https://developer.api.apps.cam.ac.uk/.
Technology
----------
## Service Status
| Category | Language | Framework |
This service is currently an
*ALPHA*
offering.
## Contact
Issues with the service should be raised on the
[
corresponding GitLab
project
](
https://gitlab.developers.cam.ac.uk/uis/devops/api/gateway-ops
)
(University members only).
## Environments
The API Gateway is hosted by our vendor, Apigee.
## Source code
Terraform which drives the API Gateway is developed in a
[
dedicated project on
GitLab
](
https://gitlab.developers.cam.ac.uk/uis/devops/api/gateway-ops
)
.
## Technologies used
The following gives an overview of the technologies the API Gateway 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})
Service Owner
-------------
[
{Full Name}
](
https://www.lookup.cam.ac.uk/person/crsid/{crsid}
)
Service Managers
----------------
[
Abraham Martin
](
https://www.lookup.cam.ac.uk/person/crsid/amc203
)
Current Status
--------------
Planning
Documentation
-------------
-
[
{description of documentation 1}
](
{link
to documentation})
-
[
{description of documentation 2}
](
{link
to documentation})
| Configuration | Apigee proprietary | N/A |
| Deployment | terraform | N/A |
## Deployment
Deployment is via terraform using our
[
logan
](
https://gitlab.developers.cam.ac.uk/uis/devops/tools/logan/
)
tool. There
are currently two terraform workspaces:
*
`development`
which manages a testing Apigee organisation named
"devopsaccountrecoveryapigeestaging-eval"
*
`production`
which manages the production Apigee organisation named "cam"
## Documentation
Dedicated operational documentation is hosted
[
within the GitLab
project
](
https://gitlab.developers.cam.ac.uk/uis/devops/api/gateway-ops/-/tree/master/doc
)
.
End-user documentation is hosted on the
[
Developer
portal
](
https://developer.api.apps.cam.ac.uk/
)
.
## Service Management and tech lead
The
**service owner**
for the API gateway is currently vacant.
The
**service manager**
for the API gateway is currently vacant.
The
**tech lead**
for the API gateway is
[
Rich
Wareham
](
https://www.lookup.cam.ac.uk/person/crsid/rjw57
)
.
The following engineers have operational experience with the API Gateway and are able
to respond to support requests or incidents:
*
[
Monty Dawson
](
https://www.lookup.cam.ac.uk/person/crsid/wgd23
)
Loading