jeager-service-example

README

cm-go-service

Content&Metadata platform template repository for Go microservices.

• Use this repo as template repository.

• Look for all occurrences of the string cm-go-service and rename them appropriately.

• Look for all TODO statements and fix them appropriately.

• Decide in which clusters should the service be deployed (e.g. PAC/UPP, Delivery/Publish) and leave only the needed configurations in the helm/cm-go-service/app-configs directory. There are some example configurations provided in the app-configs directory to be used as a guideline.

• Rename helm/cm-go-service and the corresponding app-config files e.g. helm/cm-go-service/app-configs/cm-go-service_delivery.yaml.

• Add the team that supports the service in the .github/CODEOWNERS file, e.g. (leave only the relevant team):

  # This repo is supported by:
  * @Financial-Times/content-team @Financial-Times/metadata-team @Financial-Times/platform-health
  

Installation

Download the source code, dependencies and test dependencies:

git clone https://github.com/Financial-Times/cm-go-service.git
cd cm-go-service
go build

Service endpoints

For a full description of the API endpoints for the service, please check the Open API specification.

Admin endpoints

The admin endpoints are:

/__gtg
/__health
/__build-info