Introducing Apache Polaris Console #85

jbonofre · 2025-11-30T17:48:41Z

This PR is proposing the Apache Polaris Console, an UI to browse and manage Polaris server and entities.

A huge thanks to the Console contributors: @sohanhonavar and @binarycat0

- Migrate build system to Vite with TypeScript and Tailwind CSS - Reorganize codebase into modular structure (pages/, components/, api/, hooks/, lib/, types/) - Replace legacy components with modern React patterns using Radix UI, TanStack Query, and React Router - Update dependencies and add comprehensive UI component library - Remove deprecated files and consolidate routing and state management

- Update errorHandler to check response.data.error.message first - Use getErrorMessage in Connections page for better error handling - Add missing toast import in GrantCatalogRoleModal

- Remove unused functions, imports, and parameters across codebase - Clean up unused error state in PrincipalsTab - Remove unused type imports

Allow users to configure the realm header name through VITE_POLARIS_REALM_HEADER_NAME environment variable, defaulting to Polaris-Realm. This enables compatibility with custom Polaris server configurations where the realm header name differs from the default.

Change primary color to teal (#01656f) and update all components to use theme colors instead of hardcoded values. Simplify header dropdown menu by removing repetitive user information and keeping only logout action.

…or best practices Implement drag-to-resize functionality for catalog explorer sidebar with width persistence. Extract resize logic into reusable custom hook and move width constants to shared constants file. Refactor component to use proper hooks, memoization, and improved type safety.

Centralize catalog node prefix constant by moving it from component to shared constants file for better maintainability and reusability across the codebase.

jbonofre · 2025-11-30T18:07:21Z

You can see the current console in action here:

https://drive.google.com/file/d/1crPlUyQQPtEAZPO37for7SQvp4NwR_Pj/view?usp=sharing

flyrain

Thanks for working on it! Looks amazing!

flyrain · 2025-11-30T21:19:18Z

console/src/api/auth.ts

+// Always use relative URL to go through the proxy (dev server or production server)
+// This avoids CORS issues by proxying requests through the server
+// The server.ts proxy handles /api routes in production, and Vite handles them in development
+const TOKEN_URL = "/api/catalog/v1/oauth/tokens"


Can we have a configurable token url for 3-rd party IDPs or different remote Polaris instance? Not a blocker. I'm fine with filing an issue and resolving it later.

@flyrain i have implemented 3 rd party IDPs support in here https://github.com/jbonofre/polaris-tools/tree/keycloak-support i need some help me with testing this one

Yes we have a WiP about that. I will work on it as well.

flyrain · 2025-11-30T21:22:15Z

console/src/api/auth.ts

+    formData.append("grant_type", "client_credentials")
+    formData.append("client_id", clientId)
+    formData.append("client_secret", clientSecret)
+    formData.append("scope", "PRINCIPAL_ROLE:ALL")


I think the scope should be the part of the configuration along with client id and secret. We can provide a default value, but avoid hardcoding it.

Good point. Let's do that.

flyrain · 2025-11-30T21:51:20Z

console/src/api/auth.ts

+  },
+
+  logout: (): void => {
+    localStorage.removeItem("polaris_access_token")


Storing tokens in localStorage has security implications.
Because localStorage is readable by any JavaScript running on the page, an XSS vulnerability would allow an attacker to extract the access token.

Not a blocker for an internal/admin console, but we should at least track this as a follow-up improvement (e.g., memory-only tokens).

I don't think it's a blocker as it's browser side. However I agree that it would be a nice improvement using browser in memory.

Can we file an issue for this? Thanks!

flyrain · 2025-11-30T21:52:15Z

console/public/polaris-logo-star.svg

+  <!-- Teal background -->
+  <rect width="32" height="32" fill="#0F766E"/>
+  <!-- White four-pointed star -->
+  <path d="M16 4L19.5 12.5L28 16L19.5 19.5L16 28L12.5 19.5L4 16L12.5 12.5L16 4Z" fill="white"/>


Can we use the one in the main repo to be consistent?

Agree. Let me do that.

MonkeyCanCode · 2025-12-01T02:24:06Z

console/docker/Dockerfile

+# under the License.
+
+# Build stage
+FROM node:20-alpine AS builder


Does it makes sense to use UBI images as well here as that is what we are using for polaris images. In this case, we will be looking at the following:

node: https://catalog.redhat.com/en/software/containers/ubi9/nodejs-20-minimal/64770ddd0e699534bb564b3b

nginx: https://catalog.redhat.com/en/software/containers/ubi9/nginx-126/678f5851a09b9e2d461ba1d9

MonkeyCanCode · 2025-12-01T02:34:58Z

console/src/api/auth.ts

+    realm?: string
+  ): Promise<OAuthTokenResponse> => {
+    const formData = new URLSearchParams()
+    formData.append("grant_type", "client_credentials")


I would suggest the same for grant_type as what @flyrain points out. There are 2 allowed values for it: https://github.com/apache/polaris/blob/ab421e0f1330d1c95eb9a4f07f9bfab10c7f7e2e/runtime/service/src/main/java/org/apache/polaris/service/auth/internal/broker/TokenRequestValidator.java#L32

MonkeyCanCode · 2025-12-01T02:39:38Z

console/src/api/catalog/namespaces.ts

+      params.parent = encodeNamespace(parent)
+    }
+
+    const response = await apiClient


NIT: should we consider for adding support for pageSize as if an user create high number of namespace, the UI loading will taking extremely long of time.

MonkeyCanCode · 2025-12-01T02:44:19Z

console/README.md

+Then, you run Polaris Console using:
+
+```
+docker run -p 8080:80 apache/polaris-console:latest


Does it makes sense to add a docker compose so people can easily try out? As the console and server are running in diff networks, we will need to either bridge it from local or put them in a virtual network with docker network.

I'm trying to cover this by introducing Helm chart that will help to deploy Console into the same namespace and network as the main Apache Polaris instance.

delivered here 358425d

added how-to into the readme

console/Dockerfile

adam-christian-software · 2025-12-01T20:15:01Z

console/spec/bundled-polaris-catalog-service.yaml

+# specific language governing permissions and limitations
+# under the License.
+
+openapi: 3.0.3


I think that a copy & paste is fine for now, but eventually, I'd expect that we would have some way of pulling in the Polaris APIs from the Polaris instance.
Same with the polaris-management-service spec as well.

Do you have an idea on how we want to do that? It's OK if not. We can just file a Git issue.

adam-christian-software · 2025-12-01T20:17:27Z

console/package.json

+  "private": true,
+  "version": "1.3.0-incubating",
+  "type": "module",
+  "scripts": {


I'm not seeing any unit tests or any way to test this yet. Can we file a Git issue, so we can handle this after merge?

yes definetly lets create a Git to track this, will work on them, starting next week

I propose to wait the PR merged before creating the corresponding issues as it can look weird for contributors if they don't find the actual code 😄

I will create all issues after this PR.

Sounds good! I just want to ensure they are tracked. Thanks, @sohanhonavar & @jbonofre, y'all can close this comment when you track it on your side. :)

adam-christian-software · 2025-12-01T20:31:26Z

console/src/api/client.ts

+    }
+
+    // Response interceptor for error handling
+    const responseErrorInterceptor = (error: unknown) => {


Should we have a way to do a retry for transient failures?

console/README.md

binarycat0 · 2025-12-02T18:37:48Z

Great job, everything works fine for me as local DEV, except the known issues with Dockerfile.

I was trying to fix Dockerfile issues and introduce a helm chart for unblocking a possibility to build and deploy Console UI into existing K8S namespace and connect to Polaris API.

This PR can be merged and delivered with this PR together - jbonofre#2

cc: @jbonofre @sohanhonavar

binarycat0

I double-checked the current version, and it works for me well.
I followed the readme instruction that added in this PR - https://github.com/jbonofre/polaris-tools/tree/ui/console#k8s-deployment-with-helm

dependencies installed from scratch
docker images builds
helm chart with console deploys well
Console UI connects to existing polaris POD
Authentication works and UI is functional

This is a great achievement and can unblock those who interested in this project and UI experience.
I believe that all the mentioned improvements like "External IDP AuthN" can be delivered in parallel in the follow-up PRs.

dimas-b

I tested the UI locally and it worked fine and looked great :) I do not have much to say about the code itself as I'm not familiar with the framework.

MonkeyCanCode · 2025-12-07T23:05:41Z

Local testing works now with latest commit and I am able to integrated it with Polaris server in helm as well. There are couple files missed license headers. Other than this, same as @dimas-b , I am not very familiar with the framework as well.

jbonofre and others added 30 commits November 27, 2025 11:14

Bootstrap Polaris Console

b01c85d

Quick fix on naming

04ae7b5

fix: prioritize HTTP response error messages over axios error messages

875bd89

- Update errorHandler to check response.data.error.message first - Use getErrorMessage in Connections page for better error handling - Add missing toast import in GrantCatalogRoleModal

chore: remove unused imports and variables

bf4aa86

- Remove unused functions, imports, and parameters across codebase - Clean up unused error state in PrincipalsTab - Remove unused type imports

fix: move React hooks before early returns to comply with rules of hooks

c7c21f6

fix: resolve TypeScript type errors

ed34221

chore: suppress Fast Refresh warnings for valid export patterns

197f439

fix: remove unnecessary escape character in regex pattern

c690350

fixed few minor changes

f8ba2f6

fixed few minor changes & type changes

f39538b

fix the url for cors issues

450bb4b

Add start script

d5ad26a

Cleanup

596bf8a

Change local storage location

f5b254e

Added an input to take Relam as input from user

870e53a

Added an input to take Relam as input from user

18299c7

Adding header.

ddf3a41

Add TODO for JB

2a7c6b6

Update theme colors to teal primary and simplify header dropdown

20a115c

Change primary color to teal (#01656f) and update all components to use theme colors instead of hardcoded values. Simplify header dropdown menu by removing repetitive user information and keeping only logout action.

Move catalog node prefix constant to shared constants file

a186100

Centralize catalog node prefix constant by moving it from component to shared constants file for better maintainability and reusability across the codebase.

Add legal skeleton (before complete pass)

f7483d6

Remove vite icon in favor of polaris

91c3436

Cleanup react icon

ff10935

Fix package.json (dual scripts definition)

e4d8f7b

Update README.md with correct instructions

e06e66d

Add legal footer

6b494f4

Update Console title

36f5f66

jbonofre added 6 commits November 29, 2025 14:31

Use the right naming

5a10865

Change default service name for consistency.

c6fc878

Add child namespaces card in namespace details

9eee530

Add Generic Tables card in the namespace details

e6682b7

Add Generic Table action

c283a40

Add Docker image with LICENSE-BUNDLE

9df2d26

flyrain reviewed Nov 30, 2025

View reviewed changes

MonkeyCanCode reviewed Dec 1, 2025

View reviewed changes

console/Dockerfile Outdated Show resolved Hide resolved

console/Dockerfile Outdated Show resolved Hide resolved

adam-christian-software reviewed Dec 1, 2025

View reviewed changes

dimas-b reviewed Dec 1, 2025

View reviewed changes

console/README.md Outdated Show resolved Hide resolved

binarycat0 and others added 7 commits December 2, 2025 14:23

chore(feature): init helm chart

4f9c422

chore(feature): fix readme

207b0c6

Update node version in the README.md

a159aa4

chore(feature): fix readme

5ef9af3

chore(feature): introduce runtime configuration

9e2367d

chore(feature): reorganize docker experience

cc50b3b

chore(feature): update the readme

3307198

Merge pull request #2 from jbonofre/ui-init-helm-chart

358425d

binarycat0 approved these changes Dec 3, 2025

View reviewed changes

dimas-b approved these changes Dec 3, 2025

View reviewed changes

MonkeyCanCode approved these changes Dec 7, 2025

View reviewed changes

Introducing Apache Polaris Console #85

Are you sure you want to change the base?

Introducing Apache Polaris Console #85

Conversation

jbonofre commented Nov 30, 2025

Uh oh!

jbonofre commented Nov 30, 2025

Uh oh!

flyrain left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sohanhonavar Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

binarycat0 commented Dec 2, 2025

Uh oh!

binarycat0 left a comment

Choose a reason for hiding this comment

Uh oh!

dimas-b left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MonkeyCanCode commented Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

sohanhonavar Dec 1, 2025 •

edited

Loading

dimas-b left a comment •

edited

Loading