Skip to content
Snippets Groups Projects
Commit d1474118 authored by Steffen Schulze's avatar Steffen Schulze
Browse files

readme update

parent 42f6983c
Branches main
No related tags found
No related merge requests found
Pipeline #56599 failed
......@@ -2,7 +2,16 @@
## Introduction
The operator observes changes and triggeres the correct action within a namespace.
The operator observes a namespace for services which are annotated with a special xfsc tag. This tag contains information about the plugin name, its id etc. The annotation must be in the service deployment like this:
```
xfsc.kubernetes.io/configuration: |
{"version":"v1","route":"/plugin-template", "name":"Plugin template", "serviceguid":"19bafa36-8415-44e9-a2de-32852fefa6ef","routeguid":"30959362-e35b-4eb4-afe5-e8fdd6a3fecd"}
```
When the operator finds such a annotation, he will start to add it into the kong services list, which is later on discovered by the plugin discovery.
## Dependencies
......@@ -10,7 +19,7 @@ The operator observes changes and triggeres the correct action within a namespac
[Kubernetes](https://kubernetes.io/) - The container orchestration system used to deploy the microservices. Used for plugin detection and synchronization
## Plugin Synchronization
## Plugin Synchronization Annotation
If a micro service is deployed by using
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment