Skip to content

refactor: update readme#69

Merged
g1eny0ung merged 19 commits intohstreamdb:mainfrom
g1eny0ung:refactor/readme
Nov 9, 2023
Merged

refactor: update readme#69
g1eny0ung merged 19 commits intohstreamdb:mainfrom
g1eny0ung:refactor/readme

Conversation

@g1eny0ung
Copy link
Contributor

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.yaml to reduce some non-essential components like console and gateway, etc., to help users bootstrap their cluster straightforwardly.

@g1eny0ung g1eny0ung requested a review from daleiz November 8, 2023 03:40
@g1eny0ung g1eny0ung requested a review from Rory-Z as a code owner November 8, 2023 03:40
@codecov
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (87bf6e0) 82.36% compared to head (853e985) 76.28%.

❗ Current head 853e985 differs from pull request most recent head 9d4a6f4. Consider uploading reports for the commit 9d4a6f4 to get more accurate results

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     
Files Coverage Δ
internal/controller/update_status.go 82.60% <100.00%> (+0.79%) ⬆️

... and 16 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@YangKian
Copy link

YangKian commented Nov 8, 2023

Besides this, I update the config/sample/hstream.yaml to reduce some non-essential components like console and gateway, etc., to help users bootstrap their cluster straightforwardly.

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

@g1eny0ung
Copy link
Contributor Author

Besides this, I update the config/sample/hstream.yaml to reduce some non-essential components like console and gateway, etc., to help users bootstrap their cluster straightforwardly.

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 config/samples/hstreamdb_complete_sample.yaml. I personally recommend users to refer this file to get more information.

@YangKian
Copy link

YangKian commented Nov 8, 2023

Besides this, I update the config/sample/hstream.yaml to reduce some non-essential components like console and gateway, etc., to help users bootstrap their cluster straightforwardly.

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 config/samples/hstreamdb_complete_sample.yaml. I personally recommend users to refer this file to get more information.

keep them in config/samples/hstreamdb_complete_sample.yaml is ok, but please don't remove https://github.com/hstreamdb/hstream-operator/pull/69/files#diff-8267261b164669a62ddb0e6d070d55bc0d0aac041cc7ce740ebd536640d4e828L119-L132, they are useful

@g1eny0ung
Copy link
Contributor Author

keep them in config/samples/hstreamdb_complete_sample.yaml is ok, but please don't remove https://github.com/hstreamdb/hstream-operator/pull/69/files#diff-8267261b164669a62ddb0e6d070d55bc0d0aac041cc7ce740ebd536640d4e828L119-L132, they are useful

@YangKian I saw they are marked deprecated in the future, and using the internal hserver svc is not good. 🤔

Also, the PROMETHEUS_URL lacks docs, is passing in a localhost address available? If not, could you please provide a real-world example, and then I'll append it to this sample.

@YangKian
Copy link

YangKian commented Nov 8, 2023

@YangKian I saw they are marked deprecated in the future

In fact these variables are still being used.

using the internal hserver svc is not good. 🤔

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.

@g1eny0ung
Copy link
Contributor Author

@YangKian Got it. I'll re-add them as original.

@g1eny0ung g1eny0ung merged commit aad4dea into hstreamdb:main Nov 9, 2023
@g1eny0ung g1eny0ung deleted the refactor/readme branch November 9, 2023 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants