From e9d95ac5afe9a5a19bd44b0916e39b4ef1f95b54 Mon Sep 17 00:00:00 2001 From: Robert Stupp Date: Mon, 12 Aug 2024 09:49:04 +0200 Subject: [PATCH] replace github url --- .github/ISSUE_TEMPLATE/1-bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/2-feature_request.yml | 2 +- build.gradle.kts | 2 +- docs/configuring-polaris-for-production.md | 6 +++--- docs/index.html | 22 ++++++++++---------- docs/quickstart.md | 2 +- spec/docs.yaml | 4 ++-- spec/index.yaml | 16 +++++++------- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml index a039faadc3..88163ae10b 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -25,7 +25,7 @@ body: - type: markdown attributes: value: | - Verify that the issue is not already reported, looking at the [currently open issues](https://github.com/polaris-catalog/polaris/issues), use the `Filter` field to narrow down your search. + Verify that the issue is not already reported, looking at the [currently open issues](https://github.com/apache/polaris/issues), use the `Filter` field to narrow down your search. Please provide a title above with a short, concise summary - don't leave it "empty". diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml index 63313233c8..d502175ae0 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -25,7 +25,7 @@ body: - type: markdown attributes: value: | - Verify that the feature request is not already reported, looking at the [currently open issues](https://github.com/polaris-catalog/polaris/issues), use the `Filter` field to narrow down your search. + Verify that the feature request is not already reported, looking at the [currently open issues](https://github.com/apache/polaris/issues), use the `Filter` field to narrow down your search. Please provide a title above with a short, concise summary - don't leave it "empty". diff --git a/build.gradle.kts b/build.gradle.kts index 806d1ee4b2..216f3476c9 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -48,7 +48,7 @@ if (System.getProperty("idea.sync.active").toBoolean()) { val img = java.net .URI( - "https://raw.githubusercontent.com/polaris-catalog/polaris/main/docs/img/logos/polaris-brandmark.png" + "https://raw.githubusercontent.com/apache/polaris/main/docs/img/logos/polaris-brandmark.png" ) .toURL() .openConnection() diff --git a/docs/configuring-polaris-for-production.md b/docs/configuring-polaris-for-production.md index cb2dd86d23..e049f764df 100644 --- a/docs/configuring-polaris-for-production.md +++ b/docs/configuring-polaris-for-production.md @@ -34,7 +34,7 @@ Notable configuration used to secure a Polaris deployment are outlined below. > Ensure that the `tokenBroker` setting reflects the token broker specified in `authenticator` below. * Configure [OAuth](https://oauth.net/2/) with this setting. Remove the `TestInlineBearerTokenPolarisAuthenticator` option and uncomment the `DefaultPolarisAuthenticator` authenticator option beneath it. -* Then, configure the token broker. You can configure the token broker to use either [asymmetric](https://github.com/polaris-catalog/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTRSAKeyPair.java#L24) or [symmetric](https://github.com/polaris-catalog/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTSymmetricKeyBroker.java#L23) keys. +* Then, configure the token broker. You can configure the token broker to use either [asymmetric](https://github.com/apache/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTRSAKeyPair.java#L24) or [symmetric](https://github.com/apache/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTSymmetricKeyBroker.java#L23) keys. #### authenticator.tokenBroker @@ -43,14 +43,14 @@ Notable configuration used to secure a Polaris deployment are outlined below. #### callContextResolver & realmContextResolver * Use these configurations to specify a service that can resolve a realm from bearer tokens. -* The service(s) used here must implement the relevant interfaces (i.e. [CallContextResolver](https://github.com/polaris-catalog/polaris/blob/8290019c10290a600e40b35ddb1e2f54bf99e120/polaris-service/src/main/java/io/polaris/service/context/CallContextResolver.java#L27) and [RealmContextResolver](https://github.com/polaris-catalog/polaris/blob/7ce86f10a68a3b56aed766235c88d6027c0de038/polaris-service/src/main/java/io/polaris/service/context/RealmContextResolver.java)). +* The service(s) used here must implement the relevant interfaces (i.e. [CallContextResolver](https://github.com/apache/polaris/blob/8290019c10290a600e40b35ddb1e2f54bf99e120/polaris-service/src/main/java/io/polaris/service/context/CallContextResolver.java#L27) and [RealmContextResolver](https://github.com/apache/polaris/blob/7ce86f10a68a3b56aed766235c88d6027c0de038/polaris-service/src/main/java/io/polaris/service/context/RealmContextResolver.java)). ## Metastore Management > [!IMPORTANT] > The default `in-memory` implementation for `metastoreManager` is meant for testing and not suitable for production usage. Instead, consider an implementation such as `eclipse-link` which allows you to store metadata in a remote database. -A Metastore Manger should be configured with an implementation that durably persists Polaris entities. Use the configuration `metaStoreManager` to configure a [MetastoreManager](https://github.com/polaris-catalog/polaris/blob/627dc602eb15a3258dcc32babf8def34cf6de0e9/polaris-core/src/main/java/io/polaris/core/persistence/PolarisMetaStoreManager.java#L47) implementation where Polaris entities will be persisted. +A Metastore Manger should be configured with an implementation that durably persists Polaris entities. Use the configuration `metaStoreManager` to configure a [MetastoreManager](https://github.com/apache/polaris/blob/627dc602eb15a3258dcc32babf8def34cf6de0e9/polaris-core/src/main/java/io/polaris/core/persistence/PolarisMetaStoreManager.java#L47) implementation where Polaris entities will be persisted. Be sure to secure your metastore backend since it will be storing credentials and catalog metadata. diff --git a/docs/index.html b/docs/index.html index ca2707f812..948ac1984b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -430,7 +430,7 @@ -

Polaris Catalog Documentation

Download OpenAPI specification:Download

Polaris Catalog Documentation

Download OpenAPI specification:Download

Building and Deploying Polaris

Then, use git to clone the Polaris repo:

cd ~
-git clone https://github.com/polaris-catalog/polaris.git
+git clone https://github.com/apache/polaris.git
 

With Docker

If you plan to deploy Polaris inside Docker, you'll need to install docker itself. For example, this can be done using homebrew:

@@ -1994,7 +1994,7 @@

Catalog privileges

</blockquote> <ul> <li>Configure <a href="https://oauth.net/2/">OAuth</a> with this setting. Remove the <code>TestInlineBearerTokenPolarisAuthenticator</code> option and uncomment the <code>DefaultPolarisAuthenticator</code> authenticator option beneath it.</li> -<li>Then, configure the token broker. You can configure the token broker to use either <a href="https://github.com/polaris-catalog/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTRSAKeyPair.java#L24">asymmetric</a> or <a href="https://github.com/polaris-catalog/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTSymmetricKeyBroker.java#L23">symmetric</a> keys.</li> +<li>Then, configure the token broker. You can configure the token broker to use either <a href="https://github.com/apache/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTRSAKeyPair.java#L24">asymmetric</a> or <a href="https://github.com/apache/polaris/blob/b482617bf8cc508b37dbedf3ebc81a9408160a5e/polaris-service/src/main/java/io/polaris/service/auth/JWTSymmetricKeyBroker.java#L23">symmetric</a> keys.</li> </ul> <h4 id="authenticatortokenbroker">authenticator.tokenBroker</h4> <blockquote> @@ -2003,7 +2003,7 @@

Catalog privileges

<h4 id="callcontextresolver--realmcontextresolver">callContextResolver &amp; realmContextResolver</h4> <ul> <li>Use these configurations to specify a service that can resolve a realm from bearer tokens.</li> -<li>The service(s) used here must implement the relevant interfaces (i.e. <a href="https://github.com/polaris-catalog/polaris/blob/8290019c10290a600e40b35ddb1e2f54bf99e120/polaris-service/src/main/java/io/polaris/service/context/CallContextResolver.java#L27">CallContextResolver</a> and <a href="https://github.com/polaris-catalog/polaris/blob/7ce86f10a68a3b56aed766235c88d6027c0de038/polaris-service/src/main/java/io/polaris/service/context/RealmContextResolver.java">RealmContextResolver</a>).</li> +<li>The service(s) used here must implement the relevant interfaces (i.e. <a href="https://github.com/apache/polaris/blob/8290019c10290a600e40b35ddb1e2f54bf99e120/polaris-service/src/main/java/io/polaris/service/context/CallContextResolver.java#L27">CallContextResolver</a> and <a href="https://github.com/apache/polaris/blob/7ce86f10a68a3b56aed766235c88d6027c0de038/polaris-service/src/main/java/io/polaris/service/context/RealmContextResolver.java">RealmContextResolver</a>).</li> </ul> ">

Configurations

Notable configuration used to secure a Polaris deployment are outlined below.

@@ -2013,7 +2013,7 @@

oauth2

  • Configure OAuth with this setting. Remove the TestInlineBearerTokenPolarisAuthenticator option and uncomment the DefaultPolarisAuthenticator authenticator option beneath it.
  • -
  • Then, configure the token broker. You can configure the token broker to use either asymmetric or symmetric keys.
  • +
  • Then, configure the token broker. You can configure the token broker to use either asymmetric or symmetric keys.

authenticator.tokenBroker

@@ -2022,12 +2022,12 @@

authenticator.tokenBroker

callContextResolver & realmContextResolver

Metastore Management

callContextResolver & rea ">

[!IMPORTANT]
The default in-memory implementation for metastoreManager is meant for testing and not suitable for production usage. Instead, consider an implementation such as eclipse-link which allows you to store metadata in a remote database.

-

A Metastore Manger should be configured with an implementation that durably persists Polaris entities. Use the configuration metaStoreManager to configure a MetastoreManager implementation where Polaris entities will be persisted.

+

A Metastore Manger should be configured with an implementation that durably persists Polaris entities. Use the configuration metaStoreManager to configure a MetastoreManager implementation where Polaris entities will be persisted.

Be sure to secure your metastore backend since it will be storing credentials and catalog metadata.

To use EclipseLink for metastore management, specify the configuration metaStoreManager.conf-file to point to an EclipseLink persistence.xml file. This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.

@@ -3568,7 +3568,7 @@

featureConfiguratio " class="sc-euGpHm sc-exayXG fwfkcU jYGAQp">

Generic base server URL, with all parts configurable

{scheme}://{host}:{port}/{basePath}/v1/{prefix}/views/rename

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}