adnanhemani commented on code in PR #4627: URL: https://github.com/apache/polaris/pull/4627#discussion_r3376526659
########## site/content/in-dev/unreleased/getting-started/binary-distribution.md: ########## @@ -52,3 +59,13 @@ You can verify the server is running by checking the health endpoint: ```bash curl http://localhost:8182/q/health ``` + +## Installing the CLI + +Install the Polaris CLI from PyPI: + +```bash +pip install apache-polaris +``` + +The `polaris` command will then be available in your shell. See [Using Polaris]({{% ref "using-polaris" %}}) for usage examples. Review Comment: Yes, so the thought process here was that if you are building Polaris from scratch locally, then we should still support the quickstart guide through the `./polaris` shell script. In all other cases, the PyPI package should be the right way to navigate the guide. What is your thought on this? How would we best support this model - or do you disagree with the model altogether? ########## site/content/guides/jdbc/docker-compose.yml: ########## @@ -84,13 +86,13 @@ services: /opt/spark/bin/spark-sql, --packages, "org.apache.iceberg:iceberg-spark-runtime-3.5_2.12:1.10.1,org.apache.iceberg:iceberg-aws-bundle:1.10.1,org.apache.iceberg:iceberg-gcp-bundle:1.10.1,org.apache.iceberg:iceberg-azure-bundle:1.10.1", --conf, "spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions", - --conf, "spark.sql.catalog.polaris=org.apache.iceberg.spark.SparkCatalog", - --conf, "spark.sql.catalog.polaris.type=rest", - --conf, "spark.sql.catalog.polaris.warehouse=quickstart_catalog", - --conf, "spark.sql.catalog.polaris.uri=http://polaris:8181/api/catalog";, - --conf, "spark.sql.catalog.polaris.credential=root:s3cr3t", - --conf, "spark.sql.catalog.polaris.scope=PRINCIPAL_ROLE:ALL", - --conf, "spark.sql.defaultCatalog=polaris", + --conf, "spark.sql.catalog.quickstart_catalog=org.apache.iceberg.spark.SparkCatalog", Review Comment: This is one of the major pain-points I've ran into when introducing new users to the quickstart guide is that in some places we've told them to create "polaris" as the catalog and other places, it is "quickstart_catalog". For someone who is relatively new to this space, the OOTB experience is very frustrating - and debugging this issue requires some background information that not all users have. That's why I'm proposing to make this change and standardize. If there are other places where this change needs to be made, please do point them out to me and I can include them in this PR. ########## site/content/guides/jdbc/docker-compose.yml: ########## @@ -102,6 +104,8 @@ services: condition: service_completed_successfully stdin_open: true tty: true + extra_hosts: Review Comment: So this becomes an issue if we are using a local build version of Polaris (so it's attached to the machine's networking plane) but then use Docker images (uses Docker's networking plane) to setup and use Trino. That's why I've introduced this so that the cross-usage between the networking planes can work. Any concerns? ########## site/content/in-dev/unreleased/getting-started/using-polaris/_index.md: ########## @@ -44,7 +44,7 @@ Additionally, if Polaris is running somewhere other than `localhost:8181`, you c ### Creating a Principal and Assigning it Privileges -With a catalog created, we can create a [principal]({{% relref "../../entities#principal" %}}) that has access to manage that catalog. For details on how to configure the Polaris CLI, see [the section above](#defining-a-catalog) or refer to the [docs]({{% relref "../../command-line-interface" %}}). +With a catalog created, we can create a [principal]({{% relref "../../entities#principal" %}}) that has access to manage that catalog. For details on how to configure the Polaris CLI, see the [Creating a Catalog]({{% ref "../creating-a-catalog" %}}) page or refer to the [docs]({{% relref "../../command-line-interface" %}}). Review Comment: Great catch! Pushing change now. ########## site/content/in-dev/unreleased/getting-started/using-polaris/_index.md: ########## @@ -44,7 +44,7 @@ Additionally, if Polaris is running somewhere other than `localhost:8181`, you c ### Creating a Principal and Assigning it Privileges -With a catalog created, we can create a [principal]({{% relref "../../entities#principal" %}}) that has access to manage that catalog. For details on how to configure the Polaris CLI, see [the section above](#defining-a-catalog) or refer to the [docs]({{% relref "../../command-line-interface" %}}). +With a catalog created, we can create a [principal]({{% relref "../../entities#principal" %}}) that has access to manage that catalog. For details on how to configure the Polaris CLI, see the [Creating a Catalog]({{% ref "../creating-a-catalog" %}}) page or refer to the [docs]({{% relref "../../command-line-interface" %}}). Review Comment: Good catch! Fixed in 36fd8c3 — both occurrences changed to `relref` for consistency with the rest of the file. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
