jeager-service-example

command module
v0.0.0-...-de9010c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2021 License: MIT Imports: 18 Imported by: 0

README

cm-go-service

Coverage Status CircleCI

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL