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: detail how to mount and use external drivers #449

Merged
merged 19 commits into from
Apr 25, 2024
Merged

Conversation

adwk67
Copy link
Member

@adwk67 adwk67 commented Apr 23, 2024

Description

docs: detail how to mount and use external drivers.
fixes #416.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

Reviewer

Acceptance

@adwk67 adwk67 requested a review from a team April 23, 2024 10:10
@maltesander maltesander self-requested a review April 23, 2024 11:26
Copy link
Member

@maltesander maltesander left a comment

Choose a reason for hiding this comment

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

Just minor things, LGTM otherwise.

@adwk67
Copy link
Member Author

adwk67 commented Apr 23, 2024

@maltesander I have a local integration test for this. What do you think - shall I push that too and just leave it commented out of the test definitions (so it can be activated as necessary)? I wouldn't leave it active as we would either have to upload the mysql driver to Nexus or have an external dependency.

@adwk67 adwk67 requested a review from maltesander April 23, 2024 12:32
@fhennig
Copy link
Contributor

fhennig commented Apr 23, 2024

I wanna look at it more in depth, but already I'd like the fileame to just be database-driver.adoc and also if you could put linebreaks between sentences (so each sentence is on its own line) that would be great!

@maltesander
Copy link
Member

@maltesander I have a local integration test for this. What do you think - shall I push that too and just leave it commented out of the test definitions (so it can be activated as necessary)? I wouldn't leave it active as we would either have to upload the mysql driver to Nexus or have an external dependency.

I dont think its in scope here, but having an integration test (could be an existing one) switching to mysql for testing would be nice :)

fhennig
fhennig previously approved these changes Apr 23, 2024
Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

Just a few things, thanks for documenting this!

docs/modules/hive/pages/required-external-components.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
@adwk67 adwk67 requested a review from fhennig April 23, 2024 14:57
@adwk67 adwk67 enabled auto-merge April 23, 2024 14:57
Copy link
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

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

Thanks for documenting this!
Would you be willing to also document a small Dockerfile that does something like

FROM <our image>
curl -o /stackable/external-drivers/mysql-connector-j-8.0.31.jar" https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.0.31/mysql-connector-j-8.0.31.jar

This should be very easy and help a lot for a lot of customers (that don't have or want ReadWriteMany). IMHO we should also recommend this and only have the PVC part as a last resort but that's just my 2 cents 🙈

docs/modules/hive/pages/usage-guide/database-driver.adoc Outdated Show resolved Hide resolved
@fhennig
Copy link
Contributor

fhennig commented Apr 24, 2024

I think it's a good idea to document the alterantives as well, but it wasn't part of the original scope ofthe ticket. But ideally we'd lay out the options for the users, and then they can decide (Do I want to host an image somewhere? Can I use ReadWriteMany? etc)

@sbernauer
Copy link
Member

I also volunteer to quickly throw the Dockerfile together, I don't want to put the burden on @adwk67. Shall I do that?

@adwk67
Copy link
Member Author

adwk67 commented Apr 24, 2024

I've documented it here 64754ea but couldn't get it to work yet. Maybe we can take a look together @sbernauer ?

@adwk67
Copy link
Member Author

adwk67 commented Apr 25, 2024

ok, got it working now.

@adwk67 adwk67 requested a review from sbernauer April 25, 2024 06:58
Copy link
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

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

I was just able to had a look at this and you pushed the solution.
Many thanks for adding the Dockerfile! It builds on my machine and I assume you tested if the image works against mysql.

@adwk67 adwk67 dismissed maltesander’s stale review April 25, 2024 07:45

Requested changes have been implemented.

@adwk67 adwk67 added this pull request to the merge queue Apr 25, 2024
Merged via the queue into main with commit d0e3d90 Apr 25, 2024
30 checks passed
@adwk67 adwk67 deleted the docs/install-drivers branch April 25, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document driver installation for Hive metastore backend database
4 participants