Skip to content

Commit 18d537f

Browse files
Merge pull request #366 from minos-framework/issue-363-docs-for-minos-discovery-kong
#363 - Discovery Kong documentation
2 parents 3b12d0d + c69ce6e commit 18d537f

File tree

1 file changed

+34
-3
lines changed
  • packages/plugins/minos-discovery-kong

1 file changed

+34
-3
lines changed

packages/plugins/minos-discovery-kong/README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Minos Kong is a plugin that integrate minos micorservices with Kong API Gateway
1919
Install the dependency:
2020

2121
```shell
22-
pip install minos-kong
22+
pip install minos-discovery-kong
2323
```
2424

2525
Modify `config.yml` file:
@@ -28,12 +28,43 @@ Modify `config.yml` file:
2828
...
2929
discovery:
3030
connector: minos.networks.DiscoveryConnector
31-
client: minos.plugins.minos_kong.MinosKongClient
31+
client: minos.plugins.kong.KongDiscoveryClient
3232
host: localhost
33-
port: 5567
33+
port: 8001
3434
...
3535
```
3636

37+
## How to
38+
The above configuration is sufficient for the microservice to subscribe on startup and unsubscribe on shutdown.
39+
Therefore, all you would have to do would be to make your requests against:
40+
41+
`http://localhost:8000/your_endpoint`
42+
43+
## Kong official documentation
44+
### Official docs
45+
You can get read the official docs [here](https://docs.konghq.com/gateway/2.8.x/admin-api/).
46+
47+
### Postman
48+
49+
You can get the official postman collection for postman [here](https://documenter.getpostman.com/view/10587735/SzS7QS2c#intro).
50+
51+
## Konga - Administrative interface
52+
For development purposes you can add open-source administrative section by using next docker service:
53+
```yaml
54+
services:
55+
...
56+
konga:
57+
image: pantsel/konga
58+
ports:
59+
- 1337:1337
60+
links:
61+
- kong:kong
62+
container_name: konga
63+
environment:
64+
- NODE_ENV=production
65+
```
66+
67+
You can get read the official docs [here](https://pantsel.github.io/konga/).
3768
## Documentation
3869
3970
The official API Reference is publicly available at the [GitHub Pages](https://minos-framework.github.io/minos-python).

0 commit comments

Comments
 (0)