Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add section Configure ADD_PROXY_ROUTE of API Gateway #181

Merged
merged 2 commits into from
Jul 20, 2020
Merged

doc: Add section Configure ADD_PROXY_ROUTE of API Gateway #181

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06fa3b3
doc: Add section Configure ADD_PROXY_ROUTE of API Gateway
jim-wang-intel Jul 8, 2020
586e719
Merge branch 'master' into add-proxy-routes-171
jim-wang-intel Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs_src/microservices/security/Ch-APIGateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,40 @@ will be denied when trying to access resources through the API Gateway.
name = "acl"
whitelist = "admin,user"

**Configuration of Adding Microservices Routes for API Gateway**

For the current pre-existing Kong routes, they are configured and initialized statically through configuration TOML file specified in `security-proxy-setup` application. This is not sufficient for some other new additional microservices like application services, for example. Thus, adding new proxy Kong routes are now possibly achieved via the environment variable, `ADD_PROXY_ROUTE`, of service `edgex-proxy` in the docker-compose file. Here is an example:

```yaml
edgex-proxy:
...
environment:
...
ADD_PROXY_ROUTE: "myApp.http://my-app:56789"
...

...

my-app:
...
container_name: myApp
hostname: myApp
...

```

The value of `ADD_PROXY_ROUTE` takes a comma-separated list of one or more (at least one) paired additional service name and URL for which to create proxy Kong routes. The paired specification is given as the following:

**\<RoutePrefix\>.\<TargetRouteURL\>**

where **RoutePrefix** is the name of service which requests to create proxy Kong route and it is case insensitive; it is the docker network hostname of the service that want to add the proxy Kong route in the docker-compose file if running from docker-compose, for example, `myApp` in this case.

**TargetRouteURL** is the full qualified URL for the target service, like `http://my-app:56789`

So as an example, for a single service, the value of `ADD_PROXY_ROUTE` would be: "`myApp.http://my-app:56789`".

Once `ADD_PROXY_ROUTE` is configured and composed-up successfully, the proxy route then can be accessed the app's REST API via Kong as `http://localhost:8000/myApp/api/v1/...` in the same way you would access the edgex service in which you will also need an access token and it is using default access role if not specified in the TOML configuration file as well.

## Using API Gateway

**Resource Mapping between EdgeX Microservice and API gateway**
Expand Down