Skip to content

Commit f1d50b1

Browse files
authored
Update markdown docs with new project name (apache#197)
1 parent 9fd9c7b commit f1d50b1

11 files changed

+565
-495
lines changed

docs/access-control.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
<!--
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-
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+
10+
http://www.apache.org/licenses/LICENSE-2.0
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.
2018
-->
2119

22-
This section provides information about how access control works for Polaris Catalog.
20+
This section provides information about how access control works for Apache Polaris (Incubating).
2321

24-
Polaris Catalog uses a role-based access control (RBAC) model in which the Polaris administrator assigns access privileges to catalog roles
22+
Polaris uses a role-based access control (RBAC) model in which the Polaris administrator assigns access privileges to catalog roles
2523
and then grants access to resources to service principals by assigning catalog roles to principal roles.
2624

2725
These are the key concepts to understanding access control in Polaris:
@@ -89,11 +87,11 @@ configure in Polaris:
8987

9088
## RBAC model
9189

92-
The following diagram illustrates the RBAC model used by Polaris Catalog. For each catalog, the Polaris administrator assigns access
90+
The following diagram illustrates the RBAC model used by Polaris. For each catalog, the Polaris administrator assigns access
9391
privileges to catalog roles and then grants service principals access to resources by assigning catalog roles to principal roles. Polaris
9492
supports a many-to-one relationship between service principals and principal roles.
9593

96-
![Diagram that shows the RBAC model for Polaris Catalog.](img/rbac-model.svg "Polaris Catalog RBAC model")
94+
![Diagram that shows the RBAC model for Apache Polaris.](img/rbac-model.svg "Apache Polaris RBAC model")
9795

9896
## Access control privileges
9997

@@ -187,4 +185,4 @@ includes the following users:
187185
- The Catalog reader role grants read-only access for a catalog
188186
named Gold zone catalog.
189187

190-
![Diagram that shows an example of how RBAC works in Polaris Catalog.](img/rbac-example.svg "Polaris Catalog RBAC example")
188+
![Diagram that shows an example of how RBAC works in Apache Polaris.](img/rbac-example.svg "Apache Polaris RBAC example")

docs/command-line-interface.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
<!--
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
109
1110
http://www.apache.org/licenses/LICENSE-2.0
1211
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.
2018
-->
2119

22-
# Polaris CLI
20+
# Apache Polaris (Incubating) CLI
2321

2422
In order to help administrators quickly set up and manage their Polaris server, Polaris provides a simple command-line interface (CLI) for common tasks.
2523

docs/configuring-polaris-for-production.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
<!--
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
99
1010
http://www.apache.org/licenses/LICENSE-2.0
1111
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.
1818
-->
1919

2020

21-
# Configuring Polaris for Production
21+
# Configuring Apache Polaris (Incubating) for Production
2222

2323
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.
2424

docs/entities.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
<!--
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
99
1010
http://www.apache.org/licenses/LICENSE-2.0
1111
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.
1818
-->
1919

20-
This page documents various entities that can be managed in Polaris.
20+
This page documents various entities that can be managed in Apache Polaris (Incubating).
2121

2222
## Catalog
2323

docs/index.html

Lines changed: 301 additions & 219 deletions
Large diffs are not rendered by default.

docs/overview.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,40 @@
11
<!--
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
109
1110
http://www.apache.org/licenses/LICENSE-2.0
1211
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.
2018
-->
2119

22-
Polaris Catalog is a catalog implementation for Apache Iceberg&trade; tables and is built on the open source Apache Iceberg&trade; REST protocol.
20+
Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg&trade; tables and is built on the open source Apache Iceberg&trade; REST protocol.
2321

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.
2523

26-
![Conceptual diagram of Polaris Catalog.](img/overview.svg "Polaris Catalog overview")
24+
![Conceptual diagram of Apache Polaris (Incubating).](img/overview.svg "Apache Polaris (Incubating) overview")
2725

2826
## Key concepts
2927

30-
This section introduces key concepts associated with using Polaris Catalog.
28+
This section introduces key concepts associated with using Apache Polaris (Incubating).
3129

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
3331
or namespaces have been created yet for Catalog2 or Catalog3.
3432

35-
![Diagram that shows an example Polaris Catalog structure.](img/sample-catalog-structure.svg "Sample Polaris Catalog structure")
33+
![Diagram that shows an example Apache Polaris (Incubating) structure.](img/sample-catalog-structure.svg "Sample Apache Polaris (Incubating) structure")
3634

3735
### Catalog
3836

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.
4038

4139
Configure your catalog by setting values in the storage configuration for S3, Azure, or Google Cloud Storage. An Iceberg catalog enables a
4240
query engine to manage and organize tables. The catalog forms the first architectural layer in the [Apache Iceberg&trade; table specification](https://iceberg.apache.org/spec/#overview) and must support the following tasks:
@@ -67,11 +65,11 @@ nested namespaces. Iceberg tables belong to namespaces.
6765

6866
### Apache Iceberg&trade; tables and catalogs
6967

70-
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.
7270

7371
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
7573
metadata is stored in your external cloud storage. The Snowflake query engine can read from or write to these tables. However, the other query
7674
engines can only read from these tables.
7775

@@ -96,14 +94,14 @@ engines can only read from these tables.
9694
9795
### Service principal
9896

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.
10199

102100
Query engines use service principals to connect to catalogs.
103101

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.
105103

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:
107105

108106
| Service connection name | Purpose |
109107
| --------------------------- | ----------- |
@@ -118,7 +116,7 @@ The following table displays example service principals that you might create in
118116
A service connection represents a REST-compatible engine (such as Apache Spark&trade;, Apache Flink&reg;, or Trino) that can read from and write to Polaris
119117
Catalog. When creating a new service connection, the Polaris administrator grants the service principal that is created with the new service
120118
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,
122120
see [Access control](access-control.md "Access control"). For a diagram of this model, see [RBAC model](access-control.md#rbac-model "RBAC model").
123121

124122
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,
134132
### Storage configuration
135133

136134
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
138136
catalog creation process, an IAM entity is generated and used to create a trust relationship between the cloud storage provider and Polaris
139137
Catalog.
140138

@@ -165,27 +163,27 @@ In the following example workflow, Bob creates an Apache Iceberg&trade; table na
165163
has the privileges to perform this action. Alice
166164
creates an unmanaged table in Snowflake to read data from Table1.
167165

168-
![Diagram that shows an example workflow for Polaris Catalog](img/example-workflow.svg "Example workflow for Polaris Catalog")
166+
![Diagram that shows an example workflow for Apache Polaris (Incubating)](img/example-workflow.svg "Example workflow for Apache Polaris (Incubating)")
169167

170168
## Security and access control
171169

172170
This section describes security and access control.
173171

174172
### Credential vending
175173

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
177175
execution. These credentials allow the query engine to run the query without requiring access to your external cloud storage for
178176
Iceberg tables. This process is called credential vending.
179177

180178
### Identity and access management (IAM)
181179

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
184182
storage location.
185183

186184
### Access control
187185

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
189187
queries from query engines in a consistent manner.
190188

191189
Polaris uses a role-based access control (RBAC) model that lets you centrally configure access for Polaris service principals to catalogs,

0 commit comments

Comments
 (0)