Skip to content

Commit ec3b8a6

Browse files
committed
docs: add services config basics
1 parent caed749 commit ec3b8a6

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
/target
2+
3+
# jetbrains IDE config
4+
.idea/

SERVICES.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Services
2+
3+
## Adding a New Service
4+
To register a service with the gateway to make it available for use from the [Tulsa Web Devs UG Site](https://tulsawebdevs.org), perform the following steps:
5+
- add an entry to `gateway_config.toml` in the following format:
6+
```toml
7+
[services.name] # where 'name' is a unique kebab-case name for your service
8+
path="/myservice" # unique path the frontend will make a request to at /api[path]
9+
target_service="https://my-service.default.svc.cluster.local" # the host for the service
10+
target_port=8080 # the target port for your service
11+
```
12+
- add an entry for your service in the list below with a brief description of your service and a link to the documentation
13+
14+
**PR's that do not include documentation of the service will not be merged**
15+
16+
## Registered Services
17+
*Use the following basic format `[repo link](https://myservicelocation)` - Service Name / short description
18+
19+
-[Tulsa Web Devs UG Site](https://tulsawebdevs.org) - The Frontend Static Site that uses this API Gateway

0 commit comments

Comments
 (0)