Updated README #27
Updated README #27
Conversation
| * Filters and transforms it to UP standard json representation | ||
| * Puts the result onto the kafka destination topic _ConceptSuggestions_ | ||
|
|
||
| v1-suggestor service communicates with kafka via http-rest-proxy. It polls kafka-rest-proxy for messages and POSTs transfirmed messages to kafka-rest-proxy. |
| This service is deployed in the Delivery clusters. | ||
| ## Installation | ||
|
|
||
| * `go get -u github.com/Financial-Times/v1-sugestor` |
There was a problem hiding this comment.
github.com/Financial-Times/v1-suggestor not github.com/Financial-Times/v1-sugestor
| | **SRC_ADDR** |_http://localhost:8080_ | Url of the _http-rest-proxy_ host to connect to in order to **receive** messages from kafka. | | ||
| | **SRC_GROUP** | _v1Suggestor_ | The consumer group for receiving messages from kafka. | | ||
| | **SRC_TOPIC** | _NativeCmsMetadataPublicationEvents_ | kafka topic to consume messages from. | | ||
| | **SRC_QUEUE** | _kafka_ | Used by _Vulkan_ to route http requests based on _Host_ header. In docker cluster all hosts are at _http://localhost:8080_. This http header is supplied to distinguish one service from another. Host header _kafka_ points to _http-rest-proxy_. | |
|
|
||
|
|
||
| ## Prerequisites | ||
| 1. In order to set LDFLAGS to provide correct versionning information to */build-info* endpoint we need to enable access to remote GIT repo via https (not ssh) because Docker does not have your ssh keys. |
There was a problem hiding this comment.
This our standard approach to build-info and I don't think it should be documented in every service as it will be the same for every Go service
There was a problem hiding this comment.
I agree, but I've been tripping over it every so often because it is very easy to forget and it is not sadly documented anywhere else. Perhaps we can consider a git "README" repo that has a "parent" README for all our go services. We can then reference it in the READMEs like this one. It can also contain other staff like service related specs. Why git? because it's easy to maintain the history of the docs, do reviews and all the jazz that SCM gives us.
There was a problem hiding this comment.
I don't think it belongs here though as for it's alternative location why not bring it up the tech forum
|
|
||
| |Endpoint | Explained | | ||
| |---|---| | ||
| | /__health | checks that v1-sugestor can communicate to kafka via http-rest-proxy| |
| |/build-info | the same as above for compatibility with Dropwizard java apps | | ||
|
|
||
|
|
||
| Note: Brigthcove video metadata is the same pipeline as metadata for Methode articles, so brands are added in the same way. |
There was a problem hiding this comment.
It is brightcove, wordpress and methode
| _TODO: We should consider documenting the format of the in/out messages to kafka._ |
There was a problem hiding this comment.
An example message would be nice
There was a problem hiding this comment.
Also the message that is on Kafka is base64 encoded
No description provided.