You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/command-line-interface.md
+14-16Lines changed: 14 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,23 @@
1
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
2
+
Licensed to the Apache Software Foundation (ASF) under one
3
+
or more contributor license agreements. See the NOTICE file
4
+
distributed with this work for additional information
5
+
regarding copyright ownership. The ASF licenses this file
6
+
to you under the Apache License, Version 2.0 (the
7
+
"License"); you may not use this file except in compliance
8
+
with the License. You may obtain a copy of the License at
10
9
11
10
http://www.apache.org/licenses/LICENSE-2.0
12
11
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
-
12
+
Unless required by applicable law or agreed to in writing,
13
+
software distributed under the License is distributed on an
14
+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
+
KIND, either express or implied. See the License for the
16
+
specific language governing permissions and limitations
17
+
under the License.
20
18
-->
21
19
22
-
# Polaris CLI
20
+
# Apache Polaris (Incubating) CLI
23
21
24
22
In order to help administrators quickly set up and manage their Polaris server, Polaris provides a simple command-line interface (CLI) for common tasks.
Copy file name to clipboardExpand all lines: docs/configuring-polaris-for-production.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,24 @@
1
1
<!--
2
-
Licensed to the Apache Software Foundation (ASF) under one
3
-
or more contributor license agreements. See the NOTICE file
4
-
distributed with this work for additional information
5
-
regarding copyright ownership. The ASF licenses this file
6
-
to you under the Apache License, Version 2.0 (the
7
-
"License"); you may not use this file except in compliance
8
-
with the License. You may obtain a copy of the License at
2
+
Licensed to the Apache Software Foundation (ASF) under one
3
+
or more contributor license agreements. See the NOTICE file
4
+
distributed with this work for additional information
5
+
regarding copyright ownership. The ASF licenses this file
6
+
to you under the Apache License, Version 2.0 (the
7
+
"License"); you may not use this file except in compliance
8
+
with the License. You may obtain a copy of the License at
9
9
10
10
http://www.apache.org/licenses/LICENSE-2.0
11
11
12
-
Unless required by applicable law or agreed to in writing,
13
-
software distributed under the License is distributed on an
14
-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
-
KIND, either express or implied. See the License for the
16
-
specific language governing permissions and limitations
17
-
under the License.
12
+
Unless required by applicable law or agreed to in writing,
13
+
software distributed under the License is distributed on an
14
+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
+
KIND, either express or implied. See the License for the
16
+
specific language governing permissions and limitations
17
+
under the License.
18
18
-->
19
19
20
20
21
-
# Configuring Polaris for Production
21
+
# Configuring Apache Polaris (Incubating) for Production
22
22
23
23
The default `polaris-server.yml` configuration is intended for develoment and testing. When deploying Polaris in production, there are several best practices to keep in mind.
Copy file name to clipboardExpand all lines: docs/overview.md
+34-36Lines changed: 34 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -1,42 +1,40 @@
1
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
2
+
Licensed to the Apache Software Foundation (ASF) under one
3
+
or more contributor license agreements. See the NOTICE file
4
+
distributed with this work for additional information
5
+
regarding copyright ownership. The ASF licenses this file
6
+
to you under the Apache License, Version 2.0 (the
7
+
"License"); you may not use this file except in compliance
8
+
with the License. You may obtain a copy of the License at
10
9
11
10
http://www.apache.org/licenses/LICENSE-2.0
12
11
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
-
12
+
Unless required by applicable law or agreed to in writing,
13
+
software distributed under the License is distributed on an
14
+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
+
KIND, either express or implied. See the License for the
16
+
specific language governing permissions and limitations
17
+
under the License.
20
18
-->
21
19
22
-
Polaris Catalog is a catalog implementation for Apache Iceberg™ tables and is built on the open source Apache Iceberg™ REST protocol.
20
+
Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg™ tables and is built on the open source Apache Iceberg™ REST protocol.
23
21
24
-
With Polaris Catalog, you can provide centralized, secure read and write access to your Iceberg tables across different REST-compatible query engines.
22
+
With Polaris, you can provide centralized, secure read and write access to your Iceberg tables across different REST-compatible query engines.
25
23
26
-

24
+
 overview")
27
25
28
26
## Key concepts
29
27
30
-
This section introduces key concepts associated with using Polaris Catalog.
28
+
This section introduces key concepts associated with using Apache Polaris (Incubating).
31
29
32
-
In the following diagram, a sample [Polaris Catalog structure](overview.md#catalog) with nested [namespaces](overview.md#namespace) is shown for Catalog1. No tables
30
+
In the following diagram, a sample [Apache Polaris (Incubating) structure](overview.md#catalog) with nested [namespaces](overview.md#namespace) is shown for Catalog1. No tables
33
31
or namespaces have been created yet for Catalog2 or Catalog3.
34
32
35
-

33
+
 structure")
36
34
37
35
### Catalog
38
36
39
-
In Polaris Catalog, you can create one or more catalog resources to organize Iceberg tables.
37
+
In Polaris, you can create one or more catalog resources to organize Iceberg tables.
40
38
41
39
Configure your catalog by setting values in the storage configuration for S3, Azure, or Google Cloud Storage. An Iceberg catalog enables a
42
40
query engine to manage and organize tables. The catalog forms the first architectural layer in the [Apache Iceberg™ table specification](https://iceberg.apache.org/spec/#overview) and must support the following tasks:
In an internal catalog, an Iceberg table is registered in Polaris Catalog, but read and written via query engines. The table data and
71
-
metadata is stored in your external cloud storage. The table uses Polaris Catalog as the Iceberg catalog.
68
+
In an internal catalog, an Iceberg table is registered in Polaris, but read and written via query engines. The table data and
69
+
metadata is stored in your external cloud storage. The table uses Polaris as the Iceberg catalog.
72
70
73
71
If you have tables that use Snowflake as the Iceberg catalog (Snowflake-managed tables), you can sync these tables to an external
74
-
catalog in Polaris Catalog. If you sync this catalog to Polaris Catalog, it appears as an external catalog in Polaris Catalog. The table data and
72
+
catalog in Polaris. If you sync this catalog to Polaris, it appears as an external catalog in Polaris. The table data and
75
73
metadata is stored in your external cloud storage. The Snowflake query engine can read from or write to these tables. However, the other query
76
74
engines can only read from these tables.
77
75
@@ -96,14 +94,14 @@ engines can only read from these tables.
96
94
97
95
### Service principal
98
96
99
-
A service principal is an entity that you create in Polaris Catalog. Each service principal encapsulates credentials that you use to connect
100
-
to Polaris Catalog.
97
+
A service principal is an entity that you create in Polaris. Each service principal encapsulates credentials that you use to connect
98
+
to Polaris.
101
99
102
100
Query engines use service principals to connect to catalogs.
103
101
104
-
Polaris Catalog generates a Client ID and Client Secret pair for each service principal.
102
+
Polaris generates a Client ID and Client Secret pair for each service principal.
105
103
106
-
The following table displays example service principals that you might create in Polaris Catalog:
104
+
The following table displays example service principals that you might create in Polaris:
107
105
108
106
| Service connection name | Purpose |
109
107
| --------------------------- | ----------- |
@@ -118,7 +116,7 @@ The following table displays example service principals that you might create in
118
116
A service connection represents a REST-compatible engine (such as Apache Spark™, Apache Flink®, or Trino) that can read from and write to Polaris
119
117
Catalog. When creating a new service connection, the Polaris administrator grants the service principal that is created with the new service
120
118
connection either a new or existing principal role. A principal role is a resource in Polaris that you can use to logically group Polaris
121
-
service principals together and grant privileges on securable objects. For more information, see [Principal role](access-control.md#principal-role"Principal role"). Polaris Catalog uses a role-based access control (RBAC) model to grant service principals access to resources. For more information,
119
+
service principals together and grant privileges on securable objects. For more information, see [Principal role](access-control.md#principal-role"Principal role"). Polaris uses a role-based access control (RBAC) model to grant service principals access to resources. For more information,
122
120
see [Access control](access-control.md"Access control"). For a diagram of this model, see [RBAC model](access-control.md#rbac-model"RBAC model").
123
121
124
122
If the Polaris administrator grants the service principal for the new service connection a new principal role, the service principal
@@ -134,7 +132,7 @@ bestowed to the service principal. For an example of how RBAC works in Polaris,
134
132
### Storage configuration
135
133
136
134
A storage configuration stores a generated identity and access management (IAM) entity for your external cloud storage and is created
137
-
when you create a catalog. The storage configuration is used to set the values to connect Polaris Catalog to your cloud storage. During the
135
+
when you create a catalog. The storage configuration is used to set the values to connect Polaris to your cloud storage. During the
138
136
catalog creation process, an IAM entity is generated and used to create a trust relationship between the cloud storage provider and Polaris
139
137
Catalog.
140
138
@@ -165,27 +163,27 @@ In the following example workflow, Bob creates an Apache Iceberg™ table na
165
163
has the privileges to perform this action. Alice
166
164
creates an unmanaged table in Snowflake to read data from Table1.
167
165
168
-

166
+
")
169
167
170
168
## Security and access control
171
169
172
170
This section describes security and access control.
173
171
174
172
### Credential vending
175
173
176
-
To secure interactions with service connections, Polaris Catalog vends temporary storage credentials to the query engine during query
174
+
To secure interactions with service connections, Polaris vends temporary storage credentials to the query engine during query
177
175
execution. These credentials allow the query engine to run the query without requiring access to your external cloud storage for
178
176
Iceberg tables. This process is called credential vending.
179
177
180
178
### Identity and access management (IAM)
181
179
182
-
Polaris Catalog uses the identity and access management (IAM) entity to securely connect to your storage for accessing table data, Iceberg
183
-
metadata, and manifest files that store the table schema, partitions, and other metadata. Polaris Catalog retains the IAM entity for your
180
+
Polaris uses the identity and access management (IAM) entity to securely connect to your storage for accessing table data, Iceberg
181
+
metadata, and manifest files that store the table schema, partitions, and other metadata. Polaris retains the IAM entity for your
184
182
storage location.
185
183
186
184
### Access control
187
185
188
-
Polaris Catalog enforces the access control that you configure across all tables registered with the service and governs security for all
186
+
Polaris enforces the access control that you configure across all tables registered with the service and governs security for all
189
187
queries from query engines in a consistent manner.
190
188
191
189
Polaris uses a role-based access control (RBAC) model that lets you centrally configure access for Polaris service principals to catalogs,
0 commit comments