-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
/target | ||
|
||
# jetbrains IDE config | ||
.idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Services | ||
|
||
## Adding a New Service | ||
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: | ||
- add an entry to `gateway_config.toml` in the following format: | ||
```toml | ||
[services.name] # where 'name' is a unique kebab-case name for your service | ||
path="/myservice" # unique path the frontend will make a request to at /api[path] | ||
target_service="https://my-service.default.svc.cluster.local" # the host for the service | ||
target_port=8080 # the target port for your service | ||
``` | ||
- add an entry for your service in the list below with a brief description of your service and a link to the documentation | ||
|
||
**PR's that do not include documentation of the service will not be merged** | ||
|
||
## Registered Services | ||
*Use the following basic format `[repo link](https://myservicelocation)` - Service Name / short description | ||
|
||
-[Tulsa Web Devs UG Site](https://tulsawebdevs.org) - The Frontend Static Site that uses this API Gateway |