-
Notifications
You must be signed in to change notification settings - Fork 227
Docs: Fix the wrong catalog name in using polaris
page
#1471
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: owenowenisme <[email protected]>
using polaris
pageusing polaris
page
Don’t think this is correct, check this:
Can look further into this tomorrow, but in the meantime, please reverify and paste your output that shows this being correctly run without any changes. |
@adnanhemani Thanks for commenting!
The instruction tell us to define a catalog named quickstart_catalog ,so I think that the Sample Command section polaris/site/content/in-dev/unreleased/getting-started/using-polaris.md Lines 187 to 197 in 1fb194e
should also be quickstart_catalog or it will be misleading.
|
There’s a difference between a Spark Catalog and a Polaris Catalog. It makes sense that it can be confusing, so maybe we add a line in the documentation that states that we have added a Spark catalog named “polaris” that points to the “quickstart_catalog” - or change all references in the Spark configs to “quickstart_catalog”. What are your thoughts? cc @adutra, who I believe was the original author of the Dockerfiles where this was named. |
My thought is to change all references in the Spark configs to “quickstart_catalog” since 0.9.0 doc also do it this way. polaris/site/content/in-dev/0.9.0/quickstart.md Lines 284 to 297 in 1fb194e
|
Looking at the invocation,
|
@eric-maynard - yes, that invocation is only for the local Spark setup, however (which from personal experience is very hit or miss on whether folks can set it up or not). For the Docker Spark instructions, the catalog is called
@owenowenisme - I agree with your recommendation. Can you please change the Docker Compose files as well to mirror this |
Signed-off-by: owenowenisme <[email protected]>
@adnanhemani I changed them all in this PR, PTAL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you for this @owenowenisme!!
@@ -174,7 +174,7 @@ Replace the credentials used in the Docker container using the following code: | |||
```shell | |||
USER_CLIENT_ID="XXXX" | |||
USER_CLIENT_SECRET="YYYY" | |||
sed -i "s/^\(.*spark\.sql\.catalog\.polaris\.credential=\).*/\1${USER_CLIENT_ID}:${USER_CLIENT_SECRET}\",/" getting-started/eclipselink/docker-compose.yml | |||
sed -i "s/^\(.*spark\.sql\.catalog\.quickstart_catalog\.credential=\).*/\1${USER_CLIENT_ID}:${USER_CLIENT_SECRET}\",/" getting-started/eclipselink/docker-compose.yml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not relevant to this PR, but I still find this line really scary. This seems like a recipe for someone unknowingly pushing their credentials to GH.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're right!
I can open another PR to use env variable instead.
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you can make it work, then yes please!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll start as soon as this PR is merged.
The SQL command in the "using polaris" page is using the wrong catalog name, it should be
quickstart_catalog
instead ofpolaris
according to the quick start instruction.