https://github.com/hypertrace/gateway-service
Entry service for querying data from other services like entity-service, query-service, etc
https://github.com/hypertrace/gateway-service
Last synced: 7 months ago
JSON representation
Entry service for querying data from other services like entity-service, query-service, etc
- Host: GitHub
- URL: https://github.com/hypertrace/gateway-service
- Owner: hypertrace
- License: other
- Created: 2020-07-07T16:20:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-25T07:08:15.000Z (over 1 year ago)
- Last Synced: 2024-06-25T08:48:56.643Z (over 1 year ago)
- Language: Java
- Size: 1.05 MB
- Stars: 6
- Watchers: 5
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Gateway Service
An entry service that acts as a single access point for querying data from other services like entity-service, query-service, Attribute service.
## Description
|  |
|:--:|
| *Hypertrace Query Architecture* |
Gateway service routes queries to corresponding downstream service based on the source of attributes and then does appropriate type conversion of data returned by downstream services.
## Building locally
The Gateway service uses gradlew to compile/install/distribute. Gradle wrapper is already part of the source code. To build Gateway Service, run:
```
./gradlew dockerBuildImages
```
## Testing
### Running unit tests
Run `./gradlew test` to execute unit tests.
### Testing image
#### With docker-compose
To test your image using the docker-compose setup follow the steps:
- Commit you changes to a branch say `gateway-service-test`.
- Go to [hypertrace-service](https://github.com/hypertrace/gateway-service) and checkout the above branch in the submodule.
```
cd gateway-service && git checkout gateway-service-test && cd ..
```
- Change tag for `hypertrace-service` from `:main` to `:test` in [docker-compose file](https://github.com/hypertrace/hypertrace/blob/main/docker/docker-compose.yml) like this.
```yaml
hypertrace-service:
image: hypertrace/hypertrace-service:test
container_name: hypertrace-service
...
```
- and then run `docker-compose up` to test the setup.
#### With Helm setup
Add image repository and tag in values.yaml file [here](https://github.com/hypertrace/hypertrace/blob/main/kubernetes/platform-services/values.yaml) like below and then run `./hypertrace.sh install` again and you can test your image!
```yaml
gateway-service:
image:
repository: "hypertrace/gateway-service"
tagOverride: "test"
```
## Docker Image Source:
- [DockerHub > Gateway service](https://hub.docker.com/r/hypertrace/gateway-service)