HonahX commented on code in PR #2761: URL: https://github.com/apache/polaris/pull/2761#discussion_r2422228572
########## site/content/in-dev/unreleased/federation/iceberg-rest-federation.md: ########## @@ -0,0 +1,77 @@ +--- +# +# 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: Iceberg REST Federation +type: docs +weight: 704 +--- + +Polaris can front an external Iceberg REST catalog so that existing metadata services (another +Polaris deployment, Nessie, or a custom Iceberg REST implementation) gain OAuth-protected access +control and multi-engine routing through the Polaris API surface. + +## Runtime requirements + +- **REST endpoint:** The remote service must expose the Iceberg REST specification. Configure + firewalls so Polaris can reach the base URI you provide in the connection config. +- **Authentication:** Polaris forwards requests using the credentials defined in + `connectionConfigInfo.authenticationParameters`. OAuth2 client credentials, bearer tokens, and AWS + SigV4 are supported; choose the scheme the remote service expects. +- **Service identity (SigV4 only):** When using SigV4, set `polaris.service-identity.<realm>.aws-iam.*` + so Polaris can assume the IAM role referenced by the connection’s `serviceIdentity` block. + +## Creating a federated REST catalog + +The snippet below registers an external catalog that forwards to a remote Polaris server using OAuth2 +client credentials. `remoteCatalogName` is optional; supply it when the remote server multiplexes +multiple logical catalogs under one URI. + +```bash +polaris catalogs create \ + --name analytics_rest \ + --type EXTERNAL \ + --storage-type S3 \ + --role-arn "arn:aws:iam::123456789012:role/polaris-warehouse-access" \ + --default-base-location "s3://analytics-bucket/warehouse/" \ + --catalog-connection-type ICEBERG \ + --catalog-uri "https://remote-polaris.example.com/catalog/v1"; \ + --remote-catalog-name analytics \ + --catalog-authentication-type OAUTH \ + --catalog-token-uri "https://remote-polaris.example.com/catalog/v1/oauth/tokens"; \ + --catalog-client-id <remote-client-id> \ + --catalog-client-secret "<remote-secret>" \ + --catalog-client-scopes "PRINCIPAL_ROLE:ALL" +``` + Review Comment: Could we add a link here to our Command Line Interface page for reference? -- 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]
