Skip to content

Commit d38cc08

Browse files
author
ReleaseBot
committed
chore: sync from gitlab
1 parent 65be9f4 commit d38cc08

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Is based on [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gatew
1313
Its purpose is mainly advanced token (OAuth 2.0) handling, enables support for:
1414
* mesh functionality
1515
* external authorization
16-
* own Stargate tokens
16+
* own Gateway tokens
1717
* customizing headers
1818
* listening on given service (creates events for issued traffic)
1919

@@ -43,7 +43,7 @@ Most common scenario, request is forwarded to provider, while jumper combines in
4343

4444
Headers expected on incoming side:
4545
* remote_api_url - url, to which is request forwarded
46-
* api_base_path - base path of Kong service from the same Stargate initially called, passed as requestPath claim
46+
* api_base_path - base path of Kong service from the same Gateway initially called, passed as requestPath claim
4747
* realm - for setting correct issuer
4848
* environment - passed as env claim
4949
* access_token_forwarding - false, used to determine scenario
@@ -81,7 +81,7 @@ Legacy scenario, request is forwarded to provider with 2 tokens, original incomi
8181

8282
Headers expected on incoming side:
8383
* remote_api_url - url, to which is request forwarded
84-
* api_base_path - base path of Kong service from the same Stargate initially called, passed as requestPath claim
84+
* api_base_path - base path of Kong service from the same Gateway initially called, passed as requestPath claim
8585
* realm - for setting correct issuer
8686
* environment - passed as env claim
8787
* access_token_forwarding - true, used to determine scenario
@@ -116,13 +116,13 @@ Relevant headers on outgoing side:
116116
* X-Gateway-Token - LMS token
117117

118118
#### Mesh token
119-
Scenario with multiple Stargate instances involved. Jumper fetches oauth token from other zone identity provider (aka mesh token),
119+
Scenario with multiple Gateway instances involved. Jumper fetches oauth token from other zone identity provider (aka mesh token),
120120
while original authorization token is passed as a <i>consumer-token</i> header. Mesh token is cached, so fetching is performed only if valid token is not available.
121121

122122
![mesh flow!](pictures/jumper2_mesh.png "mesh flow")
123123

124124
Headers expected on incoming side:
125-
* remote_api_url - url (including service base path) of other zone Stargate, to which is request forwarded
125+
* remote_api_url - url (including service base path) of other zone Gateway, to which is request forwarded
126126
* issuer - issuer of other zone identity provider
127127
* client_id - client id with dedicated client on other zone identity provider
128128
* client_secret - client secret with dedicated client on other zone identity provider
@@ -251,8 +251,8 @@ Request/Response events are created, if consumer/API combination matches. Creat
251251
### Header enhancement/manipulation
252252
* X-Spacegate-Token - if any Spacegate is involved, incoming token is copied to <i>X-Spacegate-Token</i> header
253253
* X-Forwarded-Host/Port/Proto - to avoid additional reporting Kong + Jumper as separate hop, these headers needs to be adapted
254-
* X-Origin-Stargate - shows, which Stargate host was originally called (mesh concept)
255-
* X-Origin-Zone - shows, which Stargate zone was originally called (mesh concept)
254+
* X-Origin-Stargate - shows, which Gateway host was originally called (mesh concept)
255+
* X-Origin-Zone - shows, which Gateway zone was originally called (mesh concept)
256256

257257
### Tracing support
258258
* [b3 zipkin propagation](https://github.com/openzipkin/b3-propagation) supported. Prerequisite is to set valid <i>spring.zipkin.baseUrl</i>
@@ -264,7 +264,7 @@ Request/Response events are created, if consumer/API combination matches. Creat
264264

265265

266266
### Glossary
267-
* <b>Stargate</b> - set of Kong + Jumper + Issuer service
268-
* <b>Spacegate</b> - Stargate accessible from/having access to (after firewall clearance) Internet
267+
* <b>Gateway</b> - set of Kong + Jumper + Issuer service
268+
* <b>Spacegate</b> - Gateway accessible from/having access to (after firewall clearance) Internet
269269
* <b>jumper_config</b> - base64 encoded structure used to pass various information
270270

0 commit comments

Comments
 (0)