trinodb / trino

Official repository of Trino, the distributed SQL query engine for big data, formerly known as PrestoSQL (https://trino.io)
https://trino.io
Apache License 2.0
9.88k stars 2.86k forks source link

Adding Notes/Warnings for Catalog Installation in Docker 🐳 #12494

Open kemalty opened 2 years ago

kemalty commented 2 years ago

What

This issue proposes adding some notes or warnings in the existing document pages for configuring connectors in Docker environment.

Why

The catalog configuration/installation is different for tarball than Docker image. For tarball, the catalog files are expected in /usr/lib/trino/etc/. For Docker, they are expected in /etc/trino/.

This change seems to be introduced in https://github.com/trinodb/trino/pull/6497. Before the change, both Docker and tarball were expecting the catalog files in the same directory. This change introduced discrepancy between the tarball and Docker configuration, while the docs are still only for tarball installation/configuration.

The change and lack of warnings/mentions on the difference between Docker and tarball lost me quite some time. I could only resolve the issue with the help of a community member in [Slack] (https://trinodb.slack.com/archives/CGB0QHWSW/p1652278657730469).

How

I propose to add a note or warning in connector pages for Docker configuration. While this could be an easy fix for the issue, it requires adding this note or warning for all the connectors.

I am happy to discuss and contribute on this 👍

See also

mosabua commented 2 years ago

You assumption that there is a fixed folder for tarball installation is wrong. The folder for catalog files is etc/catalog inside wherever you extract and use the tarball. All documentation is based on the tarball and the relative folder setup. Not just for catalogs but also for other config and log files and binaries and so on.

It makes no sense to put warning notes about a specific packaging all across the docs. Instead we should create a separate page about docker installation and usage a well as another one for the k8s helm chart usage.

mosabua commented 2 years ago

Also ... if we mention docker everywhere ... why not mention the RPM as well. And explicitly call out the relative native ...

kemalty commented 2 years ago

Fair point I think 👍

Instead we should create a separate page about docker installation and usage a well as another one for the k8s helm chart usage.

I am happy to start this page. Any pointers where this page should be and what it should consist of? Should it be more in a tutorial tone?

mosabua commented 2 years ago

You can look at https://docs.starburst.io/starburst-enterprise/try/docker.html and do something similar

mosabua commented 2 years ago

here is the source .. that might help as well. https://github.com/trinodb/docker-images