Skip to content

DBOMproject/chainsource-gateway

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docker-ci GitHub GitHub release (latest SemVer) Docker Pulls Coverage Status

Chainsource Gateway

The gateway component for the Digital Bill of Materials

Table of Contents generated with DocToc

How to Use

API

Latest OpenAPI Specifications and Postman Collection Files for this API is available on the api-specs repository

Configuration

Environment Variable Default Description
LOG_LEVEL info The verbosity of the logging
PORT 3000 Port on which the gateway listens
JAEGER_ENABLED false Is jaeger tracing enabled
JAEGER_HOST `` The jaeger host to send traces to
JAEGER_SAMPLER_PARAM 1 The parameter to pass to the jaeger sampler
JAEGER_SAMPLER_TYPE const The jaeger sampler type to use
JAEGER_SERVICE_NAME Chainsource Gateway The name of the service passed to jaeger
JAEGER_AGENT_SIDECAR_ENABLED false Is jaeger agent sidecar injection enabled

Configure agent-config.yaml with the details of your agent(s)

Helm Deployment

Instructions for deploying the Chainsource Gateway using helm charts can be found here

Platform Support

Currently, we provide pre-built container images for linux amd64 and arm64 architectures via our Github Actions Pipeline. Find the images here

Getting Help

If you have any queries on chainsource-gateway, feel free to reach us on any of our communication channels

If you have questions, concerns, bug reports, etc, please file an issue in this repository's issue tracker.

Getting Involved

Find the instructions on how you can contribute in CONTRIBUTING.