Skip to content

Commit a1ddd17

Browse files
authored
Add Elasticsearch audit configuration example to Ranger document
1 parent c2cd15a commit a1ddd17

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

docs/src/main/sphinx/security/ranger-access-control.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ column-masking, row-filtering and audit logging.
88
## Requirements
99

1010
* Access to a Apache Ranger deployment with the desired authorization policies.
11-
* Access to an audit store using Solr, HDFS, Log4J, or S3 to save audit logs.
11+
* Access to an audit store using Solr, HDFS, Log4J, Elasticsearch, or S3 to save audit logs.
1212
* Apache Ranger 2.5.0 and greater include the required Trino service definition.
1313
Earlier versions of Apache Ranger require an [update to the service definition
1414
available on
@@ -134,6 +134,49 @@ The following table lists the configuration properties for the Ranger access con
134134
<value></value>
135135
<description>URL to Solr deployment where the plugin should send access audits to</description>
136136
</property>
137+
138+
<property>
139+
<name>xasecure.audit.destination.elasticsearch</name>
140+
<value>disabled</value>
141+
<description>Is es audit enabled? Allowed values to enable: enable, enabled, true</description>
142+
</property>
143+
144+
<property>
145+
<name>xasecure.audit.destination.elasticsearch.urls</name>
146+
<value>host1,host2</value>
147+
<description>Comma (,) separated list of es hosts.</description>
148+
</property>
149+
150+
<property>
151+
<name>xasecure.audit.destination.elasticsearch.index</name>
152+
<value>ranger_audits_write</value>
153+
<description>The index to write audits to. Default: ranger_audits</description>
154+
</property>
155+
156+
<property>
157+
<name>xasecure.audit.destination.elasticsearch.port</name>
158+
<value>9200</value>
159+
<description>The port for es. Default: 9200</description>
160+
</property>
161+
162+
<property>
163+
<name>xasecure.audit.destination.elasticsearch.protocol</name>
164+
<value>http</value>
165+
<description>The http protocol to use during communication. Default: http</description>
166+
</property>
167+
168+
<property>
169+
<name>xasecure.audit.destination.elasticsearch.user</name>
170+
<value>write_user</value>
171+
<description>The username to authenticate towards es.</description>
172+
</property>
173+
174+
<property>
175+
<name>xasecure.audit.destination.elasticsearch.password</name>
176+
<value>changeme</value>
177+
<description>The password to authenticate towards es.</description>
178+
</property>
179+
137180
</configuration>
138181
```
139182

0 commit comments

Comments
 (0)