Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ability for services to register readiness check #726

Closed
strantalis opened this issue May 1, 2024 · 0 comments · Fixed by #760
Closed

ability for services to register readiness check #726

strantalis opened this issue May 1, 2024 · 0 comments · Fixed by #760
Assignees
@strantalis
Labels
comp:core Core component

Comments

@strantalis
Copy link
Member

strantalis commented May 1, 2024 •
edited

Add registration option that allows a service to register its own health check to the platform health check service.

Not sure if this was the best implementation but we can mimic how the WellknownService was designed.

Private package variable: https://github.com/opentdf/platform/blob/main/service/wellknownconfiguration/wellknown_configuration.go#L22

Register function: https://github.com/opentdf/platform/blob/main/service/wellknownconfiguration/wellknown_configuration.go#L26-L34

Service Registration Param: https://github.com/opentdf/platform/blob/main/service/pkg/serviceregistry/serviceregistry.go#L34

The health check service should now call out to each of these registered functions to get the status of a service and respond with a 200 if all services are healthy.

Not sure how customizable the proto response is but it would be nice to show which service is down or up as well. This might require us to define our own health check response proto.
@strantalis strantalis added the comp:core Core component label May 1, 2024
This was referenced May 1, 2024
Closed
Closed
@strantalis strantalis self-assigned this May 6, 2024
@strantalis strantalis mentioned this issue May 7, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 7, 2024
@strantalis
fix(core): rollup readiness checks to central health service (#755)
8a65161 
This pr introduces the ability for services to register with a
centralized platform health check.

```mermaid
block-beta
columns 1
HC["Platform Health Check"]
space
block:ID
 K["KAS"]
 A["Authorization Service"]
 P["Policy Service"]
end
K --> HC
A --> HC
P --> HC
```

Resolves 
- #700 
- #727 
- #726
@opentdf-automation opentdf-automation bot mentioned this issue May 7, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 15, 2024
@opentdf-automation
chore(main): release service 0.4.2 (#760)
e418f15 
🤖 I have created a release *beep* *boop*
---


##
[0.4.2](service/v0.4.1...service/v0.4.2)
(2024-05-15)


### Features

* **docs:** improve serviceregistry doc annotations
([#799](#799))
([df8a504](df8a504))


### Bug Fixes

* **authz:** Adds jwt to context when verified
([#764](#764))
([7bf6513](7bf6513))
* **ci:** Use the correct schema with the provision fixture command
([#794](#794))
([459e82a](459e82a))
* **core:** Bump dep on sdk; reduce go to 1.21
([#815](#815))
([fe4a5ca](fe4a5ca))
* **core:** rollup readiness checks to central health service
([#755](#755))
([8a65161](8a65161)),
closes [#726](#726)
* **core:** Updates logs statements to log errors
([#796](#796))
([7a3379b](7a3379b))
* **core:** wrong AuthorizationService provided with missing logger
([#791](#791))
([b13be04](b13be04))
* **sdk:** Reduces sdk go requirement to 1.21
([#795](#795))
([6baee80](6baee80))
* **service:** cleanup the cryptoprovider config
([#803](#803))
([1458d17](1458d17))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
tech-guru42 added a commit to tech-guru42/TDF that referenced this issue Jun 3, 2024
@tech-guru42 @opentdf-automation
chore(main): release service 0.4.2 (#760)
82d06bd 
🤖 I have created a release *beep* *boop*
---


##
[0.4.2](opentdf/platform@service/v0.4.1...service/v0.4.2)
(2024-05-15)


### Features

* **docs:** improve serviceregistry doc annotations
([#799](opentdf/platform#799))
([df8a504](opentdf/platform@df8a504))


### Bug Fixes

* **authz:** Adds jwt to context when verified
([#764](opentdf/platform#764))
([7bf6513](opentdf/platform@7bf6513))
* **ci:** Use the correct schema with the provision fixture command
([#794](opentdf/platform#794))
([459e82a](opentdf/platform@459e82a))
* **core:** Bump dep on sdk; reduce go to 1.21
([#815](opentdf/platform#815))
([fe4a5ca](opentdf/platform@fe4a5ca))
* **core:** rollup readiness checks to central health service
([#755](opentdf/platform#755))
([8a65161](opentdf/platform@8a65161)),
closes [#726](opentdf/platform#726)
* **core:** Updates logs statements to log errors
([#796](opentdf/platform#796))
([7a3379b](opentdf/platform@7a3379b))
* **core:** wrong AuthorizationService provided with missing logger
([#791](opentdf/platform#791))
([b13be04](opentdf/platform@b13be04))
* **sdk:** Reduces sdk go requirement to 1.21
([#795](opentdf/platform#795))
([6baee80](opentdf/platform@6baee80))
* **service:** cleanup the cryptoprovider config
([#803](opentdf/platform#803))
([1458d17](opentdf/platform@1458d17))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
passion-127 added a commit to passion-127/TDF that referenced this issue Jun 6, 2024
@passion-127 @opentdf-automation
chore(main): release service 0.4.2 (#760)
2aacaa6 
🤖 I have created a release *beep* *boop*
---


##
[0.4.2](opentdf/platform@service/v0.4.1...service/v0.4.2)
(2024-05-15)


### Features

* **docs:** improve serviceregistry doc annotations
([#799](opentdf/platform#799))
([df8a504](opentdf/platform@df8a504))


### Bug Fixes

* **authz:** Adds jwt to context when verified
([#764](opentdf/platform#764))
([7bf6513](opentdf/platform@7bf6513))
* **ci:** Use the correct schema with the provision fixture command
([#794](opentdf/platform#794))
([459e82a](opentdf/platform@459e82a))
* **core:** Bump dep on sdk; reduce go to 1.21
([#815](opentdf/platform#815))
([fe4a5ca](opentdf/platform@fe4a5ca))
* **core:** rollup readiness checks to central health service
([#755](opentdf/platform#755))
([8a65161](opentdf/platform@8a65161)),
closes [#726](opentdf/platform#726)
* **core:** Updates logs statements to log errors
([#796](opentdf/platform#796))
([7a3379b](opentdf/platform@7a3379b))
* **core:** wrong AuthorizationService provided with missing logger
([#791](opentdf/platform#791))
([b13be04](opentdf/platform@b13be04))
* **sdk:** Reduces sdk go requirement to 1.21
([#795](opentdf/platform#795))
([6baee80](opentdf/platform@6baee80))
* **service:** cleanup the cryptoprovider config
([#803](opentdf/platform#803))
([1458d17](opentdf/platform@1458d17))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@strantalis strantalis

Labels
comp:core Core component
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(main): release service 0.4.2 opentdf/platform
1 participant
@strantalis