feat: dashboard use ip instead of localhost
- issue: https://github.com/GreptimeTeam/gtctl/issues/211
- summary: dashboard link log use ip instead of localhost
Summary by CodeRabbit
-
New Features
- Enhanced logging functionality with a new method for accessing the dashboard.
- Introduced a new utility function to dynamically retrieve the machine's IP address.
-
Improvements
- Increased visibility of the Frontend struct, making it accessible from other packages.
- Improved API usability by aligning method signatures with the new exported struct definition.
-
Refactor
- Adjusted the type of the Frontend component for more specialized functionality within the cluster architecture.
Walkthrough
This update enhances the structure and functionality of the bare metal cluster components. Key modifications include updating the Frontend type for greater specificity, improving logging dynamics in the cluster's wait method, and increasing the visibility of the Frontend struct. A new utility function for resolving hostnames to IP addresses has also been introduced, streamlining operations. Overall, these changes aim to enhance usability and maintainability within the system.
Changes
| Files | Change Summary |
|---|---|
| pkg/cluster/baremetal/cluster.go, pkg/cluster/baremetal/create.go | Changed Frontend field type in ClusterComponents for better specificity, and modified the Wait method to dynamically log dashboard information using PrintDashboardLog(), enhancing logging flexibility. |
| pkg/components/frontend.go | Renamed frontend struct to Frontend for export, updated related methods, and added a new method PrintDashboardLog for improved dashboard logging functionality. |
| pkg/components/utils.go | Introduced HostnameIP function to retrieve the hostname and resolve it to an IP address, enhancing dynamic address retrieval. |
| Makefile | Added an empty line after the help target for improved readability in the Makefile. |
Sequence Diagram(s)
sequenceDiagram
participant Cluster
participant Frontend
participant Logger
Cluster->>Frontend: Wait call
alt Close is false
Frontend->>Logger: PrintDashboardLog()
Logger->>Logger: Log dashboard URL
else Close is true
Logger->>Logger: Log shutdown warning
end
🐇 "In clusters where changes abound,
A frontend shines, no longer bound.
With logs that flow like a stream,
And IPs found in a gleam.
Oh, hop with joy, my friends, and cheer,
For a better code is finally here!"
🌼✨
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (invoked as PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Codecov Report
Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
Project coverage is 40.84%. Comparing base (
ff41601) to head (f2ad33d).
| Files | Patch % | Lines |
|---|---|---|
| pkg/cluster/baremetal/create.go | 0.00% | 1 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## develop #212 +/- ##
========================================
Coverage 40.84% 40.84%
========================================
Files 16 16
Lines 994 994
========================================
Hits 406 406
Misses 483 483
Partials 105 105
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@leaf-potato, just ping you to ask about any progress.