Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode merged PR #4087: URL: https://github.com/apache/polaris/pull/4087 -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on PR #4087: URL: https://github.com/apache/polaris/pull/4087#issuecomment-4167179598 @jbonofre @dimas-b @flyrain mind take another look? -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3019559266 ## site/content/in-dev/unreleased/getting-started/setup-tools.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris +type: docs +weight: 100 Review Comment: This is resolved now. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3019556389 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris +type: docs +weight: 100 +--- + +This guide describes how to use the `setup` command to manage Apache Polaris configuration using an infrastructure-as-code approach. Define your Polaris configuration in a single YAML file and apply it with a single command. + +This command supports bootstrapping new environments and exporting existing configurations for reuse or version control. + +## Exporting Your Configuration + +If you already have an Apache Polaris environment, you can export its current state to a YAML file using the `export` subcommand: + +```bash +polaris setup export > polaris_bootstrap.yaml +``` + +This generates a readable YAML file containing principals, principal roles, catalogs, and their associated namespaces and catalog roles. Review Comment: That is correct. Currently the only non-polaris entity we supported is `namespace` which is created via Iceberg API. The CLI we have currently doesn't support tables/views creation. Also, in my recent PR (https://github.com/apache/polaris/pull/4075), I added some read-only operations around tables/views. It is not hard to add create table but it may not be very useful IMO (as most people are family with those via SQL as oppose to some custom-schema we defined). Views will be a totally different storage as it is not yet interoperable. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3019546414 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris +type: docs +weight: 100 Review Comment: Yeah, I noticed this last night as well. let me update this. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3019544364 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris Review Comment: Updated. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
flyrain commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3017704766 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris Review Comment: `Setup Tools` SGTM. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
dimas-b commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3017500385 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris +type: docs +weight: 100 Review Comment: This clashes with `binary-distribution.md` and `install-dependencies.md` and `managing-polaris.md`, I think... not new to this PR, but I think we can merge "as is" and fix weights later. Still, I think positioning this page right after "Quickstart" is good. ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris Review Comment: How about `Setup Tools`? `Managing Polaris` still makes sense as a section title if/when we have more sub-pages. -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
flyrain commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3017404072 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris +type: docs +weight: 100 +--- + +This guide describes how to use the `setup` command to manage Apache Polaris configuration using an infrastructure-as-code approach. Define your Polaris configuration in a single YAML file and apply it with a single command. + +This command supports bootstrapping new environments and exporting existing configurations for reuse or version control. + +## Exporting Your Configuration + +If you already have an Apache Polaris environment, you can export its current state to a YAML file using the `export` subcommand: + +```bash +polaris setup export > polaris_bootstrap.yaml +``` + +This generates a readable YAML file containing principals, principal roles, catalogs, and their associated namespaces and catalog roles. Review Comment: Just for my information, tables/views are not supported, right? -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
flyrain commented on code in PR #4087: URL: https://github.com/apache/polaris/pull/4087#discussion_r3017399930 ## site/content/in-dev/unreleased/getting-started/managing-polaris.md: ## @@ -0,0 +1,101 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +Title: Managing Polaris Review Comment: Would a name like `Polaris Configuration with the Setup Command` be more suitable? -- 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]
Re: [PR] Add doc for setup command under getting started [polaris]
MonkeyCanCode commented on PR #4087: URL: https://github.com/apache/polaris/pull/4087#issuecomment-4159750588 > Assuming the blog post is immutable, `managing-polaris.md` as a documentation (that can be updated) is a good idea. Thanks for the review. Yes, the blog post should be immutable unless it contains in-correct information (e.g. https://github.com/apache/polaris/pull/3737 which we fixed recently). -- 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]
