Skip to content

Commit eb7618b

Browse files
authored
chore(docs): reorganize getting-started section (apache#2611)
1 parent 3e08c90 commit eb7618b

File tree

18 files changed

+564
-34
lines changed

18 files changed

+564
-34
lines changed

site/content/in-dev/unreleased/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Polaris RBAC uses two different role types to delegate privileges:
172172
- **Catalog roles:** Configured with certain privileges on Polaris
173173
catalog resources and granted to principal roles.
174174

175-
For more information, see [Access control]({{% ref "access-control" %}}).
175+
For more information, see [Access control]({{% ref "managing-security/access-control" %}}).
176176

177177
## Legal Notices
178178

site/content/in-dev/unreleased/getting-started/_index.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,23 @@
1717
# specific language governing permissions and limitations
1818
# under the License.
1919
#
20-
title: 'Getting Started'
20+
title: Getting Started with Apache Polaris
21+
linkTitle: Getting Started
2122
type: docs
2223
weight: 101
23-
build:
24-
render: never
2524
---
25+
26+
The fastest way to get started is with our Docker Compose examples. Each example provides a complete working environment with detailed instructions.
27+
28+
## Next Steps
29+
30+
1. Check/Install dependencies
31+
2. Choose the way you want to deploy Polaris
32+
3. Create a catalog
33+
4. Check Using polaris page
34+
35+
## Getting Help
36+
37+
- Documentation: https://polaris.apache.org
38+
- GitHub Issues: https://github.com/apache/polaris/issues
39+
- Slack: [Join Apache Polaris Community](https://join.slack.com/t/apache-polaris/shared_invite/zt-2y3l3r0fr-VtoW42ltir~nSzCYOrQgfw)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Creating a Catalog
21+
linkTitle: Creating a Catalog
22+
type: docs
23+
weight: 300
24+
---
25+
26+
The following Object Storage providers can be configured as storage backends for your Polaris catalog:
27+
28+
- [S3 compatible object stores]({{< ref "s3.md" >}})
29+
- [Google Cloud Storage]({{< ref "catalog-gcs.md" >}})
30+
- [Azure Blob Storage]({{< ref "catalog-azure.md" >}})
31+
- Local file system (By default for testing only)
32+
33+
34+
## Create a catalog using polaris CLI
35+
36+
Check full list of options for the `polaris catalogs create` command [here]({{% ref "../../command-line-interface#create" %}})
37+
38+
### Example
39+
40+
```shell
41+
CLIENT_ID=root \
42+
CLIENT_SECRET=s3cr3t \
43+
DEFAULT_BASE_LOCATION=s3://example-bucket/my_data \
44+
ROLE_ARN=arn:aws:iam::111122223333:role/ExampleCorpRole \
45+
./polaris \
46+
--client-id ${CLIENT_ID} \
47+
--client-secret ${CLIENT_SECRET} \
48+
catalogs \
49+
create \
50+
--storage-type s3 \
51+
--default-base-location ${DEFAULT_BASE_LOCATION} \
52+
--role-arn ${ROLE_ARN} \
53+
my_catalog
54+
```
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Creating a catalog on Azure
21+
linkTitle: Azure
22+
type: docs
23+
weight: 300
24+
---
25+
26+
For the `polaris catalogs create` [command]({{% ref "../../command-line-interface#create" %}}) there are few `azure` only options
27+
28+
```text
29+
--storage-type azure
30+
--tenant-id (Required for Azure) A tenant ID to use when connecting to Azure Storage
31+
--multi-tenant-app-name (Only for Azure) The app name to use when connecting to Azure Storage
32+
--consent-url (Only for Azure) A consent URL granting permissions for the Azure Storage location
33+
```
34+
35+
### example
36+
37+
```shell
38+
CLIENT_ID=root \
39+
CLIENT_SECRET=s3cr3t \
40+
DEFAULT_BASE_LOCATION=abfss://tenant123@blob.core.windows.net \
41+
TENANT_ID=tenant123.onmicrosoft.com \
42+
MULTI_TENANT_APP_NAME=myapp \
43+
CONSENT_URL=https://myapp.com/consent
44+
./polaris \
45+
--client-id ${CLIENT_ID} \
46+
--client-secret ${CLIENT_SECRET} \
47+
catalogs \
48+
create \
49+
--storage-type azure \
50+
--tenant-id ${TENANT_ID} \
51+
--multi-tenant-app-name ${MULTI_TENANT_APP_NAME} \
52+
--consent-url ${CONSENT_URL} \
53+
--default-base-location ${DEFAULT_BASE_LOCATION} \
54+
my_azure_catalog
55+
```
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Creating a catalog on Google Cloud Storage (GCS)
21+
linkTitle: GCS
22+
type: docs
23+
weight: 200
24+
---
25+
26+
For the `polaris catalogs create` [command]({{% ref "../../command-line-interface#create" %}}) there are few `gcs` only options
27+
28+
```text
29+
--storage-type gcs
30+
--service-account (Only for GCS) The service account to use when connecting to GCS
31+
```
32+
33+
### example
34+
35+
```shell
36+
CLIENT_ID=root \
37+
CLIENT_SECRET=s3cr3t \
38+
DEFAULT_BASE_LOCATION=gs://my-ml-bucket/predictions/ \
39+
SERVICE_ACCOUNT=serviceAccount:my-service-account@my-project.iam.gserviceaccount.com \
40+
./polaris \
41+
--client-id ${CLIENT_ID} \
42+
--client-secret ${CLIENT_SECRET} \
43+
catalogs \
44+
create \
45+
--storage-type gcs \
46+
--service-account ${SERVICE_ACCOUNT} \
47+
--default-base-location ${DEFAULT_BASE_LOCATION} \
48+
my_gcs_catalog
49+
```
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Creating a catalog on S3 compatible cloud providers
21+
linkTitle: S3
22+
type: docs
23+
weight: 100
24+
---
25+
26+
The following S3 compatible cloud providers can be configured as storage backends for your Polaris catalog:
27+
28+
- [AWS S3]({{< ref "catalog-aws.md" >}})
29+
- [MinIO]({{< ref "catalog-minio.md" >}})
30+
31+
For the `polaris catalogs create` [command]({{% ref "../../../command-line-interface#create" %}}) there are few `s3` only options
32+
33+
```text
34+
--storage-type s3
35+
--role-arn (Required for S3) A role ARN to use when connecting to S3
36+
--region (Only for S3) The region to use when connecting to S3
37+
--external-id (Only for S3) The external ID to use when connecting to S3
38+
```
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Creating a catalog on AWS S3
21+
linkTitle: AWS
22+
type: docs
23+
weight: 100
24+
---
25+
26+
27+
### example
28+
29+
```shell
30+
CLIENT_ID=root \
31+
CLIENT_SECRET=s3cr3t \
32+
DEFAULT_BASE_LOCATION=s3://example-bucket/my_data \
33+
ROLE_ARN=arn:aws:iam::111122223333:role/ExampleCorpRole \
34+
REGION=us-west-2 \
35+
EXTERNAL_ID=12345678901234567890 \
36+
./polaris \
37+
--client-id ${CLIENT_ID} \
38+
--client-secret ${CLIENT_SECRET} \
39+
catalogs \
40+
create \
41+
--storage-type s3 \
42+
--default-base-location ${DEFAULT_BASE_LOCATION} \
43+
--role-arn ${ROLE_ARN} \
44+
--region ${REGION} \
45+
--external-id ${EXTERNAL_ID} \
46+
my_aws_catalog
47+
```

site/content/in-dev/unreleased/getting-started/minio.md renamed to site/content/in-dev/unreleased/getting-started/creating-a-catalog/s3/catalog-minio.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717
# specific language governing permissions and limitations
1818
# under the License.
1919
#
20-
Title: Deploying Polaris on MinIO
20+
title: Creating a catalog on MinIO
21+
linkTitle: MinIO
2122
type: docs
22-
weight: 350
23+
weight: 200
2324
---
2425

2526
In this guide we walk through setting up a simple Polaris Server with local [MinIO](https://www.min.io/) storage.
@@ -42,7 +43,7 @@ docker compose -f getting-started/minio/docker-compose.yml up
4243
```
4344

4445
The compose script will start MinIO on default ports (API on 9000, UI on 9001)
45-
plus a Polaris Server pre-configured to that MinIO instance.
46+
plus a Polaris Server pre-configured to that MinIO instance.
4647

4748
In this example the `root` principal has its password set to `s3cr3t`.
4849

@@ -86,7 +87,7 @@ mc ls pol/bucket123/ns/t1
8687
[2025-08-13 18:52:38 EDT] 0B metadata/
8788
```
8889

89-
Note: the values of `minio_root`, `m1n1opwd` and `bucket123` are defined in the docker compose file.
90+
Note: the values of `minio_root`, `m1n1opwd` and `bucket123` are defined in the docker compose file.
9091

9192
# Notes on Storage Configuation
9293

site/content/in-dev/unreleased/getting-started/deploying-polaris/_index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
# specific language governing permissions and limitations
1818
# under the License.
1919
#
20-
Title: Deploying Polaris on Cloud Providers
20+
title: Deploying Polaris
21+
linkTitle: Deploying Polaris
2122
type: docs
22-
weight: 300
23+
weight: 200
2324
---
2425

25-
We will now demonstrate how to deploy Polaris locally, as well as with all supported Cloud Providers: Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP).
26+
Here you can find the guides of how to deploy Polaris locally, as well as with all supported Cloud Providers: Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP).
2627

27-
Locally, Polaris can be deployed using both Docker and local build. On the cloud, this tutorial will deploy Polaris using Docker only - but local builds can also be executed.
28+
Locally, Polaris can be deployed using both docker and local build.
29+
On the cloud, the following tutorials will deploy Polaris using docker environment.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
title: Deploying Polaris on Cloud Providers
21+
linkTitle: Cloud Providers
22+
type: docs
23+
weight: 300
24+
---
25+
26+
Polaris can be deployed on various cloud providers, including Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP).
27+
In the following guides, we will walk you through the process of deploying Polaris on each of these cloud providers.

0 commit comments

Comments
 (0)