Skip to content

Commit

Permalink
add readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
dgghinea committed Dec 13, 2023
1 parent 52e6294 commit e235f7f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The Kong agents are used to discover, provision access to, and track usages of K
- [Kong admin API secured by Kong Gateway](#kong-admin-api-secured-by-kong-gateway)
- [Specification discovery methods](#specification-discovery-methods)
- [Local specification path](#local-specification-path)
- [Filtering gateway services](#filtering-gateway-services)
- [URL specification paths](#url-specification-paths)
- [Kong Dev Portal](#kong-dev-portal)
- [HTTP Log plugin](#http-log-plugin)
Expand Down Expand Up @@ -213,6 +214,16 @@ Configuration on my-service gateway service
}
```

##### Filtering gateway services

Some possible ways to use the filter for gateway services (all these are done with the env var `KONG_SPEC_FILTER`):

Ex1: "tag.Any() == \"spec_local_petstore.json\"" -> this will find all the services that have a tag as "spec_local_petstore.json"
Ex2: "tag.discover.Exists()" -> this will find all tags that are equal to "discover"
Note: while both ways can achieve the same functionality, the first one is preferred because it does not restrict you on character usages for Kong tags (note the dot in example 2)

Currently, functionalities such as tag.Any().Contains() are not implemented in the SDK and only fully equal values are taken into account

##### URL specification paths

The URL specification paths discovery method is configured by value(s) for the `KONG_SPEC_URLPATHS` variable, comma separated. When values are set here, and a local path is not set, The Kong agent will query each of these paths against the gateway service in order to find a specification file. Once a specification file is found none of the other configured URL paths will be queried as that specification file will be used in the creation of the API Service on Central.
Expand Down

0 comments on commit e235f7f

Please sign in to comment.