Skip to content

Commit 350fadc

Browse files
committed
Merge branch 'develop' into RORDEV-1444-user-info-source-methods-description
2 parents fa2d3d1 + 0b987a2 commit 350fadc

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

eck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ ARG ROR_VERSION
169169
USER elasticsearch
170170
RUN /usr/share/elasticsearch/bin/elasticsearch-plugin install --batch "https://api.beshu.tech/download/es?esVersion=$ES_VERSION&pluginVersion=$ROR_VERSION&email=[YOUR-EMAIL-ADDRESS]"
171171
USER root
172-
RUN /usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch
172+
RUN /usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch --I_UNDERSTAND_AND_ACCEPT_ES_PATCHING yes
173173
USER 1000:0
174174
```
175175

elasticsearch.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ If you are using Elasticsearch 6.5.x or newer, you need **an extra post-installa
137137
jdk/bin/java -jar plugins/readonlyrest/ror-tools.jar patch
138138
```
139139

140+
**⚠️IMPORTANT**: During patching, user will be prompted for confirmation. Please see the [silent mode](elasticsearch.md#patch-elasticsearch-in-a-silent-mode) is there is a need to bypass this step.
141+
140142
**⚠️IMPORTANT**: for Elasticsearch 8.3.x or newer, the patching operation requires `root` user privileges.
141143

142144
You can verify if Elasticsearch was correctly patched using the command `verify`:
@@ -286,7 +288,18 @@ If you are using Elasticsearch 6.5.x or newer, you need **an extra post-installa
286288
jdk/bin/java -jar plugins/readonlyrest/ror-tools.jar patch
287289
```
288290

289-
**⚠️IMPORTANT**: for Elasticsearch 8.3.x or newer, the patching operation requires `root` user privileges.
291+
**⚠️IMPORTANT**: When performing the patching operation, user will be asked to confirm (by providing an answer 'yes' to the displayed question),
292+
that he understands and accepts the implications of ES patching. See the [silent mode](elasticsearch.md#patch-elasticsearch-in-a-silent-mode) if there is a need to bypass this step.
293+
294+
**⚠️IMPORTANT**: For Elasticsearch 8.3.x or newer, the patching operation requires `root` user privileges.
295+
296+
##### Patch Elasticsearch in a silent mode
297+
To apply patches in ES using ror-tools in non-interactive mode (bypassing prompts),
298+
you can provide `--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes` script argument :
299+
300+
```bash
301+
jdk/bin/java -jar plugins/readonlyrest/ror-tools.jar patch --I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes
302+
```
290303

291304
You can verify if Elasticsearch was correctly patched using the command `verify`:
292305

kibana.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,19 @@ readonlyrest_kbn.multiTenancyEnabled: false
542542

543543
You can configure an ACL in multi tenancy mode by adding a few ACL blocks containing the `kibana.index` [rule](https://docs.readonlyrest.com/elasticsearch#kibana). See examples and further explanation under our [multi-tenancy guide](examples/multitenancy\_guide.md).
544544

545+
### Extending the Kibana API with the x-ror-tenancy-id header
546+
([Enterprise](https://readonlyrest.com/enterprise))
547+
548+
To target a specific tenant when making a [Kibana API](https://www.elastic.co/guide/en/kibana/current/api.html) request, include the custom HTTP header `x-ror-tenancy-id`. The value of this header should match one of the [groups rules](/elasticsearch#groups-rules) id defined in your ACL configuration. The first group defined in the ACL for a specific user is used as the default tenancy id.
549+
550+
example usage:
551+
552+
```bash
553+
curl -X GET "http://localhost:5601/api/saved_objects/_find?type=dashboard" \
554+
-H "kbn-xsrf: true" \
555+
-H "x-ror-tenancy-id: marketing-team"
556+
```
557+
545558
#### Session cookie expiration
546559

547560
When a user logs in, ReadonlyREST will write an encrypted cookie in the browser. This cookie has an time to live that can be tweaked with the following configuration key in `kibana.yml`.

0 commit comments

Comments
 (0)