Skip to content

Commit 30acee6

Browse files
Fix hugo blockquote (#1967)
* Fix hugo blockquote * Add license header
1 parent 7d03992 commit 30acee6

20 files changed

+142
-88
lines changed

site/content/in-dev/unreleased/_index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ cascade:
3131
# This file will NOT be copied into a new release's versioned docs folder.
3232
---
3333

34-
{{< alert title="Warning" color="warning" >}}
35-
These pages refer to the current state of the main branch, which is still under active development.
36-
37-
Functionalities can be changed, removed or added without prior notice.
38-
{{< /alert >}}
34+
> [!WARNING]
35+
> These pages refer to the current state of the main branch, which is still under active development.
36+
>
37+
> Functionalities can be changed, removed or added without prior notice.
3938
4039
Apache Polaris (Incubating) is a catalog implementation for Apache Iceberg&trade; tables and is built on the open source Apache Iceberg&trade; REST protocol.
4140

@@ -83,8 +82,7 @@ A catalog is configured with a storage configuration that can point to S3, Azure
8382
You create *namespaces* to logically group Iceberg tables within a catalog. A catalog can have multiple namespaces. You can also create
8483
nested namespaces. Iceberg tables belong to namespaces.
8584

86-
> **Important**
87-
>
85+
> [!Important]
8886
> For the access privileges defined for a catalog to be enforced correctly, the following conditions must be met:
8987
>
9088
> - The directory only contains the data files that belong to a single table.

site/content/in-dev/unreleased/access-control.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ in the catalog, such as catalog namespaces or tables. You can create one or more
7272
You grant privileges to a catalog role and then grant the catalog role to a principal role to bestow the privileges to one or more service
7373
principals.
7474

75-
> **Note**
76-
>
75+
> [!NOTE]
7776
> If you update the privileges bestowed to a service principal, the updates won't take effect for up to one hour. This means that if you
7877
> revoke or grant some privileges for a catalog, the updated privileges won't take effect on any service principal with access to that catalog
7978
> for up to one hour.
@@ -104,9 +103,8 @@ This section describes the privileges that are available in the Polaris access c
104103
roles are granted to principal roles, and principal roles are granted to service principals to specify the operations that service principals can
105104
perform on objects in Polaris.
106105

107-
> **Important**
108-
>
109-
> You can only grant privileges at the catalog level. Fine-grained access controls are not available. For example, you can grant read
106+
> [!IMPORTANT]
107+
> You can only grant privileges at the catalog level. Fine-grained access controls are not available. For example, you can grant read
110108
> privileges to all tables in a catalog but not to an individual table in the catalog.
111109
112110
To grant the full set of privileges (drop, list, read, write, etc.) on an object, you can use the *full privilege* option.
@@ -184,7 +182,7 @@ includes the following users:
184182
create service principals. She can also create catalogs and
185183
namespaces and configure access control for Polaris resources.
186184

187-
- **Bob:** A data engineer who uses Apache Spark&trade; to
185+
- **Bob:** A data engineer who uses Apache Spark&trade; to
188186
interact with Polaris.
189187

190188
- Alice has created a service principal for Bob. It has been

site/content/in-dev/unreleased/admin-tool.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,9 @@ java -jar runtime/admin/build/polaris-admin-*-runner.jar bootstrap -r realm1 -c
117117

118118
The `purge` command is used to remove realms and principal credentials from the Polaris server.
119119

120-
> Warning: Running the `purge` command will remove all data associated with the specified realms!
121-
This includes all entities (catalogs, namespaces, tables, views, roles), all principal
120+
> [!WARNING]
121+
> Running the `purge` command will remove all data associated with the specified realms!
122+
This includes all entities (catalogs, namespaces, tables, views, roles), all principal
122123
credentials, grants, and any other data associated with the realms.
123124

124125
```shell
@@ -139,4 +140,4 @@ For example, to purge the `realm1` realm, you can run the following command:
139140

140141
```shell
141142
java -jar runtime/admin/build/polaris-admin-*-runner.jar purge -r realm1
142-
```
143+
```

site/content/in-dev/unreleased/command-line-interface.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ options:
4848
6. privileges
4949
7. profiles
5050

51-
Each _command_ supports several _subcommands_, and some _subcommands_ have _actions_ that come after the subcommand in turn. Finally, _arguments_ follow to form a full invocation. Within a set of named arguments at the end of an invocation ordering is generally not important. Many invocations also have a required positional argument of the type that the _command_ refers to. Again, the ordering of this positional argument relative to named arguments is not important.
51+
Each _command_ supports several _subcommands_, and some _subcommands_ have _actions_ that come after the subcommand in turn. Finally, _arguments_ follow to form a full invocation. Within a set of named arguments at the end of an invocation ordering is generally not important. Many invocations also have a required positional argument of the type that the _command_ refers to. Again, the ordering of this positional argument relative to named arguments is not important.
5252

5353
Some example full invocations:
5454

@@ -159,7 +159,7 @@ polaris catalogs create \
159159
--allowed-location s3://other-bucket/third_location \
160160
--role-arn ${ROLE_ARN} \
161161
my_other_catalog
162-
162+
163163
polaris catalogs create \
164164
--storage-type file \
165165
--default-base-location file:///example/tmp \
@@ -250,7 +250,7 @@ polaris catalogs update --default-base-location s3://new-bucket/my_data my_catal
250250

251251
### Principals
252252

253-
The `principals` command is used to manage principals within Polaris.
253+
The `principals` command is used to manage principals within Polaris.
254254

255255
`principals` supports the following subcommands:
256256

@@ -572,7 +572,7 @@ The catalog-roles command is used to create, discover, and manage catalog roles
572572
4. list
573573
5. update
574574
6. grant
575-
7. revoke
575+
7. revoke
576576

577577
#### create
578578

@@ -734,7 +734,7 @@ polaris catalog-roles revoke --catalog sales_data contains_cc_info_catalog_role
734734

735735
### Namespaces
736736

737-
The `namespaces` command is used to manage namespaces within Polaris.
737+
The `namespaces` command is used to manage namespaces within Polaris.
738738

739739
`namespaces` supports the following subcommands:
740740

@@ -786,7 +786,7 @@ options:
786786
##### Examples
787787

788788
```
789-
polaris namespaces delete outer_namespace.inner_namespace --catalog my_catalog
789+
polaris namespaces delete outer_namespace.inner_namespace --catalog my_catalog
790790
791791
polaris namespaces delete --catalog my_catalog outer_namespace
792792
```
@@ -1164,7 +1164,7 @@ polaris profiles update dev
11641164

11651165
## Examples
11661166

1167-
This section outlines example code for a few common operations as well as for some more complex ones.
1167+
This section outlines example code for a few common operations as well as for some more complex ones.
11681168

11691169
For especially complex operations, you may wish to instead directly use the Python API.
11701170

site/content/in-dev/unreleased/configuration.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ This page provides information on how to configure Apache Polaris (Incubating).
2828
otherwise, this information is valid both for Polaris Docker images (and Kubernetes deployments) as
2929
well as for Polaris binary distributions.
3030

31-
> Note: for Production tips and best practices, refer to [Configuring Polaris for Production]({{% ref "configuring-polaris-for-production.md" %}}).
31+
> [!NOTE]
32+
> For Production tips and best practices, refer to [Configuring Polaris for Production]({{% ref "configuring-polaris-for-production.md" %}}).
3233
3334
First off, Polaris server runs on Quarkus, and uses its configuration mechanisms. Read Quarkus
3435
[configuration guide](https://quarkus.io/guides/config) to get familiar with the basics.
@@ -48,7 +49,7 @@ The sources are listed below, from highest to lowest priority:
4849
When using environment variables, there are two naming conventions:
4950

5051
1. If possible, just use the property name as the environment variable name. This works fine in most
51-
cases, e.g. in Kubernetes deployments. For example, `polaris.realm-context.realms` can be
52+
cases, e.g. in Kubernetes deployments. For example, `polaris.realm-context.realms` can be
5253
included as is in a container YAML definition:
5354
```yaml
5455
env:
@@ -79,7 +80,7 @@ read-only mode, as Polaris only reads the configuration file once, at startup.
7980

8081
| Configuration Property | Default Value | Description |
8182
|----------------------------------------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
82-
| `polaris.persistence.type` | `relational-jdbc` | Define the persistence backend used by Polaris (`in-memory`, `relational-jdbc`, `eclipse-link` (deprecated)). See [Configuring Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
83+
| `polaris.persistence.type` | `relational-jdbc` | Define the persistence backend used by Polaris (`in-memory`, `relational-jdbc`, `eclipse-link` (deprecated)). See [Configuring Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
8384
| `polaris.persistence.relational.jdbc.max-retries` | `1` | Total number of retries JDBC persistence will attempt on connection resets or serialization failures before giving up. |
8485
| `polaris.persistence.relational.jdbc.max_duaration_in_ms` | `5000 ms` | Max time interval (ms) since the start of a transaction when retries can be attempted. |
8586
| `polaris.persistence.relational.jdbc.initial_delay_in_ms` | `100 ms` | Initial delay before retrying. The delay is doubled after each retry. |
@@ -124,7 +125,7 @@ There are non Polaris configuration properties that can be useful:
124125
|------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------|
125126
| `quarkus.log.level` | `INFO` | Define the root log level. |
126127
| `quarkus.log.category."org.apache.polaris".level` | | Define the log level for a specific category. |
127-
| `quarkus.default-locale` | System locale | Force the use of a specific locale, for instance `en_US`. |
128+
| `quarkus.default-locale` | System locale | Force the use of a specific locale, for instance `en_US`. |
128129
| `quarkus.http.port` | `8181` | Define the HTTP port number. |
129130
| `quarkus.http.auth.basic` | `false` | Enable the HTTP basic authentication. |
130131
| `quarkus.http.limits.max-body-size` | `10240K` | Define the HTTP max body size limit. |
@@ -139,7 +140,8 @@ There are non Polaris configuration properties that can be useful:
139140
| `quarkus.management.root-path` | | Define the root path where `/metrics` and `/health` endpoints are based on. |
140141
| `quarkus.otel.sdk.disabled` | `true` | Enable the OpenTelemetry layer. |
141142

142-
> Note: This section is only relevant for Polaris Docker images and Kubernetes deployments.
143+
> [!NOTE]
144+
> This section is only relevant for Polaris Docker images and Kubernetes deployments.
143145

144146
There are many other actionable environment variables available in the official Polaris Docker
145147
image; they come from the base image used by Polaris, [ubi9/openjdk-21-runtime]. They should be used
@@ -169,8 +171,8 @@ Here are some examples:
169171
| Example | `docker run` option |
170172
|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
171173
| Using another GC | `-e GC_CONTAINER_OPTIONS="-XX:+UseShenandoahGC"` lets Polaris use Shenandoah GC instead of the default parallel GC. |
172-
| Set the Java heap size to a _fixed_ amount | `-e JAVA_OPTS_APPEND="-Xms8g -Xmx8g"` lets Polaris use a Java heap of 8g. |
173-
| Set the maximum heap percentage | `-e JAVA_MAX_MEM_RATIO="70"` lets Polaris use 70% percent of the available memory. |
174+
| Set the Java heap size to a _fixed_ amount | `-e JAVA_OPTS_APPEND="-Xms8g -Xmx8g"` lets Polaris use a Java heap of 8g. |
175+
| Set the maximum heap percentage | `-e JAVA_MAX_MEM_RATIO="70"` lets Polaris use 70% percent of the available memory. |
174176

175177

176178
## Troubleshooting Configuration Issues
@@ -184,5 +186,5 @@ quarkus.log.console.level=DEBUG
184186
quarkus.log.category."io.smallrye.config".level=DEBUG
185187
```
186188

187-
> [!IMPORTANT] This will print out all configuration values, including sensitive ones like
189+
> [!IMPORTANT] This will print out all configuration values, including sensitive ones like
188190
> passwords. Don't do this in production, and don't share this output with anyone you don't trust!

site/content/in-dev/unreleased/configuring-polaris-for-production.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,4 +218,3 @@ Leave out `FILE` to prevent its use. Only include the storage types your setup n
218218

219219
The [Polaris Evolution](../evolution) page discusses backward compatibility and
220220
upgrade concerns.
221-

site/content/in-dev/unreleased/entities.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ For information on managing principal roles with the REST API or for more inform
7272

7373
## Catalog Role
7474

75-
Polaris catalog roles are labels that may be granted to [catalogs](#catalog). Each catalog may have one or more catalog roles, and the same catalog role may be granted to multiple catalogs. Catalog roles may be assigned based on the nature of data that will reside in a catalog, or by the groups of users and services that might need to access that data.
75+
Polaris catalog roles are labels that may be granted to [catalogs](#catalog). Each catalog may have one or more catalog roles, and the same catalog role may be granted to multiple catalogs. Catalog roles may be assigned based on the nature of data that will reside in a catalog, or by the groups of users and services that might need to access that data.
7676

7777
Each catalog role may have multiple [privileges](#privilege) granted to it, and each catalog role can be granted to one or more [principal roles](#principal-role). This is the mechanism by which principals are granted access to entities inside a catalog such as namespaces and tables.
7878

7979
## Policy
8080

81-
Polaris policy is a set of rules governing actions on specified resources under predefined conditions. Polaris support policy for Iceberg table compaction, snapshot expiry, row-level access control, and custom policy definitions.
81+
Polaris policy is a set of rules governing actions on specified resources under predefined conditions. Polaris support policy for Iceberg table compaction, snapshot expiry, row-level access control, and custom policy definitions.
8282

83-
Policy can be applied at catalog level, namespace level, or table level. Policy inheritance can be achieved by attaching one to a higher-level scope, such as namespace or catalog. As a result, tables registered under those entities do not need to be declared individually for the same policy. If a table or a namespace requires a different policy, user can assign a different policy, hence overriding policy of the same type declared at the higher level entities.
83+
Policy can be applied at catalog level, namespace level, or table level. Policy inheritance can be achieved by attaching one to a higher-level scope, such as namespace or catalog. As a result, tables registered under those entities do not need to be declared individually for the same policy. If a table or a namespace requires a different policy, user can assign a different policy, hence overriding policy of the same type declared at the higher level entities.
8484

8585
## Privilege
8686

87-
Polaris privileges are granted to [catalog roles](#catalog-role) in order to grant principals with a given principal role some degree of access to catalogs with a given catalog role. When a privilege is granted to a catalog role, any principal roles granted that catalog role receive the privilege. In turn, any principals who are granted that principal role receive it.
87+
Polaris privileges are granted to [catalog roles](#catalog-role) in order to grant principals with a given principal role some degree of access to catalogs with a given catalog role. When a privilege is granted to a catalog role, any principal roles granted that catalog role receive the privilege. In turn, any principals who are granted that principal role receive it.
8888

8989
A privilege can be scoped to any entity inside a catalog, including the catalog itself.
9090

0 commit comments

Comments
 (0)