Skip to content

RANGER-5679: Document OpenSearch audit setup in docker README and per…#1057

Open
paras200 wants to merge 1 commit into
apache:masterfrom
paras200:RANGER-5679
Open

RANGER-5679: Document OpenSearch audit setup in docker README and per…#1057
paras200 wants to merge 1 commit into
apache:masterfrom
paras200:RANGER-5679

Conversation

@paras200

@paras200 paras200 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

RANGER-5679: Document the OpenSearch audit setup in the dev-support/ranger-docker README and decouple Solr from the core compose stack.

Docker-compose and docs only; no runtime/product code changes.

How was this patch tested?

Manual test from a fresh clone using dev-support/ranger-docker, and docker compose ... config validation of every documented flow (core stack, hive, hbase, ozone, trino, solr, opensearch, OpenSearch audit flow, all-containers, rebuild, audit-server stack, and each individual dispatcher) — all resolve cleanly, and the OpenSearch flow no longer references an undefined ranger-solr service.

mvn clean package -DskipTests -pl distro -am
cp target/ranger-* dev-support/ranger-docker/dist/
export RANGER_DB_TYPE=postgres
./download-archives.sh kafka opensearch hadoop
# OpenSearch audit compose stack (see README)

Verified:

  • OpenSearch ranger_audits/_count → 3 documents
  • Ranger Admin GET /service/assets/accessAudit?pageSize=10 → same 3 audits from OpenSearch

Note: Kafka topic authz can race on first startup; restarting ranger-audit-dispatcher-opensearch after ~1 min may be needed (existing docker stack behavior).

@paras200
paras200 force-pushed the RANGER-5679 branch 4 times, most recently from 3128bf5 to aeae793 Compare July 10, 2026 10:21

@mneethiraj mneethiraj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paras200 - docker-compose.ranger.yml starts ranger-solr implicitly. With Opensearch as the audit destination, bringing up Solr is unnecessary. I suggest removing references to ranger-solr from docker-compose.ranger.yml and have Solr started explicitly similar to from docker-compose.ranger-opensearch.yml

Comment thread dev-support/ranger-docker/README.md Outdated
# export ENABLE_FILE_SYNC_SOURCE=true

# valid values for RANGER_DB_TYPE: mysql/postgres/oracle
# valid values for RANGER_DB_TYPE: mysql/postgres/oracle/sqlserver

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sqlserver is no more supported. Please revert the change in line 82.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mneethiraj , Done

Also, The pull request is currently in Draft mode, I still need to test everything locally again to mark it as ready for review.

@paras200
paras200 force-pushed the RANGER-5679 branch 2 times, most recently from ccc2e07 to 0a27ef1 Compare July 11, 2026 10:47
@paras200
paras200 force-pushed the RANGER-5679 branch 2 times, most recently from 165f5c7 to b0a901e Compare July 21, 2026 15:31
…ouple Solr

- Expand the docker README OpenSearch audit flow: postgres works out of the box (no install.properties edits); document bringing up the ingestor/dispatcher stack and the OpenSearch audit dispatcher one-liner
- Append a commented native OpenSearch audit block (audit_store=opensearch + audit_opensearch_*) to mysql and oracle install.properties so the README's 'enable the OpenSearch block' step is actionable; Solr and Elasticsearch lines are left unchanged
- Revert the sqlserver install.properties change: sqlserver is no longer a supported RANGER_DB_TYPE, so it gets no OpenSearch block and the README OpenSearch note lists only mysql/oracle
- Decouple Solr from the core stack: move the ranger-solr service into its own docker-compose.ranger-solr.yml and drop it (and the ranger-admin depends_on) from docker-compose.ranger.yml, matching the OpenSearch pattern so Solr is only started when explicitly requested
- Add a 'Bring up solr container' section and pass -f docker-compose.ranger-solr.yml to every Solr-dependent command (core stack, ozone, all-containers, rebuild, audit-server stack, Solr dispatcher)
- Point the OpenSearch audit flow at the standalone docker-compose.ranger-audit-ingestor.yml instead of docker-compose.ranger-audit-server.yml, which bundles the Solr dispatcher; this avoids a 'depends on undefined service ranger-solr' compose error now that ranger-solr is not in ranger.yml, keeping the OpenSearch path Solr-free

Docs and docker-compose only; no runtime code changes.
@paras200
paras200 marked this pull request as ready for review July 22, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants