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.

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

docs(Database): Clarify host value expected when running in docker #28124

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

Carmageddon
Copy link
Contributor

@Carmageddon Carmageddon commented Apr 18, 2024

SUMMARY

When running in Docker locally and attempting to connect to another DB also running in docker, the instructions are not clear enough, to help onboard new users, we should add a note clarifying what the HOST should be.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Apr 18, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@@ -44,6 +44,8 @@ or for the purposes of this walkthrough, you can click the link below all these

<img src={useBaseUrl("/img/tutorial/tutorial_03a_database_connection_string_link.png" )} width="600" />{" "} <br/><br/>

Please note, if you are trying to connect to another locally running database such as Clickhouse (whether on host or another container), and you get the message `The port is closed.`, then you need to adjust the HOST to `host.docker.internal`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there something that's likely Clickhouse-specific here, or would it be best to remove the "such as Clickhouse" to keep it generic?

@rusackas rusackas mentioned this pull request Apr 18, 2024
3 tasks
@john-bodley john-bodley requested a review from sfirke April 18, 2024 17:24
Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to mention Clickhouse, but hey... it's an improvement! Merging :)

Carmageddon and others added 2 commits July 16, 2024 11:51
When running in Docker locally and attempting to connect to another DB also running in docker, the instructions are not clear enough.
@sfirke sfirke merged commit ec508a7 into apache:master Jul 16, 2024
34 checks passed
eschutho pushed a commit that referenced this pull request Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants