adnanhemani commented on code in PR #1367: URL: https://github.com/apache/polaris/pull/1367#discussion_r2045251093
########## getting-started/eclipselink/docker-compose-bootstrap-db.yml: ########## Review Comment: I would say not - this is also a Docker Compose file that's necessary to the Getting Started flow. And I'd say it's better to keep all Docker Compose files in the same subdirectory. ########## site/content/in-dev/unreleased/getting-started/install-dependencies.md: ########## @@ -0,0 +1,118 @@ +--- +# +# 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: Installing Dependencies +type: docs +weight: 100 Review Comment: These are defined by us - they're what sorts the pages into whatever order we'd want (the larger the number, the further back it will be in the overall order). 112 is an odd number, let me look at that one again. Update: I've changed those to 310/320/330 now in alignment with the overall section being a weight of 300 within the "Getting Started" section. ########## site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md: ########## @@ -0,0 +1,48 @@ +--- +# +# 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: Deploying Polaris on Google Cloud Platform (GCP) +type: docs +weight: 112 +--- + +Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start a [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) instance, which will be used as the backend Postgres instance holding all Polaris data. +Additionally, Polaris will be bootstrapped to use this database and Docker containers will be spun up for Spark SQL and Trino. + +The requirements to run the script below are: +* Install the `gcloud` CLI, if it is not already installed on the GCP VM. Instructions to download the `gcloud` CLI can be found [here](https://cloud.google.com/sdk/docs/install). +* Ensure the `Cloud SQL Admin API` has been enabled in your project and that your VM's Principal has access to the correct role: `roles/cloudsql.admin`. + +```shell +chmod +x getting-started/assets/cloud_providers/deploy-gcp.sh +./getting-started/assets/cloud_providers/deploy-gcp.sh +``` + +Also, set the following static credentials for interacting with the Polaris server in the following exercises: + +```shell +export CLIENT_ID=root +export CLIENT_SECRET=s3cr3t +``` + +To take down the Polaris server, run the following commands: Review Comment: Done. ########## site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md: ########## @@ -0,0 +1,48 @@ +--- +# +# 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: Deploying Polaris on Azure +type: docs +weight: 112 +--- + +Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start an [Azure Database for PostgreSQL - Flexible Server](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/overview) instance, which will be used as the backend Postgres instance holding all Polaris data. +Additionally, Polaris will be bootstrapped to use this database and Docker containers will be spun up for Spark SQL and Trino. + +The requirements to run the script below are: +* Install the AZ CLI, if it is not already installed on the Azure VM. Instructions to download the AZ CLI can be found [here](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli). +* You must be logged into the AZ CLI. Please run `az account show` to ensure that you are logged in prior to running this script. + +```shell +chmod +x getting-started/assets/cloud_providers/deploy-azure.sh +./getting-started/assets/cloud_providers/deploy-azure.sh +``` + +Also, set the following static credentials for interacting with the Polaris server in the following exercises: + +```shell +export CLIENT_ID=root +export CLIENT_SECRET=s3cr3t +``` + +To take down the Polaris server, run the following commands: Review Comment: Done. ########## site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md: ########## @@ -0,0 +1,52 @@ +--- +# +# 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: Deploying Polaris on Amazon Web Services (AWS) +type: docs +weight: 112 +--- + +Build and launch Polaris using the AWS Startup Script at the location provided in the command below. This script will start an [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/) instance, which will be used as the backend Postgres instance holding all Polaris data. +Additionally, Polaris will be bootstrapped to use this database and Docker containers will be spun up for Spark SQL and Trino. + +The requirements to run the script below are: +* There must be at least two subnets created in the VPC and region in which your EC2 instance reside. The span of subnets MUST include at least 2 availability zones (AZs) within the same region. +* The AWS identity that you will use to run this script must have the following AWS permissions: + * "ec2:DescribeInstances" + * "rds:CreateDBInstance" + * "rds:DescribeDBInstances" + * "rds:CreateDBSubnetGroup" + +```shell +chmod +x getting-started/assets/cloud_providers/deploy-aws.sh +./getting-started/assets/cloud_providers/deploy-aws.sh +``` + +Also, set the following static credentials for interacting with the Polaris server in the following exercises: + +```shell +export CLIENT_ID=root +export CLIENT_SECRET=s3cr3t +``` + +To take down the Polaris server, run the following commands: Review Comment: Done. ########## site/content/in-dev/unreleased/getting-started/deploying-polaris/_index.md: ########## @@ -0,0 +1,27 @@ +--- +# +# 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: Deploying Polaris on Cloud Providers +type: docs +weight: 300 +--- + +In this Quick Start flow, we will demonstrate how to deploy Polaris locally, as well as with all supported Cloud Providers: Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP). Review Comment: Sorry, that's a hangover from the restructuring - changed. Thanks for catching! ########## site/content/in-dev/unreleased/getting-started/deploying-polaris/_index.md: ########## @@ -0,0 +1,27 @@ +--- +# +# 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: Deploying Polaris on Cloud Providers +type: docs +weight: 300 +--- + +In this Quick Start flow, we will demonstrate how to deploy Polaris locally, as well as with all supported Cloud Providers: Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP). Review Comment: Thanks, changed everywhere. -- 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]
