refactor: update readme#69
refactor: update readme#69g1eny0ung merged 19 commits intohstreamdb:mainfrom g1eny0ung:refactor/readme
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #69 +/- ##
==========================================
- Coverage 82.36% 76.28% -6.08%
==========================================
Files 38 30 -8
Lines 2415 2096 -319
==========================================
- Hits 1989 1599 -390
- Misses 314 416 +102
+ Partials 112 81 -31
☔ View full report in Codecov by Sentry. |
Both console and gateway are required components. If users want to access the cluster from outside of k8s, then they need to establish a connection to the gateway |
Yes, they can be found in |
keep them in |
@YangKian I saw they are marked deprecated in the future, and using the internal hserver svc is not good. 🤔 Also, the |
In fact these variables are still being used.
You can change this to a more appropriate value, maybe the hserver's svc address ? The reason for keeping them is that they can tell the user what environment variables are available to configure that would otherwise need to be looked up elsewhere. Like the prometheus url you mentioned, it just tells the user that prometheus can be configured with this environment variable, of which the address is just an example. |
|
@YangKian Got it. I'll re-add them as original. |
This PR refactors the whole README to give users a glance at the project and how to get a quick start.
Besides this, I update the
config/sample/hstream.yamlto reduce some non-essential components like console and gateway, etc., to help users bootstrap their cluster straightforwardly.