Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions 1.2.0/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ cascade:
params:
show_page_toc: true
# This file will NOT be copied into a new release's versioned docs folder.
robots: noindex
exclude_search: true
---

Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg™ tables and is built on the open source Apache Iceberg™ REST protocol.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/admin-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Admin Tool
type: docs
weight: 300
robots: noindex
exclude_search: true
---

Polaris includes a tool for administrators to manage the metastore.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Command Line Interface
type: docs
weight: 300
robots: noindex
exclude_search: true
---

In order to help administrators quickly set up and manage their Polaris server, Polaris provides a simple command-line interface (CLI) for common tasks.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Configuring Polaris
type: docs
weight: 550
robots: noindex
exclude_search: true
---

## Overview
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/configuring-polaris-for-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Configuring Polaris for Production
linkTitle: Production Configuration
type: docs
weight: 600
robots: noindex
exclude_search: true
---

The default server configuration is intended for development and testing. When you deploy Polaris in production,
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Entities
type: docs
weight: 400
robots: noindex
exclude_search: true
---

This page documents various entities that can be managed in Apache Polaris (Incubating).
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/evolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Polaris Evolution
type: docs
weight: 1000
robots: noindex
exclude_search: true
---

This page discusses what can be expected from Apache Polaris as the project evolves.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/federation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Federation
type: docs
weight: 703
robots: noindex
exclude_search: true
---

Guides for federating Polaris with existing metadata services. Expand this section to select a
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/federation/hive-metastore-federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Hive Metastore Federation
type: docs
weight: 705
robots: noindex
exclude_search: true
---

Polaris can federate catalog operations to an existing Hive Metastore (HMS). This lets an external
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/federation/iceberg-rest-federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Iceberg REST Federation
type: docs
weight: 704
robots: noindex
exclude_search: true
---

Polaris can federate an external Iceberg REST catalog (e.g., another Polaris deployment, AWS Glue, or a custom Iceberg
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/generic-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Generic Table (Beta)
type: docs
weight: 435
robots: noindex
exclude_search: true
---

The Generic Table in Apache Polaris is designed to provide support for non-Iceberg tables across different table formats includes delta, csv etc. It currently provides the following capabilities:
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Getting Started with Apache Polaris
linkTitle: Getting Started
type: docs
weight: 101
robots: noindex
exclude_search: true
---

The fastest way to get started is with our Docker Compose examples. Each example provides a complete working environment with detailed instructions.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/creating-a-catalog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a Catalog
linkTitle: Creating a Catalog
type: docs
weight: 300
robots: noindex
exclude_search: true
---

The following Object Storage providers can be configured as storage backends for your Polaris catalog:
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/getting-started/creating-a-catalog/catalog-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a catalog on Azure
linkTitle: Azure
type: docs
weight: 300
robots: noindex
exclude_search: true
---

For the `polaris catalogs create` [command]({{% ref "../../command-line-interface#create" %}}) there are few `azure` only options
Expand Down Expand Up @@ -52,4 +54,4 @@ CONSENT_URL=https://myapp.com/consent
--consent-url ${CONSENT_URL} \
--default-base-location ${DEFAULT_BASE_LOCATION} \
my_azure_catalog
```
```
4 changes: 3 additions & 1 deletion 1.2.0/getting-started/creating-a-catalog/catalog-gcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a catalog on Google Cloud Storage (GCS)
linkTitle: GCS
type: docs
weight: 200
robots: noindex
exclude_search: true
---

For the `polaris catalogs create` [command]({{% ref "../../command-line-interface#create" %}}) there are few `gcs` only options
Expand All @@ -46,4 +48,4 @@ SERVICE_ACCOUNT=serviceAccount:my-service-account@my-project.iam.gserviceaccount
--service-account ${SERVICE_ACCOUNT} \
--default-base-location ${DEFAULT_BASE_LOCATION} \
my_gcs_catalog
```
```
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/creating-a-catalog/s3/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a catalog on S3 compatible cloud providers
linkTitle: S3
type: docs
weight: 100
robots: noindex
exclude_search: true
---

The following S3 compatible cloud providers can be configured as storage backends for your Polaris catalog:
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/getting-started/creating-a-catalog/s3/catalog-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a catalog on AWS S3
linkTitle: AWS
type: docs
weight: 100
robots: noindex
exclude_search: true
---

When creating a catalog based on AWS S3 storage only the `role-arn` is a required parameter. However, usually
Expand Down Expand Up @@ -49,4 +51,4 @@ EXTERNAL_ID=12345678901234567890
--region ${REGION} \
--external-id ${EXTERNAL_ID} \
quickstart_catalog
```
```
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/creating-a-catalog/s3/catalog-minio.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Creating a catalog on MinIO
linkTitle: MinIO
type: docs
weight: 200
robots: noindex
exclude_search: true
---

When creating a catalog based on MinIO storage it is important to configure the `endpoint` property to point
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/deploying-polaris/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris
linkTitle: Deploying Polaris
type: docs
weight: 200
robots: noindex
exclude_search: true
---

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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris on Cloud Providers
linkTitle: Cloud Providers
type: docs
weight: 300
robots: noindex
exclude_search: true
---

Polaris can be deployed on various cloud providers, including Amazon Web Services (AWS), Azure, and Google Cloud Platform (GCP).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris on Amazon Web Services (AWS)
linkTitle: AWS
type: docs
weight: 310
robots: noindex
exclude_search: true
---

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris on Azure
linkTitle: Azure
type: docs
weight: 320
robots: noindex
exclude_search: true
---

Build and launch Polaris using the Azure 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris on Google Cloud Platform (GCP)
linkTitle: GCP
type: docs
weight: 330
robots: noindex
exclude_search: true
---

Build and launch Polaris using the GCP 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.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/deploying-polaris/local-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Deploying Polaris locally
linkTitle: Local deployment
type: docs
weight: 200
robots: noindex
exclude_search: true
---

Polaris can be deployed via a docker image or as a standalone process. Before starting, be sure that you've satisfied the relevant prerequisites detailed in the previous page.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/install-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Installing Dependencies
type: docs
weight: 100
robots: noindex
exclude_search: true
---

This guide serves as an introduction to several key entities that can be managed with Apache Polaris (Incubating), describes how to build and deploy Polaris locally, and finally includes examples of how to use Polaris with Apache Spark™.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/using-polaris/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Using Polaris
type: docs
weight: 401
robots: noindex
exclude_search: true
---

## Setup
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/getting-started/using-polaris/keycloak-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Getting Started with Apache Polaris, External Authentication and Keycloak
linkTitle: Using Keycloak IDP
type: docs
weight: 400
robots: noindex
exclude_search: true
---

## Overview
Expand Down Expand Up @@ -209,4 +211,4 @@ curl -v http://localhost:8181/api/management/v1/catalogs \
-H 'Accept: application/json'
```

This will return a `401 Unauthorized` error because the token is not valid for the `realm-internal` realm.
This will return a `401 Unauthorized` error because the token is not valid for the `realm-internal` realm.
2 changes: 2 additions & 0 deletions 1.2.0/getting-started/using-polaris/telemetry-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Getting Started with Apache Polaris, Prometheus and Jaeger
linkTitle: Using Polaris with telemetry tools
type: docs
weight: 401
robots: noindex
exclude_search: true
---

This example requires `jq` to be installed on your machine.
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Polaris Helm Chart
type: docs
weight: 675
robots: noindex
exclude_search: true
---

<!---
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/managing-security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ title: Managing Security
linkTitle: Managing Security
type: docs
weight: 550
robots: noindex
exclude_search: true
---

## [Access Control]({{< relref "access-control" >}})

## [Authentification and Identity Providers]({{< relref "external-idp" >}})
## [Authentification and Identity Providers]({{< relref "external-idp" >}})
2 changes: 2 additions & 0 deletions 1.2.0/managing-security/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Role-Based Access Control
linkTitle: Access Control
type: docs
weight: 200
robots: noindex
exclude_search: true
---

This section provides information about how access control works for Apache Polaris (Incubating).
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/managing-security/external-idp/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Identity Providers
linkTitle: Identity Providers
type: docs
weight: 300
robots: noindex
exclude_search: true
---

Apache Polaris supports authentication via external identity providers (IdPs) using OpenID Connect (OIDC) in addition to the internal authentication system. This feature enables flexible identity federation with enterprise IdPs and allows gradual migration or hybrid authentication strategies across realms in Polaris.
Expand Down Expand Up @@ -252,4 +254,4 @@ See more examples below.
### Additional Links

* For complete Keycloak integration example, see: [Keycloak External IDP Configuration Guide]({{< relref "../../getting-started/using-polaris/keycloak-idp.md" >}})
* See [Developer Notes]({{< relref "idp-dev-notes.md" >}}) with internal implementation details for developers who want to understand or extend Polaris authentication.
* See [Developer Notes]({{< relref "idp-dev-notes.md" >}}) with internal implementation details for developers who want to understand or extend Polaris authentication.
2 changes: 2 additions & 0 deletions 1.2.0/managing-security/external-idp/idp-dev-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ title: Authentification Development Details
linkTitle: Development Details
type: docs
weight: 301
robots: noindex
exclude_search: true
---

## Developer Architecture Notes
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/metastores.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Metastores
type: docs
weight: 700
robots: noindex
exclude_search: true
---

This page explains how to configure and use Polaris metastores with either the recommended Relational JDBC or the
Expand Down
4 changes: 3 additions & 1 deletion 1.2.0/polaris-api-specs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@
title: 'Polaris API Reference'
type: docs
weight: 1100
robots: noindex
exclude_search: true
---

The Apache Polaris API offers a comprehensive set of endpoints that enable you to manage principals, principal-roles, catalogs, and catalog-roles programmatically.

It follows REST standards, using clear, resource-based URLs, standard HTTP methods, response codes, and secure authentication. With the Polaris API, you can create, manage, and query Iceberg catalogs efficiently.
It follows REST standards, using clear, resource-based URLs, standard HTTP methods, response codes, and secure authentication. With the Polaris API, you can create, manage, and query Iceberg catalogs efficiently.
2 changes: 2 additions & 0 deletions 1.2.0/polaris-api-specs/polaris-catalog-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ linkTitle: 'Catalog API ↗'
weight: 200
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

{{< redoc-polaris "generated/bundled-polaris-catalog-service.yaml" >}}
2 changes: 2 additions & 0 deletions 1.2.0/polaris-api-specs/polaris-management-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ linkTitle: 'Management API ↗'
weight: 100
params:
show_page_toc: false
robots: noindex
exclude_search: true
---

{{< redoc-polaris "polaris-management-service.yml" >}}
2 changes: 2 additions & 0 deletions 1.2.0/polaris-spark-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
Title: Polaris Spark Client
type: docs
weight: 650
robots: noindex
exclude_search: true
---

Apache Polaris now provides Catalog support for Generic Tables (non-Iceberg tables), please check out
Expand Down
2 changes: 2 additions & 0 deletions 1.2.0/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
title: Policy
type: docs
weight: 425
robots: noindex
exclude_search: true
---

The Polaris Policy framework empowers organizations to centrally define, manage, and enforce fine-grained governance, lifecycle, and operational rules across all data resources in the catalog.
Expand Down
Loading