Skip to content

Fix admin tool doc #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 28, 2025
Merged

Fix admin tool doc #1977

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f68748d
Fix admin tool doc
MonkeyCanCode Jun 28, 2025
97b6608
Fix admin tool doc
MonkeyCanCode Jun 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions site/content/in-dev/unreleased/admin-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ example, to build the tool with support for Postgres, run the following:

The above command will generate:

- One standalone JAR in `runtime/admin/build/polaris-admin-*-runner.jar`
- Two distribution archives in `runtime/admin/build/distributions`
- One Fast-JAR in `runtime/admin/build/quarkus-app/quarkus-run.jar`
- Two Docker images named `apache/polaris-admin-tool:latest` and `apache/polaris-admin-tool:<version>`

## Usage
Expand All @@ -46,7 +45,7 @@ Please make sure the admin tool and Polaris server are with the same version bef
To run the standalone JAR, use the following command:

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar --help
java -jar runtime/admin/build/quarkus-app/quarkus-run.jar --help
```

To run the Docker image, use the following command:
Expand Down Expand Up @@ -89,7 +88,7 @@ issues. If a realm is already bootstrapped, running the `bootstrap` command agai
effect on that realm.

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar bootstrap --help
java -jar runtime/admin/build/quarkus-app/quarkus-run.jar bootstrap --help
```

The basic usage of the `bootstrap` command is outlined below:
Expand All @@ -110,7 +109,7 @@ For example, to bootstrap the `realm1` realm and create its root principal crede
client ID `admin` and client secret `admin`, you can run the following command:

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar bootstrap -r realm1 -c realm1,admin,admin
java -jar runtime/admin/build/quarkus-app/quarkus-run.jar bootstrap -r realm1 -c realm1,admin,admin
```

## Purging Realms and Principal Credentials
Expand All @@ -123,7 +122,7 @@ The `purge` command is used to remove realms and principal credentials from the
credentials, grants, and any other data associated with the realms.

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar purge --help
java -jar runtime/admin/build/quarkus-app/quarkus-run.jar purge --help
```

The basic usage of the `purge` command is outlined below:
Expand All @@ -139,5 +138,5 @@ Purge realms and all associated entities.
For example, to purge the `realm1` realm, you can run the following command:

```shell
java -jar runtime/admin/build/polaris-admin-*-runner.jar purge -r realm1
java -jar runtime/admin/build/quarkus-app/quarkus-run.jar purge -r realm1
```
Loading