[
https://issues.apache.org/jira/browse/KNOX-3545?focusedWorklogId=1054267&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1054267
]
ASF GitHub Bot logged work on KNOX-3545:
----------------------------------------
Author: ASF GitHub Bot
Created on: 12/Nov/26 13:19
Start Date: 12/Nov/26 13:19
Worklog Time Spent: 10m
Work Description: DiyaMariaAbraham opened a new pull request, #1509:
URL: https://github.com/apache/knox/pull/1509
[KNOX-1234](https://issues.apache.org/jira/browse/KNOX-3545) - Add Knox
gateway support for the OpenSearch Dashboards web UI (service definition, URL
rewrite rules, CM discovery, homepage tile).
## What changes were proposed in this pull request?
This change lets Knox proxy the OpenSearch Dashboards browser UI through a
topology service, with SSO and URL rewriting for Dashboards’ fixed backend base
path.
- **Service definition (`opensearch-dashboards/3.6.0`)**
- New UI service role `OPENSEARCH-DASHBOARDS` with context
`/opensearch-dashboards`.
- `ConfigurableDispatch` with two-way SSL to the backend, injecting the
Knox-authenticated principal as `x-proxy-user` (for OpenSearch Dashboards proxy
auth).
- Inbound rewrite rules strip the gateway prefix before forwarding;
outbound rules rewrite `/opensearch-dashboards-ui` (Dashboards
`server.basePath` when `rewriteBasePath=false`) back to the Knox context in
response bodies, `Location` headers, and related assets.
- **Cloudera Manager service discovery**
- `OpenSearchDashboardsServiceModelGenerator`: maps CM `OPENSEARCH` /
`OPENSEARCH_DASHBOARD` to Knox `OPENSEARCH-DASHBOARDS`, using
`dashboards_server_port` for the backend URL
- Discovery only includes the role when `enable_dashboards_sso=true`
(missing or false is treated as a configuration issue).
- **Knox homepage**
- Added `knox-homepage-ui` service logo `opensearch-dashboards.png` and
metadata description for the Dashboards UI tile.
## How was this patch tested?
- Added unit tests
## Integration Tests
No integration tests were added.
### Opt-in test suites (PR labels)
Some integration suites are expensive and are **not** run on every PR. Add
the corresponding label to this PR to run them:
| Label | Runs |
|-------|------|
| `test-federation` | KnoxIDF federation E2E (`test_knoxidf_federation.py`).
Stands up a real Keycloak as an external OpenID Provider and drives the full
broker flow. Adds a few minutes (image pull + realm import). |
| `skip-tests` | Skips the entire Docker Compose test job. |
**When to add the label:** these labels only take effect on runs triggered
by opening the PR, pushing a commit, or reopening the PR — the workflow does
not run on a label change. Add the label **before opening the PR** (or before
your next push). Adding it after the checks have already finished will **not**
start a new run; push a commit or close/reopen the PR to trigger one with the
label applied.
## UI changes
- New Knox **homepage** tile logo for OpenSearch Dashboards.
<img width="1723" height="767" alt="image"
src="https://github.com/user-attachments/assets/d5d80d4f-a118-45f5-ab59-2125c294dae3"
/>
Please review [Knox Contributing
Process](https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process#ContributionProcess-GithubWorkflow)
before opening a pull request.
Issue Time Tracking
-------------------
Worklog Id: (was: 1054267)
Remaining Estimate: 0h
Time Spent: 10m
> Integrate Opensearch Dashboards with Knox SSO
> ---------------------------------------------
>
> Key: KNOX-3545
> URL: https://issues.apache.org/jira/browse/KNOX-3545
> Project: Apache Knox
> Issue Type: Improvement
> Components: KnoxSSO
> Affects Versions: 3.1.0
> Reporter: Diya Maria Abraham
> Priority: Major
> Time Spent: 10m
> Remaining Estimate: 0h
>
> OpenSearch is a popular community-driven, Apache 2.0-licensed open source,
> enterprise-grade search, analytics and observability suite. This ticket
> covers the effort to integrate opensearch dashboards with knox to provide
> proxy support for the UI.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)